jerbs 0.2.0

Command-line work-stealing scheduler.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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
107
108
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
use clap::{crate_version, App, AppSettings, Arg, SubCommand};
use jerbs::{Command, Db, Time};
use std::collections::HashMap;
use std::fmt::{self, Display};
use std::io::{self, Read, Write};
use std::os::unix::ffi::OsStringExt;
use tabled::{Style, Table, Tabled};

fn read_data() -> Vec<u8> {
    let mut buf = Vec::new();
    io::stdin().read_to_end(&mut buf).unwrap();
    buf
}

#[derive(PartialEq, Eq)]
enum BuildingHelp {
    No,
    Long,
    Short,
}

fn build_app(help: BuildingHelp) -> App<'static, 'static> {
    let mut app = App::new("jerbs")
        .version(crate_version!())
        .setting(AppSettings::DisableHelpSubcommand)
        .author("Kaz Wesley <jerbs@lambdaverse.org>")
        .about("Command-line work-stealing scheduler")
        .arg(
            Arg::with_name("help")
                .short("h")
                .long("help")
                .help("Print this help message documenting the most common subcommands")
                .long_help(
                    "Print a condensed help message documenting the most common subcommands",
                ),
        )
        .arg(
            Arg::with_name("long-help")
                .long("long-help")
                .help("Print an extended help message documenting all available subcommands")
                .long_help("Print this help message documenting all available subcommands"),
        )
        .arg(
            Arg::with_name("database")
                .help("Path to the jobs database file")
                .required_unless_one(&["help", "long-help"])
                .index(1),
        );
    let common_subcommands = vec![
        SubCommand::with_name("init").about("create a new jobs database"),
        SubCommand::with_name("create")
            .about("define a job")
            .arg(
                Arg::with_name("count")
                    .help("the number of repetitions to enqueue initially")
                    .short("c")
                    .long("count")
                    .takes_value(true)
                    .default_value("0"),
            )
            .arg(
                Arg::with_name("data")
                    .help("the data associated with the job")
                    .short("d")
                    .long("data")
                    .takes_value(true),
            )
            .arg(
                Arg::with_name("priority")
                    .help("the new job's priority (low = do sooner, default = 0)")
                    .short("p")
                    .long("priority")
                    .takes_value(true),
            ),
        SubCommand::with_name("list-available")
            .about("list jobs available to be taken")
            .arg(
                Arg::with_name("verbose")
                    .help("informative output for interactive use")
                    .short("v")
                    .long("verbose"),
            ),
        SubCommand::with_name("take")
            .about("take a job from the queue")
            .arg(
                Arg::with_name("wait")
                    .help("wait for a job to become available")
                    .short("w")
                    .long("wait"),
            )
            .arg(
                Arg::with_name("worker-id")
                    .help("any string identifying the worker taking the job")
                    .required(true)
                    .index(1),
            ),
        SubCommand::with_name("list-running")
            .about("list jobs logged as started and not finished")
            .arg(
                Arg::with_name("verbose")
                    .help("informative output for interactive use")
                    .short("v")
                    .long("verbose"),
            ),
        SubCommand::with_name("list-taken")
            .about("list jobs taken from the queue")
            .arg(
                Arg::with_name("verbose")
                    .help("informative output for interactive use")
                    .short("v")
                    .long("verbose"),
            ),
        SubCommand::with_name("monitor")
            .about("run a command, invoking log-start and log-finish appropriately")
            .arg(
                Arg::with_name("requeue")
                    .short("r")
                    .long("requeue-on-fail")
                    .help("If the command executes with non-zero status, put its job back in the queue"),
            )
            .arg(
                Arg::with_name("worker-id")
                    .help("any string identifying the worker taking the job")
                    .required(true)
                    .index(1),
            )
            .arg(
                Arg::with_name("command")
                    .help("command to run")
                    .required(true)
                    .multiple(true)
                    .last(true),
            ),
    ];
    let uncommon_subcommands = vec![
        SubCommand::with_name("get-data")
            .about("get the data associated with a job")
            .arg(Arg::with_name("job-id").required(true).index(1)),
        SubCommand::with_name("get-count")
            .about("get the remaining count for a job")
            .arg(Arg::with_name("job-id").required(true).index(1)),
        SubCommand::with_name("log-start")
            .about("add a start event to the log")
            .arg(
                Arg::with_name("worker-id")
                    .help("any string identifying the worker taking the job")
                    .required(true)
                    .index(1),
            )
            .arg(
                Arg::with_name("command")
                    .help("command to log")
                    .multiple(true)
                    .last(true),
            ),
        SubCommand::with_name("log-finish")
            .about("add a finish event to the log")
            .arg(
                Arg::with_name("worker-id")
                    .help("any string identifying the worker taking the job")
                    .required(true)
                    .index(1),
            )
            .arg(
                Arg::with_name("result")
                    .help("integer result code (0 = no error)")
                    .required(true)
                    .index(2),
            ),
    ];
    app = app.subcommands(common_subcommands);
    if help != BuildingHelp::Short {
        app = app.subcommands(uncommon_subcommands);
    }
    app
}

#[derive(Tabled)]
struct Task {
    id: u32,
    count: u64,
    priority: i32,
    data: String,
}

#[derive(Tabled)]
struct JobStatus {
    worker: String,
    start_time: Paw<Time>,
    start_cmd: Paw<Command>,
    finish_result: Paw<i32>,
    finish_time: Paw<Time>,
    finish_data: Paw<MaybeUtf8>,
}

enum Paw<T> {
    Present(T),
    Absent,
    What,
}

impl<T> Display for Paw<T>
where
    T: Display,
{
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Paw::Present(x) => x.fmt(f),
            Paw::Absent => write!(f, ""),
            Paw::What => write!(f, "?"),
        }
    }
}

struct MaybeUtf8(Vec<u8>);

impl Display for MaybeUtf8 {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str(std::str::from_utf8(&self.0).unwrap_or("<data>"))
    }
}

fn print_statuses(jobs: impl IntoIterator<Item = jerbs::JobId>, db: &Db) -> jerbs::Result<()> {
    let mut entries = Vec::new();
    let mut worker_latest = HashMap::new();
    for job in jobs.into_iter() {
        let worker = db.get_job_worker(job)?;
        let latest = match worker_latest.get(&worker) {
            Some(latest) => *latest,
            None => {
                let latest = db.get_worker_latest_job(&worker)?.unwrap();
                worker_latest.insert(worker.to_string(), latest);
                latest
            }
        };
        let is_latest = job == latest;
        let start = db.get_job_start(job)?;
        let finish = db.get_job_finish(job)?;
        let start_time = start
            .as_ref()
            .map(|x| Paw::Present(x.time))
            .unwrap_or(if is_latest { Paw::Absent } else { Paw::What });
        let start_cmd = start.map(|x| Paw::Present(x.cmd)).unwrap_or(if is_latest {
            Paw::Absent
        } else {
            Paw::What
        });
        let finish_result = finish
            .as_ref()
            .map(|x| Paw::Present(x.result))
            .unwrap_or(if is_latest { Paw::Absent } else { Paw::What });
        let finish_time = finish
            .as_ref()
            .map(|x| Paw::Present(x.time))
            .unwrap_or(if is_latest { Paw::Absent } else { Paw::What });
        let finish_data = finish
            .map(|x| Paw::Present(MaybeUtf8(x.data)))
            .unwrap_or(if is_latest { Paw::Absent } else { Paw::What });
        entries.push(JobStatus {
            worker,
            start_time,
            start_cmd,
            finish_result,
            finish_time,
            finish_data,
        })
    }
    print!("{}", Table::new(entries).with(Style::pseudo_clean()));
    Ok(())
}

#[derive(Tabled)]
struct RunningStatus {
    worker: String,
    start_time: Time,
    start_cmd: Command,
}

fn print_running_statuses(
    jobs: impl IntoIterator<Item = jerbs::JobId>,
    db: &Db,
) -> jerbs::Result<()> {
    let mut entries = Vec::new();
    for job in jobs.into_iter() {
        let worker = db.get_job_worker(job)?;
        let start = db.get_job_start(job)?;
        let start_time = start.as_ref().unwrap().time;
        let start_cmd = start.unwrap().cmd;
        entries.push(RunningStatus {
            worker,
            start_time,
            start_cmd,
        })
    }
    print!("{}", Table::new(entries).with(Style::pseudo_clean()));
    Ok(())
}

fn main() -> jerbs::Result<()> {
    if std::env::args().len() < 2 {
        build_app(BuildingHelp::Short).print_help()?;
        std::process::exit(-1);
    }
    let mut app = build_app(BuildingHelp::No);
    let args = app
        .get_matches_from_safe_borrow(std::env::args())
        .unwrap_or_else(|e| e.exit());
    if args.is_present("long-help") {
        build_app(BuildingHelp::Long).print_long_help()?;
        std::process::exit(-1);
    } else if args.is_present("help") || !args.is_present("database") {
        build_app(BuildingHelp::Short).print_help()?;
        std::process::exit(-1);
    }

    let path = match args.value_of("database") {
        Some(path) => path,
        None => {
            build_app(BuildingHelp::Short).print_help()?;
            std::process::exit(-1);
        }
    };

    match args.subcommand() {
        ("init", Some(_)) => {
            let _ = Db::create(path)?;
        }
        ("create", Some(args)) => {
            let count = args
                .value_of("count")
                .unwrap()
                .parse()
                .expect("count must be integer");
            let priority = args
                .value_of("priority")
                .map(|x| x.parse().expect("priority must be integer"));
            let mut db = Db::open(path)?;
            let id = if let Some(data) = args.value_of("data") {
                db.new_job(data.as_bytes(), count, priority)?
            } else {
                let data = read_data();
                db.new_job(&data, count, priority)?
            };
            println!("{}", id);
        }
        ("list-available", Some(args)) => {
            let verbose = args.is_present("verbose");
            let db = Db::open(path)?;
            let ids = db.job_ids_vec()?;
            if verbose {
                let mut entries = Vec::new();
                for id in ids {
                    let count = db.get_count(id)?;
                    let priority = db.get_priority(id)?;
                    let data = db.get_data(id)?;
                    let data = std::str::from_utf8(&data).unwrap_or("<data>");
                    entries.push(Task {
                        id,
                        count,
                        priority,
                        data: data.to_owned(),
                    });
                }
                print!("{}", Table::new(entries).with(Style::pseudo_clean()));
            } else {
                for id in ids {
                    println!("{}", id);
                }
            }
        }
        ("get-data", Some(args)) => {
            let id = args
                .value_of("job-id")
                .unwrap()
                .parse()
                .expect("job ids are integers");
            let data = Db::open(path)?.get_data(id)?;
            io::stdout().write_all(&data).unwrap();
        }
        ("get-count", Some(args)) => {
            let id = args
                .value_of("job-id")
                .unwrap()
                .parse()
                .expect("job ids are integers");
            let count = Db::open(path)?.get_count(id)?;
            println!("{}", count);
        }
        ("take", Some(args)) => {
            let mut db = Db::open(path)?;
            let worker = args.value_of("worker-id").unwrap();
            let wait = args.is_present("wait");
            if wait {
                todo!("take --wait")
            } else {
                let job = db.take(worker)?;
                if let Some(job) = job {
                    io::stdout().write_all(&job.data).unwrap();
                } else {
                    std::process::exit(2);
                }
            }
        }
        ("list-running", Some(args)) => {
            let verbose = args.is_present("verbose");
            let mut db = Db::open(path)?;
            if verbose {
                print_running_statuses(db.get_started_jobs()?, &db)?;
            } else {
                for job in db.get_started_jobs()? {
                    println!("{}", job);
                }
            }
        }
        ("list-taken", Some(args)) => {
            let verbose = args.is_present("verbose");
            let mut db = Db::open(path)?;
            if verbose {
                print_statuses(db.get_jobs()?, &db)?;
            } else {
                for job in db.get_jobs()? {
                    println!("{}", job);
                }
            }
        }
        ("log-start", Some(args)) => {
            let mut db = Db::open(path)?;
            let worker = args.value_of("worker-id").unwrap();
            let logcmd = args
                .values_of_os("command")
                .map(|args| args.map(|x| x.to_os_string().into_vec()).collect())
                .unwrap_or(vec![]);
            let id = db
                .current_job(worker)?
                .expect("worker currently has no job");
            db.log_start(id, logcmd)?;
        }
        ("log-finish", Some(args)) => {
            let mut db = Db::open(path)?;
            let worker = args.value_of("worker-id").unwrap();
            let result = args
                .value_of("result")
                .unwrap()
                .parse()
                .expect("result must be int");
            let id = db
                .current_job(worker)?
                .expect("worker currently has no job");
            db.log_finish(id, result)?;
        }
        ("monitor", Some(args)) => {
            use std::os::unix::process::ExitStatusExt;
            use std::process::Command;

            let requeue = args.is_present("requeue");
            let mut db = Db::open(path)?;
            let worker = args.value_of("worker-id").unwrap();
            let logcmd = args
                .values_of_os("command")
                .unwrap()
                .map(|x| x.to_os_string().into_vec())
                .collect();
            let id = db
                .current_job(worker)?
                .expect("worker currently has no job");
            db.log_start(id, logcmd)?;
            let mut cmd = args.values_of_os("command").unwrap();
            let exe = cmd.next().unwrap();
            let result = Command::new(exe).args(cmd).status();
            let log_code;
            let my_exit;
            match result {
                Ok(result) => {
                    // In the logs, we record signals as 256 + SIGNAL so it's always possible to
                    // distinguish them from regular exit codes.
                    log_code = result
                        .code()
                        .unwrap_or_else(|| 256 + result.signal().unwrap());
                    // In our return value, we report signals as 128 + SIGNAL (like bash), since we don't
                    // have enough return value space to keep signals distinct from exit codes.
                    my_exit = result
                        .code()
                        .unwrap_or_else(|| 128 + result.signal().unwrap());
                }
                Err(e) => {
                    eprintln!("Failed to start command: {}", e);
                    const EXIT_FAILED_TO_START: i32 = 512;
                    log_code = EXIT_FAILED_TO_START;
                    my_exit = -1;
                }
            }
            db.log_finish(id, log_code)?;
            if requeue && log_code != 0 {
                // TODO
            }
            std::process::exit(my_exit);
        }
        _ => build_app(BuildingHelp::Short).print_help()?,
    }
    Ok(())
}