compile with -safe-string

Summary: public so that we don't introduce more string mutations in the future.

Reviewed By: jberdine

Differential Revision: D2729167

fb-gh-sync-id: 746319a

configure.ac

@@ -54,13 +54,11 @@ AC_ASSERT_OCAML_PKG([easy-format])
 AC_ASSERT_OCAML_PKG([ptrees])
 AC_ASSERT_OCAML_PKG([yojson])
 
-OCAMLVERSION_MAJOR=$(printf $OCAMLVERSION | cut -d . -f 1)
+AC_OCAML_CHECK_NATIVE_BYTES
-OCAMLVERSION_MINOR=$(printf $OCAMLVERSION | cut -d . -f 2)
+AC_OCAMLC_CHECK_SAFE_STRING
 
-OCAML_PKG_bytes=no
+if test "$OCAML_HAS_NATIVE_BYTES" = "no"; then
-# need the bytes package for OCaml version < 4.02.0
+  AC_ASSERT_OCAML_PKG([bytes])
-if test "$OCAMLVERSION_MAJOR" -le 4 && test "$OCAMLVERSION_MINOR" -lt 2; then
-AC_ASSERT_OCAML_PKG([bytes])
 fi
 
 AC_CHECK_TOOL([ATDGEN], [atdgen], [no])

infer/src/Makefile.in

@@ -44,9 +44,9 @@ OCAML_LIBS = unix str atdgen
 OCAML_MODS = easy_format bi_util bi_share bi_outbuf bi_inbuf bi_vint bi_io yojson ag_oj_run ag_ob_run ag_util
 
 # backwards compatibility with OCaml version < 4.02.0
-ifneq (@OCAML_PKG_bytes@,no)
+ifeq (@OCAML_HAS_NATIVE_BYTES@,no)
-BYTES_INCLUDE_DIR = @OCAML_PKG_PATH_bytes@
+OCAML_INCLUDES := $(OCAML_INCLUDES),-I,@OCAML_PKG_PATH_bytes@
-OCAML_INCLUDES := $(OCAML_INCLUDES),-I,$(BYTES_INCLUDE_DIR)
+OCAML_LIBS += bytes
 endif
 
 OCAMLBUILD_OPTIONS = -lflags -annot \
@@ -56,6 +56,10 @@ OCAMLBUILD_OPTIONS = -lflags -annot \
                      $(addprefix -lib ,$(OCAML_LIBS)) \
                      $(addprefix -mod ,$(OCAML_MODS))
 
+ifeq (@OCAMLC_HAS_SAFE_STRING@,yes)
+OCAMLBUILD_OPTIONS += -cflags -safe-string
+endif
+
 #### Backend declarations ####
 
 BACKEND_SOURCES = backend

infer/src/backend/DB.ml

@@ -234,8 +234,8 @@ let update_file_with_lock dir fname update =
   let buf = read_whole_file fd in
   reset_file fd;
   let str = update buf in
-  let i = Unix.write fd str 0 (String.length str) in
+  let i = Unix.write fd str 0 (Bytes.length str) in
-  if (i = (String.length str))
+  if (i = (Bytes.length str))
   then (Unix.lockf fd Unix.F_ULOCK 0; Unix.close fd)
   else (L.err "@.save_with_lock: fail on path: %s@." path;
         assert false)

infer/src/backend/DB.mli

@@ -133,13 +133,13 @@ val find_source_dirs : unit -> source_dir list
 val create_dir : string -> unit
 
 (** Read a file using a lock to allow write attempts in parallel. *)
-val read_file_with_lock : string -> string -> string option
+val read_file_with_lock : string -> string -> Bytes.t option
 
 (** Update the file contents with the update function provided.
     If the directory does not exist, it is created.
     If the file does not exist, it is created, and update is given the empty string.
     A lock is used to allow write attempts in parallel. *)
-val update_file_with_lock : string -> string -> (string -> string) -> unit
+val update_file_with_lock : string -> string -> (Bytes.t -> Bytes.t) -> unit
 
 (** get the path of the global type environment (only used in Java) *)
 val global_tenv_fname : unit -> filename

infer/src/backend/dotty.ml

@@ -108,15 +108,16 @@ let exp_is_neq_zero e =
 (* replace a dollar sign in a name with a D. We need this because dotty get confused if there is*)
 (* a dollar sign i a label*)
 let strip_special_chars s =
+  let b = Bytes.of_string s in
   let replace st c c' =
-    if String.contains st c then begin
+    if Bytes.contains st c then begin
-      let idx = String.index st c in
+      let idx = Bytes.index st c in
       try
         Bytes.set st idx c';
         st
       with Invalid_argument _ -> L.out "@\n@\n Invalid argument!!! @\n @.@.@."; assert false
     end else st in
-  let s0 = replace s '(' 'B' in
+  let s0 = replace b '(' 'B' in
   let s1 = replace s0 '$' 'D' in
   let s2 = replace s1 '#' 'H' in
   let s3 = replace s2 '&' 'E' in
@@ -124,7 +125,7 @@ let strip_special_chars s =
   let s5 = replace s4 ')' 'B' in
   let s6 = replace s5 '+' 'P' in
   let s7 = replace s6 '-' 'M' in
-  s7
+  Bytes.to_string s7
 
 let rec strexp_to_string pe coo f se =
   match se with

infer/src/checkers/codeQuery.ml

@@ -28,7 +28,8 @@ let parse_query s =
         query
   with
   | Parsing.Parse_error ->
-      L.stdout "@.parsing stops on line %d: \n\n%s@." !CodequeryLexer.line_number buf.Lexing.lex_buffer;
+      let lexbuf = Bytes.to_string buf.Lexing.lex_buffer in
+      L.stdout "@.parsing stops on line %d: \n\n%s@." !CodequeryLexer.line_number lexbuf;
       assert false
 
 let query_ast =

infer/src/checkers/models.ml

@@ -40,22 +40,22 @@ module Inference = struct
 
   let update_count_str s_old =
     let n =
-      if s_old = "" then 0
+      if s_old = Bytes.empty then 0
-      else try int_of_string s_old with
+      else try int_of_string (Bytes.to_string s_old) with
         | Failure _ ->
-            L.stderr "int_of_string %s@." s_old;
+            L.stderr "int_of_string %s@." (Bytes.to_string s_old);
             assert false in
-    string_of_int (n + 1)
+    Bytes.of_string (string_of_int (n + 1))
 
   let update_boolvec_str _s size index bval =
-    let s = if _s = "" then String.make size '0' else _s in
+    let s = if _s = Bytes.empty then Bytes.make size '0' else _s in
     Bytes.set s index (if bval then '1' else '0');
     s
 
   let mark_file update_str dir fname =
     DB.update_file_with_lock dir fname update_str;
     match DB.read_file_with_lock dir fname with
-    | Some buf -> L.stderr "Read %s: %s@." fname buf
+    | Some buf -> L.stderr "Read %s: %s@." fname (Bytes.to_string buf)
     | None -> L.stderr "Read %s: None@." fname
 
   let mark_file_count = mark_file update_count_str
@@ -88,7 +88,7 @@ module Inference = struct
     | None -> None
     | Some buf ->
         let boolvec = ref [] in
-        String.iter (fun c -> boolvec := (c = '1') :: !boolvec) buf;
+        Bytes.iter (fun c -> boolvec := (c = '1') :: !boolvec) buf;
         Some (IList.rev !boolvec)
 end (* Inference *)
 

m4/ac_ocaml_check_native_bytes.m4

@@ -0,0 +1,22 @@
+dnl Copyright (c) 2015 - present Facebook, Inc.
+dnl All rights reserved.
+dnl
+dnl This source code is licensed under the BSD style license found in the
+dnl LICENSE file in the root directory of this source tree. An additional grant
+dnl of patent rights can be found in the PATENTS file in the same directory.
+
+AC_DEFUN([AC_OCAML_CHECK_NATIVE_BYTES],
+[dnl
+  OCAML_HAS_NATIVE_BYTES=no
+  AC_MSG_CHECKING([if OCaml supports the native 'bytes' type])
+  cat > conftest.ml <<EOF
+  let b:bytes = Bytes.create 4
+EOF
+  if $OCAMLC -c conftest.ml >&5 2>&5 ; then
+    AC_MSG_RESULT([yes])
+    OCAML_HAS_NATIVE_BYTES=yes
+  else
+    AC_MSG_RESULT([no])
+  fi
+  AC_SUBST([OCAML_HAS_NATIVE_BYTES])
+])

m4/ac_ocaml_check_safe_string.m4

@@ -0,0 +1,20 @@
+dnl Copyright (c) 2015 - present Facebook, Inc.
+dnl All rights reserved.
+dnl
+dnl This source code is licensed under the BSD style license found in the
+dnl LICENSE file in the root directory of this source tree. An additional grant
+dnl of patent rights can be found in the PATENTS file in the same directory.
+
+AC_DEFUN([AC_OCAMLC_CHECK_SAFE_STRING],
+[dnl
+  OCAMLC_HAS_SAFE_STRING=no
+  AC_MSG_CHECKING([if $OCAMLC supports the '-safe-string' flag])
+  printf "" > conftest.ml
+  if $OCAMLC -safe-string -c conftest.ml >&5 2>&5 ; then
+    AC_MSG_RESULT([yes])
+    OCAMLC_HAS_SAFE_STRING=yes
+  else
+    AC_MSG_RESULT([no])
+  fi
+  AC_SUBST([OCAMLC_HAS_SAFE_STRING])
+])