run.py 9.07 KB
Newer Older
Antoine Kaufmann's avatar
Antoine Kaufmann committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Copyright 2021 Max Planck Institute for Software Systems, and
# National University of Singapore
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

23
import argparse
Jonas Kaufmann's avatar
Jonas Kaufmann committed
24
import fnmatch
25
import importlib
Hejing Li's avatar
Hejing Li committed
26
import importlib.util
27
import json
Jonas Kaufmann's avatar
Jonas Kaufmann committed
28
import os
29
import pickle
Jonas Kaufmann's avatar
Jonas Kaufmann committed
30
import sys
31
32
import typing as tp

Jonas Kaufmann's avatar
Jonas Kaufmann committed
33
import simbricks.exectools as exectools
Jonas Kaufmann's avatar
Jonas Kaufmann committed
34
35
36
37
from simbricks.runtime.common import *
from simbricks.runtime.distributed import *
from simbricks.runtime.local import *
from simbricks.runtime.slurm import *
Jonas Kaufmann's avatar
Jonas Kaufmann committed
38

39
import simbricks.experiments as exp
40

Jonas Kaufmann's avatar
Jonas Kaufmann committed
41

42
43
44
45
def mkdir_if_not_exists(path):
    if not os.path.exists(path):
        os.mkdir(path)

46

47
parser = argparse.ArgumentParser()
Jonas Kaufmann's avatar
Jonas Kaufmann committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
parser.add_argument(
    'experiments',
    metavar='EXP',
    type=str,
    nargs='+',
    help='An experiment file to run'
)
parser.add_argument(
    '--list',
    action='store_const',
    const=True,
    default=False,
    help='Only list available experiment names'
)
parser.add_argument(
    '--filter',
    metavar='PATTERN',
    type=str,
    nargs='+',
    help='Pattern to match experiment names against'
)
parser.add_argument(
    '--pickled',
    action='store_const',
    const=True,
    default=False,
    help='Read exp files as pickled runs instead of exp.py files'
)
parser.add_argument(
    '--runs',
    metavar='N',
    type=int,
    default=1,
    help='Number of repetition for each experiment'
)
parser.add_argument(
    '--firstrun', metavar='N', type=int, default=1, help='ID for first run'
)
parser.add_argument(
    '--force',
    action='store_const',
    const=True,
    default=False,
    help='Run experiments even if output already exists'
)
parser.add_argument(
    '--verbose',
    action='store_const',
    const=True,
    default=False,
    help='Verbose output'
)
parser.add_argument(
    '--pcap',
    action='store_const',
    const=True,
    default=False,
    help='Dump pcap file (if supported by simulator)'
)
107
108

g_env = parser.add_argument_group('Environment')
Jonas Kaufmann's avatar
Jonas Kaufmann committed
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
g_env.add_argument(
    '--repo', metavar='DIR', type=str, default='..', help='Repo directory'
)
g_env.add_argument(
    '--workdir',
    metavar='DIR',
    type=str,
    default='./out/',
    help='Work directory base'
)
g_env.add_argument(
    '--outdir',
    metavar='DIR',
    type=str,
    default='./out/',
    help='Output directory base'
)
g_env.add_argument(
    '--cpdir',
    metavar='DIR',
    type=str,
    default='./out/',
    help='Checkpoint directory base'
)
g_env.add_argument(
    '--hosts',
    metavar='JSON_FILE',
    type=str,
    default=None,
    help='List of hosts to use (json)'
)
g_env.add_argument(
    '--shmdir',
    metavar='DIR',
    type=str,
    default=None,
    help='Shared memory directory base (workdir if not set)'
)
147

148
g_par = parser.add_argument_group('Parallel Runtime')
Jonas Kaufmann's avatar
Jonas Kaufmann committed
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
g_par.add_argument(
    '--parallel',
    dest='runtime',
    action='store_const',
    const='parallel',
    default='sequential',
    help='Use parallel instead of sequential runtime'
)
g_par.add_argument(
    '--cores',
    metavar='N',
    type=int,
    default=len(os.sched_getaffinity(0)),
    help='Number of cores to use for parallel runs'
)
g_par.add_argument(
    '--mem',
    metavar='N',
    type=int,
    default=None,
    help='Memory limit for parallel runs (in MB)'
)
171

172
g_slurm = parser.add_argument_group('Slurm Runtime')
Jonas Kaufmann's avatar
Jonas Kaufmann committed
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
g_slurm.add_argument(
    '--slurm',
    dest='runtime',
    action='store_const',
    const='slurm',
    default='sequential',
    help='Use slurm instead of sequential runtime'
)
g_slurm.add_argument(
    '--slurmdir',
    metavar='DIR',
    type=str,
    default='./slurm/',
    help='Slurm communication directory'
)
188

189
g_dist = parser.add_argument_group('Distributed Runtime')
Jonas Kaufmann's avatar
Jonas Kaufmann committed
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
g_dist.add_argument(
    '--dist',
    dest='runtime',
    action='store_const',
    const='dist',
    default='sequential',
    help='Use sequential distributed runtime instead of local'
)
g_dist.add_argument(
    '--auto-dist',
    action='store_const',
    const=True,
    default=False,
    help='Automatically distribute non-distributed experiments'
)
g_dist.add_argument(
    '--proxy-type',
    metavar='TYPE',
    type=str,
    default='sockets',
    help='Proxy type to use (sockets,rdma) for auto distribution'
)
212
args = parser.parse_args()
213

214
215

def load_executors(path):
Jonas Kaufmann's avatar
Jonas Kaufmann committed
216
    """Load hosts list from json file and return list of executors."""
217
218
219
220
221
222
    with open(path, 'r') as f:
        hosts = json.load(f)

        exs = []
        for h in hosts:
            if h['type'] == 'local':
223
                ex = exectools.LocalExecutor()
224
            elif h['type'] == 'remote':
225
                ex = exectools.RemoteExecutor(h['host'], h['workdir'])
226
227
228
229
                if 'ssh_args' in h:
                    ex.ssh_extra_args += h['ssh_args']
                if 'scp_args' in h:
                    ex.scp_extra_args += h['scp_args']
230
231
            else:
                raise RuntimeError('invalid host type "' + h['type'] + '"')
232
233
            ex.ip = h['ip']
            exs.append(ex)
234
235
    return exs

Jonas Kaufmann's avatar
Jonas Kaufmann committed
236

237
238
239
240
241
if args.hosts is None:
    executors = [exectools.LocalExecutor()]
else:
    executors = load_executors(args.hosts)

Jonas Kaufmann's avatar
Jonas Kaufmann committed
242

243
244
def warn_multi_exec():
    if len(executors) > 1:
Jonas Kaufmann's avatar
Jonas Kaufmann committed
245
246
247
248
249
        print(
            'Warning: multiple hosts specified, only using first one for now',
            file=sys.stderr
        )

250

251
# initialize runtime
252
if args.runtime == 'parallel':
253
    warn_multi_exec()
Jonas Kaufmann's avatar
Jonas Kaufmann committed
254
255
256
    rt = LocalParallelRuntime(
        cores=args.cores, mem=args.mem, verbose=args.verbose, exec=executors[0]
    )
257
elif args.runtime == 'slurm':
Jonas Kaufmann's avatar
Jonas Kaufmann committed
258
    rt = SlurmRuntime(args.slurmdir, args, verbose=args.verbose)
259
elif args.runtime == 'dist':
Jonas Kaufmann's avatar
Jonas Kaufmann committed
260
    rt = DistributedSimpleRuntime(executors, verbose=args.verbose)
261
else:
262
    warn_multi_exec()
Jonas Kaufmann's avatar
Jonas Kaufmann committed
263
    rt = LocalSimpleRuntime(verbose=args.verbose, exec=executors[0])
264

265
266

def add_exp(
Jonas Kaufmann's avatar
Jonas Kaufmann committed
267
268
269
270
271
272
    e: exp.Experiment,
    run: int,
    prereq: tp.Optional[Run],
    create_cp: bool,
    restore_cp: bool,
    no_simbricks: bool
273
):
274
    outpath = '%s/%s-%d.json' % (args.outdir, e.name, run)
275
    if os.path.exists(outpath) and not args.force:
276
277
278
279
        print('skip %s run %d' % (e.name, run))
        return None

    workdir = '%s/%s/%d' % (args.workdir, e.name, run)
280
    cpdir = '%s/%s/%d' % (args.cpdir, e.name, 0)
281
282
    if args.shmdir is not None:
        shmdir = '%s/%s/%d' % (args.shmdir, e.name, run)
283

284
    env = exp.ExpEnv(args.repo, workdir, cpdir)
285
286
    env.create_cp = create_cp
    env.restore_cp = restore_cp
Jonas Kaufmann's avatar
Jonas Kaufmann committed
287
    env.no_simbricks = no_simbricks
288
289
    env.pcap_file = ''
    if args.pcap:
Jonas Kaufmann's avatar
Jonas Kaufmann committed
290
        env.pcap_file = workdir + '/pcap'
291
292
    if args.shmdir is not None:
        env.shm_base = os.path.abspath(shmdir)
293

Jonas Kaufmann's avatar
Jonas Kaufmann committed
294
    run = Run(e, run, env, outpath, prereq)
295
296
297
    rt.add_run(run)
    return run

Jonas Kaufmann's avatar
Jonas Kaufmann committed
298

299
300
301
302
303
304
305
306
307
308
309
# load experiments
if not args.pickled:
    # default: load python modules with experiments
    experiments = []
    for path in args.experiments:
        modname, _ = os.path.splitext(os.path.basename(path))

        spec = importlib.util.spec_from_file_location(modname, path)
        mod = importlib.util.module_from_spec(spec)
        spec.loader.exec_module(mod)
        experiments += mod.experiments
310

311
312
313
314
315
    if args.list:
        for e in experiments:
            print(e.name)
        sys.exit(0)

316
    for e in experiments:
317
        if args.auto_dist and not isinstance(e, exp.DistributedExperiment):
Jonas Kaufmann's avatar
Jonas Kaufmann committed
318
            e = auto_dist(e, executors, args.proxy_type)
319
        # apply filter if any specified
320
        if (args.filter) and (len(args.filter) > 0):
321
322
323
324
325
326
327
328
            match = False
            for f in args.filter:
                if fnmatch.fnmatch(e.name, f):
                    match = True
                    break
            if not match:
                continue

329
        # if this is an experiment with a checkpoint we might have to create it
330
        if e.no_simbricks:
Jonas Kaufmann's avatar
Jonas Kaufmann committed
331
            no_simbricks = True
332
        else:
Jonas Kaufmann's avatar
Jonas Kaufmann committed
333
            no_simbricks = False
334
        if e.checkpoint:
335
            prereq = add_exp(e, 0, None, True, False, no_simbricks)
336
337
        else:
            prereq = None
338

339
        for run in range(args.firstrun, args.firstrun + args.runs):
340
            add_exp(e, run, prereq, False, e.checkpoint, no_simbricks)
341
342
343
344
345
else:
    # otherwise load pickled run object
    for path in args.experiments:
        with open(path, 'rb') as f:
            rt.add_run(pickle.load(f))
346

347
rt.start()