[sledge] Improve the option and file naming of binary vs text llair output

Summary:
Change `-llair-output` to `-output`, for binary form, and
`-llair-txt-output` to `-llair-output`, for textual form. Also
correspondingly change `.llair` to `.bllair`, for binary, and
`.llair.txt` to `.llair` for text.

This improves command line argument completion, and makes `.llair` the
extension of the files most commonly interacted with.

Reviewed By: ngorogiannis

Differential Revision: D24951506

fbshipit-source-id: ad4c73ca2

sledge/cli/sledge_cli.ml

@@ -154,15 +154,15 @@ let analyze_cmd =
   command ~summary ~readme param
 
 let disassemble =
-  let%map_open llair_txt_output =
-    flag "llair-txt-output" (optional string)
+  let%map_open llair_output =
+    flag "llair-output" (optional string)
       ~doc:
         "<file> write generated textual LLAIR to <file>, or to standard \
          output if omitted"
   in
   fun program () ->
     let pgm = program () in
-    ( match llair_txt_output with
+    ( match llair_output with
     | None -> Format.printf "%a@." Llair.Program.pp pgm
     | Some file ->
         Out_channel.with_file file ~f:(fun oc ->
@@ -182,9 +182,9 @@ let disassemble_cmd =
   command ~summary ~readme param
 
 let translate =
-  let%map_open llair_output =
-    flag "llair-output" (optional string)
-      ~doc:"<file> write generated LLAIR to <file>"
+  let%map_open output =
+    flag "output" (optional string)
+      ~doc:"<file> write generated binary LLAIR to <file>"
   and no_models =
     flag "no-models" no_arg
       ~doc:"do not add models for C/C++ runtime and standard libraries"
@@ -201,7 +201,7 @@ let translate =
       Frontend.translate ~models:(not no_models) ~fuzzer
         ~internalize:(not no_internalize) bitcode_inputs
     in
-    Option.iter ~f:(marshal program) llair_output ;
+    Option.iter ~f:(marshal program) output ;
     program
 
 let llvm_grp =

sledge/sledge-help.txt

@@ -51,12 +51,11 @@ Analyze code in a buck target. This is a convenience wrapper for the sequence `s
   [-bound <int>]         stop execution exploration at depth <int>
   [-colors]              enable printing in colors
   [-domain <string>]     select abstract domain; must be one of "sh" (default,
-                          symbolic heap domain), "globals" (used-globals
-                          domain), or "unit" (unit domain)
+                         symbolic heap domain), "globals" (used-globals domain),
+                         or "unit" (unit domain)
   [-exceptions]          explore executions that throw and handle exceptions
   [-function-summaries]  use function summaries (in development)
   [-fuzzer]              add a harness for libFuzzer targets
-  [-llair-output <file>]  write generated LLAIR to <file>
   [-margin <cols>]       wrap debug tracing at <cols> columns
   [-modules <file>]      write list of bitcode files to <file>, or to standard
                          output if <file> is `-`
@@ -65,6 +64,7 @@ Analyze code in a buck target. This is a convenience wrapper for the sequence `s
   [-no-models]           do not add models for C/C++ runtime and standard
                          libraries
   [-no-simplify-states]  do not simplify states during symbolic execution
+  [-output <file>]       write generated binary LLAIR to <file>
   [-preanalyze-globals]  pre-analyze global variables used by each function
   [-report <file>]       write report sexp to <file>, or to standard error if
                          "-"
@@ -149,18 +149,18 @@ Analyze code in one or more LLVM bitcode files. This is a convenience wrapper fo
   [-bound <int>]         stop execution exploration at depth <int>
   [-colors]              enable printing in colors
   [-domain <string>]     select abstract domain; must be one of "sh" (default,
-                          symbolic heap domain), "globals" (used-globals
-                          domain), or "unit" (unit domain)
+                         symbolic heap domain), "globals" (used-globals domain),
+                         or "unit" (unit domain)
   [-exceptions]          explore executions that throw and handle exceptions
   [-function-summaries]  use function summaries (in development)
   [-fuzzer]              add a harness for libFuzzer targets
-  [-llair-output <file>]  write generated LLAIR to <file>
   [-margin <cols>]       wrap debug tracing at <cols> columns
   [-no-internalize]      do not internalize all functions except the entry
                          points specified in the config file
   [-no-models]           do not add models for C/C++ runtime and standard
                          libraries
   [-no-simplify-states]  do not simplify states during symbolic execution
+  [-output <file>]       write generated binary LLAIR to <file>
   [-preanalyze-globals]  pre-analyze global variables used by each function
   [-report <file>]       write report sexp to <file>, or to standard error if
                          "-"
@@ -183,14 +183,12 @@ Translate one or more LLVM bitcode files to LLAIR. Each <input> filename may be
   [-append-report]   append to report file
   [-colors]          enable printing in colors
   [-fuzzer]          add a harness for libFuzzer targets
-  [-llair-output <file>]  write generated LLAIR to <file>
   [-margin <cols>]   wrap debug tracing at <cols> columns
-  [-no-internalize]       do not internalize all functions except the entry
-                          points specified in the config file
-  [-no-models]            do not add models for C/C++ runtime and standard
-                          libraries
-  [-report <file>]        write report sexp to <file>, or to standard error if
-                          "-"
+  [-no-internalize]  do not internalize all functions except the entry points
+                     specified in the config file
+  [-no-models]       do not add models for C/C++ runtime and standard libraries
+  [-output <file>]   write generated binary LLAIR to <file>
+  [-report <file>]   write report sexp to <file>, or to standard error if "-"
   [-trace <spec>]    enable debug tracing
   [-help]            print this help text and exit
                      (alias: -?)
@@ -209,16 +207,16 @@ The <input> file must be LLVM bitcode.
   [-append-report]        append to report file
   [-colors]               enable printing in colors
   [-fuzzer]               add a harness for libFuzzer targets
-  [-llair-output <file>]      write generated LLAIR to <file>
-  [-llair-txt-output <file>]  write generated textual LLAIR to <file>, or to
+  [-llair-output <file>]  write generated textual LLAIR to <file>, or to
                           standard output if omitted
   [-margin <cols>]        wrap debug tracing at <cols> columns
   [-no-internalize]       do not internalize all functions except the entry
                           points specified in the config file
   [-no-models]            do not add models for C/C++ runtime and standard
                           libraries
-  [-report <file>]            write report sexp to <file>, or to standard error
-                              if "-"
+  [-output <file>]        write generated binary LLAIR to <file>
+  [-report <file>]        write report sexp to <file>, or to standard error if
+                          "-"
   [-trace <spec>]         enable debug tracing
   [-help]                 print this help text and exit
                           (alias: -?)
@@ -265,11 +263,11 @@ The <input> file must be LLAIR code, as produced by `sledge llvm translate`.
 
   [-append-report]        append to report file
   [-colors]               enable printing in colors
-  [-llair-txt-output <file>]  write generated textual LLAIR to <file>, or to
+  [-llair-output <file>]  write generated textual LLAIR to <file>, or to
                           standard output if omitted
   [-margin <cols>]        wrap debug tracing at <cols> columns
-  [-report <file>]            write report sexp to <file>, or to standard error
-                              if "-"
+  [-report <file>]        write report sexp to <file>, or to standard error if
+                          "-"
   [-trace <spec>]         enable debug tracing
   [-help]                 print this help text and exit
                           (alias: -?)

sledge/test/Makefile

@@ -45,14 +45,14 @@ default: test
 %.ll : %.bc
 	@(cd $(@D) && llvm-dis -show-annotations -o $(@F) $(<F))
 
-%.llair : %.bc
-	$(SLEDGE_DBG) llvm translate $< -llair-output $@
+%.bllair : %.bc
+	$(SLEDGE_DBG) llvm translate $< -output $@
 
-%.llair.txt : %.bc
-	$(SLEDGE_DBG) llvm disassemble -no-models -no-internalize $< -llair-txt-output $@
+%.llair : %.bc
+	$(SLEDGE_DBG) llvm disassemble -no-models -no-internalize $< -llair-output $@
 
-%.llair.txt : %.ll
-	$(SLEDGE_DBG) llvm disassemble -no-models -no-internalize $< -llair-txt-output $@
+%.llair : %.ll
+	$(SLEDGE_DBG) llvm disassemble -no-models -no-internalize $< -llair-output $@
 
 # code to test sledge translate
 TranslateCs:=$(shell find -L {,local/}translate -name '*.c' 2>/dev/null)
@@ -210,7 +210,7 @@ warnings:
 	@find -L * -name '*.out' | xargs grep -h "Warning:" | sort
 
 test-translate:
-	-@find -L {,local/,extra/}translate -name "*.sexp" -or -name "*.out" -or -name '*.err' -or -name '*.llair' -or -name '*.llair.txt' -delete 2>/dev/null
+	-@find -L {,local/,extra/}translate -name "*.sexp" -or -name "*.out" -or -name '*.err' -or -name '*.bllair' -or -name '*.llair' -delete 2>/dev/null
 	-@$(MAKE) --no-print-directory translate
 	@$(MAKE) --no-print-directory translate-status
 
@@ -225,7 +225,7 @@ test-smt:
 	@$(MAKE) --no-print-directory smt-status
 
 test-llvm:
-	-@find -L {,local/,extra/}llvm -name "*.sexp" -or -name "*.out" -or -name '*.err' -or -name '*.llair' -delete 2>/dev/null
+	-@find -L {,local/,extra/}llvm -name "*.sexp" -or -name "*.out" -or -name '*.err' -or -name '*.bllair' -delete 2>/dev/null
 	-@$(MAKE) --no-print-directory llvm
 	@$(MAKE) --no-print-directory llvm-status
 
@@ -253,7 +253,7 @@ cleanbc:
 
 # remove result files
 cleanout:
-	@find -L * -not -path 'baseline/*' -name "*.sexp" -or -name "*.out" -or -name '*.err' -or -name '*.llair' -or -name '*.llair.txt' \
+	@find -L * -not -path 'baseline/*' -name "*.sexp" -or -name "*.out" -or -name '*.err' -or -name '*.bllair' -or -name '*.llair' \
 	 | xargs rm -f
 
 clean: cleanbc cleanout