ckb-script 1.1.0

CKB component to run the type/lock scripts
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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
#include "spawn_utils.h"

int parent_simple_read_write(uint64_t* pid) {
    int err = 0;
    const char* argv[] = {"", 0};
    uint64_t fds[2] = {0};

    err = full_spawn(0, 1, argv, fds, pid);
    // write
    uint8_t block[11] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
    for (size_t i = 0; i < 7; i++) {
        size_t actual_length = 0;
        err = write_exact(fds[CKB_STDOUT], block, sizeof(block), &actual_length);
        CHECK(err);
        CHECK2(actual_length == sizeof(block), -2);
    }
    // read
    for (size_t i = 0; i < 7; i++) {
        uint8_t block[11] = {0};
        size_t actual_length = 0;
        err = read_exact(fds[CKB_STDIN], block, sizeof(block), &actual_length);
        CHECK(err);
        CHECK2(actual_length == sizeof(block), -2);
        for (size_t j = 0; j < sizeof(block); j++) {
            CHECK2(block[j] == 0xFF, -2);
        }
    }
exit:
    return err;
}

int child_simple_read_write() {
    int err = 0;
    uint64_t inherited_fds[2];
    size_t inherited_fds_length = 2;
    err = ckb_inherited_fds(inherited_fds, &inherited_fds_length);
    // read
    for (size_t i = 0; i < 11; i++) {
        uint8_t block[7] = {0};
        size_t actual_length = 0;
        err = read_exact(inherited_fds[CKB_STDIN], block, sizeof(block), &actual_length);
        CHECK(err);
        CHECK2(actual_length == sizeof(block), -2);
        for (size_t j = 0; j < sizeof(block); j++) {
            CHECK2(block[j] == 0xFF, -3);
        }
    }
    // write
    uint8_t block[11] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
    for (size_t i = 0; i < 7; i++) {
        size_t actual_length = 0;
        err = write_exact(inherited_fds[CKB_STDOUT], block, sizeof(block), &actual_length);
        CHECK(err);
        CHECK2(actual_length == sizeof(block), -2);
    }
exit:
    return err;
}

int parent_write_dead_lock(uint64_t* pid) {
    int err = 0;
    const char* argv[] = {"", 0};
    uint64_t fds[2] = {0};
    err = full_spawn(0, 1, argv, fds, pid);
    CHECK(err);
    uint8_t data[10];
    size_t data_length = sizeof(data);
    err = ckb_write(fds[CKB_STDOUT], data, &data_length);
    CHECK(err);

exit:
    return err;
}

int child_write_dead_lock() {
    int err = 0;
    uint64_t inherited_fds[3] = {0};
    size_t inherited_fds_length = 3;
    err = ckb_inherited_fds(inherited_fds, &inherited_fds_length);
    CHECK(err);
    uint8_t data[10];
    size_t data_length = sizeof(data);
    err = ckb_write(inherited_fds[CKB_STDOUT], data, &data_length);
    CHECK(err);
exit:
    return err;
}

int parent_invalid_fd(uint64_t* pid) {
    uint64_t invalid_fd = 0xff;
    uint8_t data[4];
    size_t data_length = sizeof(data);
    int err = ckb_read(invalid_fd, data, &data_length);
    CHECK2(err != 0, -2);
    err = ckb_write(invalid_fd, data, &data_length);
    CHECK2(err != 0, -2);

    uint64_t fds[2] = {0};
    err = ckb_pipe(fds);
    // read on write fd
    err = ckb_read(fds[CKB_STDOUT], data, &data_length);
    CHECK2(err != 0, -3);
    // write on read fd
    err = ckb_write(fds[CKB_STDIN], data, &data_length);
    CHECK2(err != 0, -3);

    // pass fd to child to make it invalid
    const char* argv[] = {"", 0};
    uint64_t inherited_fds[2] = {fds[0], 0};
    spawn_args_t spgs = {.argc = 1, .argv = argv, .process_id = pid, .inherited_fds = inherited_fds};
    err = ckb_spawn(0, CKB_SOURCE_CELL_DEP, 0, 0, &spgs);
    CHECK(err);
    err = ckb_read(fds[0], data, &data_length);
    CHECK2(err != 0, -3);

    // write to fd but the other end is closed
    err = ckb_pipe(fds);
    CHECK(err);
    err = ckb_close(fds[CKB_STDIN]);
    CHECK(err);
    err = ckb_write(fds[CKB_STDOUT], data, &data_length);
    CHECK2(err == CKB_OTHER_END_CLOSED, -2);

    // read from fd but the other end is closed
    err = ckb_pipe(fds);
    CHECK(err);
    err = ckb_close(fds[CKB_STDOUT]);
    CHECK(err);
    err = ckb_read(fds[CKB_STDIN], data, &data_length);
    CHECK2(err == CKB_OTHER_END_CLOSED, -2);
    err = 0;
exit:
    return err;
}

int parent_wait_dead_lock(uint64_t* pid) {
    int err = 0;
    const char* argv[] = {"", 0};
    uint64_t fds[2] = {0};
    err = full_spawn(0, 1, argv, fds, pid);
    CHECK(err);

exit:
    return err;
}

int child_wait_dead_lock() {
    uint64_t pid = 0;  // parent pid
    int8_t exit_code = 0;
    return ckb_wait(pid, &exit_code);
}

int parent_read_write_with_close(uint64_t* pid) {
    int err = 0;
    const char* argv[] = {"", 0};
    uint64_t fds[2] = {0};
    err = full_spawn(0, 1, argv, fds, pid);
    // write util the other end is closed
    uint8_t block[100];
    for (size_t i = 0; i < sizeof(block); i++) {
        block[i] = 0xFF;
    }
    size_t actual_length = 0;
    err = write_exact(fds[CKB_STDOUT], block, sizeof(block), &actual_length);
    CHECK(err);
    CHECK2(actual_length == sizeof(block), -2);

    err = 0;
exit:
    return err;
}

int child_read_write_with_close() {
    int err = 0;
    uint64_t inherited_fds[2];
    size_t inherited_fds_length = 2;
    err = ckb_inherited_fds(inherited_fds, &inherited_fds_length);
    CHECK(err);

    // read 100 bytes and close
    uint8_t block[100] = {0};
    size_t actual_length = 0;
    err = read_exact(inherited_fds[CKB_STDIN], block, sizeof(block), &actual_length);
    CHECK(err);
    CHECK2(actual_length == sizeof(block), -2);
    for (size_t j = 0; j < sizeof(block); j++) {
        CHECK2(block[j] == 0xFF, -3);
    }
    err = ckb_close(inherited_fds[CKB_STDIN]);
    CHECK(err);

exit:
    return err;
}

int parent_wait_multiple(uint64_t* pid) {
    int err = 0;
    const char* argv[] = {"", 0};
    uint64_t fds[2] = {0};
    full_spawn(0, 1, argv, fds, pid);
    CHECK(err);

    int8_t exit_code = 0;
    err = ckb_wait(*pid, &exit_code);
    CHECK(err);
    // second wait is not allowed
    err = ckb_wait(*pid, &exit_code);
    CHECK2(err != 0, -2);
    err = 0;
    // spawn a new valid one, make ckb_wait happy
    full_spawn(0, 1, argv, fds, pid);
    CHECK(err);

exit:
    return err;
}

int parent_inherited_fds(uint64_t* pid) {
    int err = 0;
    const char* argv[] = {"", 0};
    uint64_t inherited_fds[11] = {0};
    for (size_t i = 0; i < 5; i++) {
        err = ckb_pipe(&inherited_fds[i * 2]);
        CHECK(err);
    }
    spawn_args_t spgs = {.argc = 1, .argv = argv, .process_id = pid, .inherited_fds = inherited_fds};
    err = ckb_spawn(0, CKB_SOURCE_CELL_DEP, 0, 0, &spgs);
    CHECK(err);
exit:
    return err;
}

int child_inherited_fds() {
    int err = 0;

    // correct way to get fd length
    size_t fds_length = 0;
    err = ckb_inherited_fds(0, &fds_length);
    CHECK2(fds_length == 10, -2);

    // get part of fds
    uint64_t fds[11] = {0};
    fds_length = 1;
    err = ckb_inherited_fds(fds, &fds_length);
    CHECK(err);
    CHECK2(fds_length == 10, -2);
    CHECK2(fds[0] == 2, -2);

    // get all fds
    fds_length = 10;
    err = ckb_inherited_fds(fds, &fds_length);
    CHECK(err);
    CHECK2(fds_length == 10, -2);
    for (size_t i = 0; i < 10; i++) {
        CHECK2(fds[i] == (i + 2), -2);
    }
exit:
    return err;
}

int parent_inherited_fds_without_owner(uint64_t* pid) {
    int err = 0;
    const char* argv[] = {"", 0};
    uint64_t fds[3] = {0xFF, 0xEF, 0};

    spawn_args_t spgs = {.argc = 1, .argv = argv, .process_id = pid, .inherited_fds = fds};
    err = ckb_spawn(0, CKB_SOURCE_CELL_DEP, 0, 0, &spgs);
    CHECK2(err == CKB_INVALID_FD, -2);

    // create valid fds
    err = ckb_pipe(fds);
    CHECK(err);
    // then transferred by spawn
    err = ckb_spawn(0, CKB_SOURCE_CELL_DEP, 0, 0, &spgs);
    CHECK(err);

    // the fds are already transferred. An error expected.
    err = ckb_spawn(0, CKB_SOURCE_CELL_DEP, 0, 0, &spgs);
    CHECK2(err == CKB_INVALID_FD, -2);
    err = 0;
exit:
    return err;
}

int parent_read_then_close(uint64_t* pid) {
    int err = 0;
    const char* argv[] = {"", 0};
    uint64_t fds[2] = {0};
    err = full_spawn(0, 1, argv, fds, pid);
    CHECK(err);
    err = ckb_close(fds[CKB_STDOUT]);
    CHECK(err);
exit:
    return err;
}

int child_read_then_close() {
    int err = 0;
    uint64_t fds[2] = {0};
    uint64_t fds_length = 2;
    err = ckb_inherited_fds(fds, &fds_length);
    CHECK(err);
    uint8_t data[8];
    size_t data_len = sizeof(data);
    // first read to return 0 byte without error
    err = ckb_read(fds[CKB_STDIN], data, &data_len);
    CHECK(err);
    CHECK2(data_len == 0, -2);
    // second read to return error(other end closed)
    err = ckb_read(fds[CKB_STDIN], data, &data_len);
    CHECK2(err == CKB_OTHER_END_CLOSED, -2);

    err = 0;
exit:
    return err;
}

int parent_max_vms_count() {
    const char* argv[2] = {"", 0};
    return simple_spawn_args(0, 1, argv);
}

int child_max_vms_count() {
    const char* argv[2] = {"", 0};
    int err = simple_spawn_args(0, 1, argv);
    CHECK2(err == 0 || err == CKB_MAX_VMS_SPAWNED, -2);
    err = 0;
exit:
    return err;
}

int parent_max_fds_limit() {
    const char* argv[2] = {"", 0};
    int err = 0;
    uint64_t fd[2] = {0};
    for (int i = 0; i < 16; i++) {
        err = ckb_pipe(fd);
        CHECK(err);
    }
    err = simple_spawn_args(0, 1, argv);
exit:
    return err;
}

int child_max_fds_limit() {
    int err = 0;
    uint64_t fd[2] = {0};
    for (int i = 0; i < 16; i++) {
        err = ckb_pipe(fd);
        CHECK(err);
    }
    // Create up to 64 pipes.
    err = ckb_pipe(fd);
    err = CKB_MAX_FDS_CREATED - 9;

exit:
    return err;
}

int parent_close_invalid_fd() {
    uint64_t fds[2] = {0};
    int err = ckb_pipe(fds);
    CHECK(err);

    err = ckb_close(fds[CKB_STDIN] + 32);
    CHECK2(err == 6, -1);

    err = ckb_close(fds[CKB_STDIN]);
    CHECK(err);
    err = ckb_close(fds[CKB_STDOUT]);
    CHECK(err);

    err = ckb_close(fds[CKB_STDIN]);
    CHECK2(err == 6, -1);
    err = ckb_close(fds[CKB_STDOUT]);
    CHECK2(err == 6, -1);

    err = 0;
exit:
    return err;
}

int parent_write_closed_fd(uint64_t* pid) {
    int err = 0;
    const char* argv[] = {"", 0};
    uint64_t fds[2] = {0};
    err = full_spawn(0, 1, argv, fds, pid);
    CHECK(err);

    // int exit_code = 0;
    uint8_t block[7] = {1, 2, 3, 4, 5, 6, 7};
    size_t actual_length = 0;
    err = read_exact(fds[CKB_STDIN], block, sizeof(block), &actual_length);
    CHECK(err);
    err = ckb_close(fds[CKB_STDIN]);
    CHECK(err);

    err = ckb_close(fds[CKB_STDOUT]);
exit:
    return err;
}

int child_write_closed_fd() {
    int err = 0;
    uint64_t inherited_fds[2];
    size_t inherited_fds_length = 2;
    err = ckb_inherited_fds(inherited_fds, &inherited_fds_length);
    CHECK(err);

    uint8_t block[7] = {0};
    size_t actual_length = 0;
    err = write_exact(inherited_fds[CKB_STDOUT], block, sizeof(block), &actual_length);
    CHECK(err);
    err = write_exact(inherited_fds[CKB_STDOUT], block, sizeof(block), &actual_length);
    CHECK(err);

    ckb_close(inherited_fds[CKB_STDIN]);
    ckb_close(inherited_fds[CKB_STDOUT]);

exit:
    return err;
}

int parent_pid(uint64_t* pid) {
    int err = 0;

    uint64_t cur_pid = ckb_process_id();

    uint64_t pid_c1 = 0;
    const char* argv[] = {"", 0};
    uint64_t fds_1[2] = {0};
    err = full_spawn(0, 1, argv, fds_1, &pid_c1);
    CHECK2(pid_c1 != cur_pid, -1);

    uint64_t pid_c2 = 0;
    uint64_t fds_2[2] = {0};
    err = full_spawn(0, 1, argv, fds_2, &pid_c2);
    CHECK(err);
    CHECK2(pid_c2 != cur_pid, -1);

    uint64_t child_pid_1 = 0;
    size_t actual_length = 0;
    err = read_exact(fds_1[CKB_STDIN], &child_pid_1, sizeof(child_pid_1), &actual_length);
    CHECK(err);
    CHECK2(child_pid_1 == pid_c1, -1);

    uint64_t child_pid_2 = 0;
    err = read_exact(fds_2[CKB_STDIN], &child_pid_2, sizeof(child_pid_2), &actual_length);
    CHECK(err);
    CHECK2(child_pid_2 == pid_c2, -1);

exit:
    return err;
}

int child_pid() {
    uint64_t pid = ckb_process_id();

    int err = 0;
    uint64_t fds[2] = {0};
    uint64_t fds_length = 2;
    err = ckb_inherited_fds(fds, &fds_length);
    CHECK(err);

    // send pid
    size_t actual_length = 0;
    err = write_exact(fds[CKB_STDOUT], &pid, sizeof(pid), &actual_length);
    CHECK(err);

exit:
    return err;
}

int parent_spawn_offset_out_of_bound(uint64_t* pid) {
    int err = 0;

    const char* argv[] = {"", 0};
    spawn_args_t spgs = {.argc = 1, .argv = argv, .process_id = pid, .inherited_fds = NULL};
    uint64_t offset = 1024 * 1024 * 1024 * 1;
    uint64_t length = 0;
    uint64_t bounds = (offset << 32) + length;
    err = ckb_spawn(0, CKB_SOURCE_CELL_DEP, 0, bounds, &spgs);
    CHECK2(err == 3, -1);  // SLICE_OUT_OF_BOUND
    err = 0;
exit:
    return err;
}

int parent_spawn_length_out_of_bound(uint64_t* pid) {
    int err = 0;

    const char* argv[] = {"", 0};
    spawn_args_t spgs = {.argc = 1, .argv = argv, .process_id = pid, .inherited_fds = NULL};
    uint64_t offset = 1024 * 17;
    uint64_t length = 1024;
    uint64_t bounds = (offset << 32) + length;

    err = ckb_spawn(0, CKB_SOURCE_CELL_DEP, 0, bounds, &spgs);
    CHECK2(err == 3, -1);  // SLICE_OUT_OF_BOUND
    err = 0;
exit:
    return err;
}

int parent_invaild_index(uint64_t* pid) {
    int err = 0;
    const char* argv[] = {"", 0};
    uint64_t inherited_fds[11] = {0};
    for (size_t i = 0; i < 5; i++) {
        err = ckb_pipe(&inherited_fds[i * 2]);
        CHECK(err);
    }
    spawn_args_t spgs = {.argc = 1, .argv = argv, .process_id = pid, .inherited_fds = inherited_fds};
    err = ckb_spawn(0xFFFFFFFFF, CKB_SOURCE_CELL_DEP, 0, 0, &spgs);
    CHECK2(err == 1, -1);  // INDEX_OUT_OF_BOUND
    err = 0;

exit:
    return err;
}

int parent_index_out_of_bound(uint64_t* pid) {
    int err = 0;
    const char* argv[] = {"", 0};
    uint64_t inherited_fds[11] = {0};
    for (size_t i = 0; i < 5; i++) {
        err = ckb_pipe(&inherited_fds[i * 2]);
        CHECK(err);
    }
    spawn_args_t spgs = {.argc = 1, .argv = argv, .process_id = pid, .inherited_fds = inherited_fds};
    err = ckb_spawn(2, CKB_SOURCE_CELL_DEP, 0, 0, &spgs);
    CHECK2(err == 1, -1);  // INDEX_OUT_OF_BOUND
    err = 0;

exit:
    return err;
}

int parent_root_inherited_fds() {
    uint64_t fds[2] = {0};
    uint64_t length = 2;
    int err = ckb_inherited_fds(fds, &length);
    CHECK(err);
    CHECK2(length == 0, -1);
    err = 0;
exit:
    return err;
}

int parent_entry(int case_id) {
    int err = 0;
    uint64_t pid = 0;
    if (case_id == 1) {
        err = parent_simple_read_write(&pid);
    } else if (case_id == 2) {
        err = parent_write_dead_lock(&pid);
    } else if (case_id == 3) {
        err = parent_invalid_fd(&pid);
    } else if (case_id == 4) {
        err = parent_wait_dead_lock(&pid);
    } else if (case_id == 5) {
        err = parent_read_write_with_close(&pid);
    } else if (case_id == 6) {
        err = parent_wait_multiple(&pid);
    } else if (case_id == 7) {
        err = parent_inherited_fds(&pid);
    } else if (case_id == 8) {
        err = parent_inherited_fds_without_owner(&pid);
    } else if (case_id == 9) {
        err = parent_read_then_close(&pid);
    } else if (case_id == 10) {
        err = parent_max_vms_count(&pid);
        return err;
    } else if (case_id == 11) {
        err = parent_max_fds_limit(&pid);
        return err;
    } else if (case_id == 12) {
        return parent_close_invalid_fd(&pid);
    } else if (case_id == 13) {
        return parent_write_closed_fd(&pid);
    } else if (case_id == 14) {
        return parent_pid(&pid);
    } else if (case_id == 15) {
        return parent_spawn_offset_out_of_bound(&pid);
    } else if (case_id == 16) {
        return parent_spawn_length_out_of_bound(&pid);
    } else if (case_id == 17) {
        return parent_invaild_index(&pid);
    } else if (case_id == 18) {
        return parent_index_out_of_bound(&pid);
    } else if (case_id == 19) {
        return parent_root_inherited_fds();
    } else {
        CHECK2(false, -2);
    }
    CHECK(err);
    int8_t exit_code = 0;
    err = ckb_wait(pid, &exit_code);
    CHECK(err);
    CHECK(exit_code);

exit:
    return err;
}

int child_entry(int case_id) {
    if (case_id == 1) {
        return child_simple_read_write();
    } else if (case_id == 2) {
        return child_write_dead_lock();
    } else if (case_id == 3) {
        return 0;
    } else if (case_id == 4) {
        return child_wait_dead_lock();
    } else if (case_id == 5) {
        return child_read_write_with_close();
    } else if (case_id == 6) {
        return 0;
    } else if (case_id == 7) {
        return child_inherited_fds();
    } else if (case_id == 8) {
        return 0;
    } else if (case_id == 9) {
        return child_read_then_close();
    } else if (case_id == 10) {
        return child_max_vms_count();
    } else if (case_id == 11) {
        return child_max_fds_limit();
    } else if (case_id == 12) {
        return 0;
    } else if (case_id == 13) {
        return child_write_closed_fd();
    } else if (case_id == 14) {
        return child_pid();
    } else if (case_id == 15) {
        return 0;
    } else if (case_id == 16) {
        return 0;
    } else {
        return -1;
    }
}

int main(int argc, const char* argv[]) {
    uint8_t script_args[8];
    size_t script_args_length = 8;
    int err = load_script_args(script_args, &script_args_length);
    if (err) {
        return err;
    }
    int case_id = (int)script_args[0];
    if (argc > 0) {
        return child_entry(case_id);
    } else {
        return parent_entry(case_id);
    }
}