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
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
(* SPDX-License-Identifier: AGPL-3.0-or-later *)
(* Copyright © 2021-2026 OCamlPro *)
(* Written by the Owi programmers *)

open Owi
open Cmdliner

(* Helpers *)

let call_graph_mode_conv =
  let of_string s =
    match String.lowercase_ascii s with
    | "complete" -> Ok Cmd_wasm_analyze_cg.Complete
    | "sound" -> Ok Cmd_wasm_analyze_cg.Sound
    | _ -> Fmt.error_msg {|Expected "complete" or "sound" but got "%s"|} s
  in
  let pp fmt = function
    | Cmd_wasm_analyze_cg.Complete -> Fmt.string fmt "complete"
    | Cmd_wasm_analyze_cg.Sound -> Fmt.string fmt "sound"
  in
  Arg.conv (of_string, pp)

let coverage_criteria_conv =
  let open Label.Coverage_criteria in
  Arg.conv (of_string, pp)

let existing_file_conv =
  let open Prelude.Result.Syntax in
  let parse s =
    let* path = Fpath.of_string s in
    let* exists = Bos.OS.File.exists path in
    if exists then Ok path else Fmt.error_msg "no file '%a'" Fpath.pp path
  in
  Arg.conv (parse, Fpath.pp)

let existing_dir_conv =
  let open Prelude.Result.Syntax in
  let parse s =
    let* path = Fpath.of_string s in
    let* exists = Bos.OS.Dir.exists path in
    if exists then Ok path else Fmt.error_msg "no directory '%a'" Fpath.pp path
  in
  Arg.conv (parse, Fpath.pp)

let path_conv = Arg.conv (Fpath.of_string, Fpath.pp)

let solver_conv = Arg.conv (Smtml.Solver_type.of_string, Smtml.Solver_type.pp)

let exploration_conv =
  Arg.conv
    ( Symbolic_parameters.Exploration_strategy.of_string
    , Symbolic_parameters.Exploration_strategy.pp )

let model_format_conv =
  let of_string s =
    match String.lowercase_ascii s with
    | "scfg" -> Ok Model.Scfg
    | "json" -> Ok Json
    | _ -> Fmt.error_msg {|Expected "json" or "scfg" but got "%s"|} s
  in
  let pp fmt = function
    | Model.Scfg -> Fmt.string fmt "scfg"
    | Json -> Fmt.string fmt "json"
  in
  Arg.conv (of_string, pp)

(* Common options *)

let copts_t = Term.(const [])

let sdocs = Manpage.s_common_options

let shared_man =
  [ `S Manpage.s_bugs; `P "Email them to <owi.wildcat119@passmail.com>." ]

let version = Cmd_version.owi_version ()

let log_level =
  let env = Cmd.Env.info "OWI_VERBOSITY" in
  Logs_cli.level ~env ~docs:sdocs ()

let bench =
  let doc = "enable benchmarks" in
  Arg.(value & flag & info [ "bench" ] ~doc ~docs:sdocs)

(* Common terms *)

open Term.Syntax

let arch =
  let doc = "data model" in
  Arg.(value & opt int 32 & info [ "arch"; "m" ] ~doc)

let deterministic_result_order =
  let doc =
    "Guarantee a fixed deterministic order of found failures. This implies \
     --no-stop-at-failure."
  in
  Arg.(value & flag & info [ "deterministic-result-order" ] ~doc)

let call_graph_mode =
  let doc = {| The call graph is either "complete" or "sound" |} in
  Arg.(value & opt call_graph_mode_conv Sound & info [ "call-graph-mode" ] ~doc)

let coverage_criteria =
  let doc = {|Coverage criteria to use ("fc", "sc" or "dc").|} in
  Arg.(
    value
    & opt coverage_criteria_conv Label.Coverage_criteria.Statement_coverage
    & info [ "criteria" ] ~doc )

let entry_point default =
  let doc = "entry point of the executable" in
  Arg.(
    value
    & opt (some string) default
    & info [ "entry-point" ] ~doc ~docv:"FUNCTION" )

let fail_mode =
  let trap_doc = "ignore assertion violations and only report traps" in
  let assert_doc = "ignore traps and only report assertion violations" in
  Arg.(
    value
    & vflag Symbolic_parameters.Both
        [ (Trap_only, info [ "fail-on-trap-only" ] ~doc:trap_doc)
        ; (Assertion_only, info [ "fail-on-assertion-only" ] ~doc:assert_doc)
        ] )

let exploration_strategy =
  let doc =
    {|exploration strategy to use ("fifo", "lifo", "random", "random-unseen-then-random", "rarity", "hot-path-penalty", "rarity-aging", "rarity-depth-aging", "rarity-depth-loop-aging", "rarity-depth-loop-aging-random")|}
  in
  Arg.(
    value
    & opt exploration_conv Symbolic_parameters.Exploration_strategy.FIFO
    & info [ "exploration" ] ~doc )

let files =
  let doc = "source files" in
  Arg.(non_empty & pos_all existing_file_conv [] (info [] ~doc ~docv:"FILE"))

let generate_abstract_invariant =
  let doc =
    "Generate invariants by running the abstract interpretation engine."
  in
  Arg.(value & flag & info [ "generate-abstract-invariant" ] ~doc)

let includes =
  let doc = "headers path" in
  Arg.(value & opt_all existing_dir_conv [] & info [ "I" ] ~doc)

let invoke_with_symbols =
  let doc =
    "Invoke the entry point of the program with symbolic values instead of \
     dummy constants."
  in
  Arg.(value & flag & info [ "invoke-with-symbols" ] ~doc)

let model_format =
  let doc = {| The format of the model ("json" or "scfg") |} in
  Arg.(value & opt model_format_conv Scfg & info [ "model-format" ] ~doc)

let no_assert_failure_expression_printing =
  let doc = "do not display the expression in the assert failure" in
  Arg.(value & flag & info [ "no-assert-failure-expression-printing" ] ~doc)

let no_stop_at_failure =
  let doc = "do not stop when a program failure is encountered" in
  Arg.(value & flag & info [ "no-stop-at-failure" ] ~doc)

let no_value =
  let doc = "do not display a value for each symbol" in
  Arg.(value & flag & info [ "no-value" ] ~doc)

let no_worker_isolation =
  let doc = "Do not force each worker to run on an isolated physical core." in
  Arg.(value & flag & info [ "no-worker-isolation" ] ~doc)

let opt_lvl =
  let doc = "specify which optimization level to use" in
  Arg.(value & opt string "3" & info [ "O" ] ~doc)

let out_file =
  let doc = "Output the generated .wasm or .wat to FILE." in
  Arg.(
    value & opt (some path_conv) None & info [ "o"; "output" ] ~docv:"FILE" ~doc )

let model_out_file =
  let doc =
    "Output the generated model to FILE. if --no-stop-at-failure is given this \
     is used as a prefix and the ouputed files would have PREFIX_%d."
  in
  Arg.(
    value
    & opt (some path_conv) None
    & info [ "model-out-file" ] ~docv:"FILE" ~doc )

let rounds =
  let doc = "Stop after a number of fuzzing rounds." in
  Arg.(value & opt (some int) None & info [ "rounds" ] ~doc ~docv:"I")

let seed =
  let doc = "Initial seed for the PRNG state" in
  Arg.(value & opt (some int) None & info [ "seed" ] ~doc ~docv:"I")

let solver =
  let docv = Arg.conv_docv solver_conv in
  let doc =
    let pp_bold_solver fmt ty = Fmt.pf fmt "$(b,%a)" Smtml.Solver_type.pp ty in
    let supported_solvers = Smtml.Solver_type.supported_solvers in
    Fmt.str
      "SMT solver to use. $(i,%s) must be one of the %d available solvers: %a"
      docv
      (List.length supported_solvers)
      (Fmt.list ~sep:Fmt.comma pp_bold_solver)
      supported_solvers
  in
  Arg.(
    value
    & opt solver_conv Smtml.Solver_type.Z3_solver
    & info [ "solver"; "s" ] ~doc ~docv )

let source_file =
  let doc = "source file" in
  Arg.(
    required & pos 0 (some existing_file_conv) None (info [] ~doc ~docv:"FILE") )

let setup_log =
  let+ bench
  and+ log_level
  and+ style_renderer = Fmt_cli.style_renderer ~docs:sdocs () in
  Log.setup ~bench style_renderer log_level

let timeout =
  let doc = "Stop execution after S seconds." in
  Arg.(value & opt (some float) None & info [ "timeout" ] ~doc ~docv:"S")

let timeout_instr =
  let doc = "Stop execution after running I instructions." in
  Arg.(value & opt (some int) None & info [ "timeout-instr" ] ~doc ~docv:"I")

let unsafe =
  let doc = "skip typechecking pass" in
  Arg.(value & flag & info [ "unsafe"; "u" ] ~doc)

let workers =
  let doc =
    "Number of workers for symbolic execution. Defaults to the number of \
     physical cores."
  in
  Arg.(value & opt (some int) None & info [ "workers"; "w" ] ~doc ~absent:"n")

let workspace =
  let doc = "write results and intermediate compilation artifacts to dir" in
  Arg.(value & opt (some path_conv) None & info [ "workspace" ] ~doc ~docv:"DIR")

let with_breadcrumbs =
  let doc = "add breadcrumbs to the generated model" in
  Arg.(value & flag & info [ "with-breadcrumbs" ] ~doc)

let no_ite_for_select =
  let doc = "do not use ite for select" in
  Arg.(value & flag & info [ "no-ite-for-select" ] ~doc)

(* shared symbolic parameters *)

let symbolic_parameters default_entry_point =
  let+ deterministic_result_order
  and+ entry_point = entry_point default_entry_point
  and+ exploration_strategy
  and+ fail_mode
  and+ generate_abstract_invariant
  and+ model_format
  and+ model_out_file
  and+ invoke_with_symbols
  and+ no_assert_failure_expression_printing
  and+ no_ite_for_select
  and+ no_stop_at_failure
  and+ no_value
  and+ no_worker_isolation
  and+ seed
  and+ solver
  and+ timeout
  and+ timeout_instr
  and+ unsafe
  and+ with_breadcrumbs
  and+ workers
  and+ workspace in
  let use_ite_for_select = not no_ite_for_select in
  { Symbolic_parameters.deterministic_result_order
  ; entry_point
  ; exploration_strategy
  ; fail_mode
  ; generate_abstract_invariant
  ; invoke_with_symbols
  ; model_format
  ; model_out_file
  ; no_assert_failure_expression_printing
  ; no_stop_at_failure
  ; no_value
  ; no_worker_isolation
  ; seed
  ; solver
  ; timeout
  ; timeout_instr
  ; unsafe
  ; use_ite_for_select
  ; with_breadcrumbs
  ; workers
  ; workspace
  }

(* owi c *)
module C = struct
  module Fuzz = struct
    let cmd =
      let+ arch
      and+ property =
        let doc = "property file" in
        Arg.(
          value
          & opt (some existing_file_conv) None
          & info [ "property" ] ~doc ~docv:"FILE" )
      and+ includes
      and+ opt_lvl
      and+ testcomp =
        let doc = "test-comp mode" in
        Arg.(value & flag & info [ "testcomp" ] ~doc)
      and+ files
      and+ () = setup_log
      and+ eacsl =
        let doc =
          "e-acsl mode, refer to \
           https://frama-c.com/download/e-acsl/e-acsl-implementation.pdf for \
           Frama-C's current language feature implementations"
        in
        Arg.(value & flag & info [ "e-acsl" ] ~doc)
      and+ out_file
      and+ unsafe
      and+ rounds
      and+ timeout
      and+ timeout_instr
      and+ () = setup_log
      and+ seed
      and+ workspace
      and+ entry_point = entry_point (Some "main") in

      Cmd_c_fuzz.cmd ~rounds ~seed ~workspace ~entry_point ~arch ~property
        ~testcomp ~opt_lvl ~includes ~files ~eacsl ~out_file ~timeout
        ~timeout_instr ~unsafe
  end

  (* owi c sym *)
  module Sym = struct
    let cmd =
      let+ arch
      and+ property =
        let doc = "property file" in
        Arg.(
          value
          & opt (some existing_file_conv) None
          & info [ "property" ] ~doc ~docv:"FILE" )
      and+ includes
      and+ opt_lvl
      and+ testcomp =
        let doc = "test-comp mode" in
        Arg.(value & flag & info [ "testcomp" ] ~doc)
      and+ files
      and+ () = setup_log
      and+ eacsl =
        let doc =
          "e-acsl mode, refer to \
           https://frama-c.com/download/e-acsl/e-acsl-implementation.pdf for \
           Frama-C's current language feature implementations"
        in
        Arg.(value & flag & info [ "e-acsl" ] ~doc)
      and+ out_file
      and+ symbolic_parameters = symbolic_parameters (Some "main") in

      Cmd_c_sym.cmd ~symbolic_parameters ~arch ~property ~includes ~opt_lvl
        ~out_file ~testcomp ~files ~eacsl
  end
end

(* owi c++ *)
module Cpp = struct
  (* owi c++ sym *)
  module Sym = struct
    let cmd =
      let+ arch
      and+ includes
      and+ opt_lvl
      and+ files
      and+ out_file
      and+ () = setup_log
      and+ symbolic_parameters = symbolic_parameters (Some "main") in

      Cmd_cpp_sym.cmd ~symbolic_parameters ~out_file ~arch ~includes ~opt_lvl
        ~files
  end
end

(* owi haskell *)
module Haskell = struct
  (* owi haskell sym *)
  module Sym = struct
    let cmd =
      let+ files
      and+ out_file
      and+ () = setup_log
      and+ symbolic_parameters = symbolic_parameters (Some "_start") in
      Cmd_haskell_sym.cmd ~symbolic_parameters ~files ~out_file
  end
end

(* owi llvm *)
module Llvm = struct
  (* owi llvm sym *)
  module Sym = struct
    let cmd =
      let+ files
      and+ out_file
      and+ () = setup_log
      and+ symbolic_parameters = symbolic_parameters None in
      Cmd_llvm_sym.cmd ~symbolic_parameters ~files ~out_file
  end
end

(* owi rust *)
module Rust = struct
  (* owi rust sym *)
  module Sym = struct
    let cmd =
      let+ arch
      and+ includes
      and+ opt_lvl
      and+ files
      and+ out_file
      and+ () = setup_log
      and+ symbolic_parameters = symbolic_parameters (Some "main") in

      Cmd_rust_sym.cmd ~symbolic_parameters ~arch ~opt_lvl ~includes ~files
        ~out_file
  end
end

(* owi go *)
module Go = struct
  (* owi go sym *)
  module Sym = struct
    let cmd =
      let+ files
      and+ out_file
      and+ () = setup_log
      and+ symbolic_parameters = symbolic_parameters (Some "_start") in
      Cmd_go_sym.cmd ~symbolic_parameters ~files ~out_file
  end
end

(* owi version *)
module Version = struct
  let cmd =
    let+ () = Term.const ()
    and+ () = setup_log in
    Cmd_version.cmd ()
end

(* owi wasm *)

module Wasm = struct
  (* owi wasm abs *)
  module Abs = struct
    let cmd =
      let+ source_file
      and+ () = setup_log
      and+ entry_point = entry_point None
      and+ unsafe in
      Cmd_wasm_abs.cmd ~source_file ~entry_point ~unsafe
  end

  (* owi wasm analyze *)
  module Analyze = struct
    (* owi wasm analyze cfg *)
    module Cfg = struct
      let cmd =
        let+ source_file
        and+ entry_point = entry_point None
        and+ () = setup_log in
        Cmd_wasm_analyze_cfg.cmd ~source_file ~entry_point
    end

    (* owi wasm analyze cg *)
    module Cg = struct
      let cmd =
        let+ call_graph_mode
        and+ source_file
        and+ entry_point = entry_point None
        and+ () = setup_log in
        Cmd_wasm_analyze_cg.cmd ~call_graph_mode ~source_file ~entry_point
    end
  end

  (* owi wasm fmt *)
  module Fmt = struct
    let cmd =
      let+ inplace =
        let doc = "Format in-place, overwriting input file" in
        Arg.(value & flag & info [ "inplace"; "i" ] ~doc)
      and+ files
      and+ () = setup_log in
      Cmd_wasm_fmt.cmd ~inplace ~files
  end

  (* owi wasm fuzz *)
  module Fuzz = struct
    let cmd =
      let+ unsafe
      and+ entry_point = entry_point None
      and+ rounds
      and+ timeout
      and+ timeout_instr
      and+ () = setup_log
      and+ seed
      and+ source_file in
      Cmd_wasm_fuzz.cmd ~entry_point ~rounds ~seed ~source_file ~timeout
        ~timeout_instr ~unsafe
  end

  (* owi wasm instrument *)
  module Instrument = struct
    (* owi wasm instrument label *)
    module Label = struct
      let cmd =
        let+ unsafe
        and+ coverage_criteria
        and+ () = setup_log
        and+ source_file in
        Cmd_wasm_instrument_label.cmd ~unsafe ~source_file ~coverage_criteria
    end
  end

  (* owi wasm iso *)
  module Iso = struct
    let cmd =
      (* TODO: this is actually almost `symbolic_parameters` (with `entry_point` removed), we should use it... it'll simplify the signature a lot! *)
      let+ deterministic_result_order
      and+ fail_mode
      and+ exploration_strategy
      and+ files
      and+ model_format
      and+ no_assert_failure_expression_printing
      and+ no_stop_at_failure
      and+ no_value
      and+ () = setup_log
      and+ seed
      and+ solver
      and+ unsafe
      and+ workers
      and+ no_worker_isolation
      and+ model_out_file
      and+ with_breadcrumbs
      and+ workspace in

      Cmd_wasm_iso.cmd ~deterministic_result_order ~fail_mode
        ~exploration_strategy ~files ~model_format
        ~no_assert_failure_expression_printing ~no_stop_at_failure ~no_value
        ~seed ~solver ~unsafe ~workers ~no_worker_isolation ~workspace
        ~model_out_file ~with_breadcrumbs
  end

  (* owi wasm replay *)
  module Replay = struct
    let cmd =
      let+ unsafe
      and+ replay_file =
        let doc = "Which replay file to use" in
        Arg.(
          required
          & opt (some existing_file_conv) None
          & info [ "replay-file" ] ~doc ~docv:"FILE" )
      and+ () = setup_log
      and+ source_file
      and+ invoke_with_symbols
      and+ entry_point = entry_point None in
      Cmd_wasm_replay.cmd ~unsafe ~replay_file ~source_file ~entry_point
        ~invoke_with_symbols
  end

  (* owi wasm run *)
  module Run = struct
    let cmd =
      let+ unsafe
      and+ timeout
      and+ timeout_instr
      and+ () = setup_log
      and+ source_file in
      Cmd_wasm_run.cmd ~unsafe ~timeout ~timeout_instr ~source_file
  end

  (* owi wasm script *)
  module Script = struct
    (* owi wasm script abstract *)
    module Abstract = struct
      let cmd =
        let+ files
        and+ () = setup_log
        and+ no_exhaustion =
          let doc = "no exhaustion tests" in
          Arg.(value & flag & info [ "no-exhaustion" ] ~doc)
        in
        Cmd_wasm_script.cmd_abstract ~files ~no_exhaustion
    end

    (* owi wasm script concrete *)
    module Concrete = struct
      let cmd =
        let+ files
        and+ () = setup_log
        and+ no_exhaustion =
          let doc = "no exhaustion tests" in
          Arg.(value & flag & info [ "no-exhaustion" ] ~doc)
        in
        Cmd_wasm_script.cmd_concrete ~files ~no_exhaustion
    end

    (* owi wasm script symbolic *)
    module Symbolic = struct
      let cmd =
        let+ files
        and+ () = setup_log
        and+ no_exhaustion =
          let doc = "no exhaustion tests" in
          Arg.(value & flag & info [ "no-exhaustion" ] ~doc)
        in
        Cmd_wasm_script.cmd_symbolic ~files ~no_exhaustion
    end
  end

  (* owi wasm sym *)
  module Sym = struct
    let cmd =
      let+ source_file
      and+ () = setup_log
      and+ parameters = symbolic_parameters None in
      Cmd_wasm_sym.cmd ~parameters ~source_file
  end

  (* owi wasm to_wat *)
  module To_wat = struct
    let cmd =
      let+ source_file
      and+ emit_file =
        let doc = "Emit (.wat) files from corresponding (.wasm) files." in
        Arg.(value & flag & info [ "emit-file" ] ~doc)
      and+ () = setup_log
      and+ out_file in
      Cmd_wasm_to_wat.cmd ~source_file ~emit_file ~out_file
  end

  (* owi wasm of_wat *)
  module Of_wat = struct
    let cmd =
      let+ unsafe
      and+ out_file
      and+ () = setup_log
      and+ source_file in
      Cmd_wasm_of_wat.cmd ~unsafe ~out_file ~source_file
  end

  (* owi wasm validate *)
  module Validate = struct
    let cmd =
      let+ files
      and+ () = setup_log in
      Cmd_wasm_validate.cmd ~files
  end
end

(* owi zig *)
module Zig = struct
  (* owi zig sym *)
  module Sym = struct
    let cmd =
      let+ includes
      and+ files
      and+ out_file
      and+ () = setup_log
      and+ symbolic_parameters = symbolic_parameters (Some "_start") in
      Cmd_zig_sym.cmd ~symbolic_parameters ~includes ~files ~out_file
  end
end

(* owi *)

let info name doc = Cmd.info name ~doc ~version ~sdocs ~man:shared_man

let default =
  Term.(ret (const (fun (_ : _ list) -> `Help (`Plain, None)) $ copts_t))

let group name doc group = Cmd.group ~default (info name doc) group

let cmd name doc cmd = Cmd.v (info name doc) cmd

let cli =
  let owi_info =
    let doc =
      "Seamless program analysis for C, C++, Go, Haskell, LLVM, Rust, Wasm and \
       Zig."
    in
    let man =
      [ `S Manpage.s_bugs; `P "Email them to <owi.wildcat119@passmail.com>." ]
    in
    Cmd.info "owi" ~version ~doc ~sdocs ~man
  in

  Cmd.group ~default owi_info
    [ group "c" "Work with C programs."
        [ cmd "fuzz" "Run the fuzzer." C.Fuzz.cmd
        ; cmd "sym" "Run the symbolic execution engine on a C program."
            C.Sym.cmd
        ]
    ; group "c++" "Work with C++ programs."
        [ cmd "sym" "Run the symbolic execution engine on a C++ program."
            Cpp.Sym.cmd
        ]
    ; group "go" "Work with Go programs."
        [ cmd "sym" "Run the symbolic execution engine on a Go program."
            Go.Sym.cmd
        ]
    ; group "haskell" "Work with Haskell programs."
        [ cmd "sym" "Run the symbolic execution engine on a Haskell program."
            Haskell.Sym.cmd
        ]
    ; group "llvm" "Work with LLVM programs."
        [ cmd "sym" "Run the symbolic execution engine on a LLVM program."
            Llvm.Sym.cmd
        ]
    ; group "rust" "Work with Rust programs."
        [ cmd "sym" "Run the symbolic execution engine on a Rust program."
            Rust.Sym.cmd
        ]
    ; cmd "version" "Print some version informations." Version.cmd
    ; group "wasm" "Work with Wasm programs."
        [ cmd "abs" "Run the abstract interpreter." Wasm.Abs.cmd
        ; group "analyze" "Visualize and get statistics."
            [ cmd "cg" "Build a call graph." Wasm.Analyze.Cg.cmd
            ; cmd "cfg" "Build a control-flow graph." Wasm.Analyze.Cfg.cmd
            ]
        ; cmd "fmt" "Format a .wat or .wast file." Wasm.Fmt.cmd
        ; cmd "fuzz" "Run the fuzzer." Wasm.Fuzz.cmd
        ; group "instrument" "Instrument a program in various ways."
            [ cmd "label"
                "Generate an instrumented file with labels corresponding to \
                 test objectives for a given coverage criteria."
                Wasm.Instrument.Label.cmd
            ]
        ; cmd "iso"
            "Check the iso-functionnality of two modules by comparing the \
             output when calling their exports."
            Wasm.Iso.cmd
        ; cmd "replay"
            "Replay a module by replacing symbols with concrete values from a \
             model."
            Wasm.Replay.cmd
        ; cmd "run" "Run the concrete interpreter." Wasm.Run.cmd
        ; group "script" "Run a reference test suite script (.wast)."
            [ cmd "concrete"
                "Run a reference test suite (.wast) using the concrete \
                 interpreter."
                Wasm.Script.Concrete.cmd
            ; cmd "symbolic"
                "Run a reference test suite (.wast) using the symbolic \
                 interpreter."
                Wasm.Script.Symbolic.cmd
            ; cmd "abstract"
                "Run a reference test suite (.wast) using the abstract \
                 interpreter."
                Wasm.Script.Abstract.cmd
            ]
        ; cmd "sym" "Run the symbolic execution engine." Wasm.Sym.cmd
        ; cmd "validate" "Validate a module." Wasm.Validate.cmd
        ; cmd "to_wat" "Generate a text file (.wat) from a binary file (.wasm)."
            Wasm.To_wat.cmd
        ; cmd "of_wat" "Generate a binary file (.wasm) from a text file (.wat)."
            Wasm.Of_wat.cmd
        ]
    ; group "zig" "Work with Zig programs."
        [ cmd "sym" "Run the symbolic execution engine on a Zig program."
            Zig.Sym.cmd
        ]
    ]

let exit_code =
  let open Cmd.Exit in
  match Cmd.eval_value cli with
  | Ok (`Help | `Version) -> ok
  | Ok (`Ok result) ->
    begin match result with
    | Ok () -> ok
    | Error e -> begin
      Log.err (fun m -> m "%s" (Result.err_to_string e));
      Result.err_to_exit_code e
      end
    end
  | Error (`Parse | `Term) -> cli_error
  | Error `Exn -> internal_error

let () = exit exit_code