CS153/hw2/lib/util/platform.ml

(* -------------------------------------------------------------------------- *)
(** Assembling and linking for X86.  Depends on the underlying OS platform    *)

open Printf
open Unix

exception PlatformError of string * string

(* paths -------------------------------------------------------------------- *)
let path_sep = "/"

let bin_path = "./bin"

let dot_path = "./"

let executable_name = ref "a.out"

let output_path = ref "output"

let libs = ref []

let lib_paths = ref []

let lib_search_paths = ref []

let include_paths = ref []

(* unix utility scripts ----------------------------------------------------- *)
let pp_cmd = ref "cpp -E "

let rm_cmd = ref "rm -rf "

(* -------------------------------------------------------------------------- *)
(* Platform specific configuration: Unix/Linux vs. Mac OS X                   *)

let os =
  let ic = Unix.open_process_in "uname -s" in
  let uname = input_line ic in
  let () = close_in ic in
  uname

let cpu = 
  let ic = Unix.open_process_in "uname -m" in
  let cpuname = input_line ic in
  let () = close_in ic in
  cpuname

(* One of "Darwin" or "Linux" *)

let linux = ref false

let mangle name = if !linux then name else "_" ^ name

let osx_target_triple = "x86_64-apple-macosx10.13.0"

let linux_target_triple = "x86_64-unknown-linux"

let target_triple = ref osx_target_triple

let platform_flags = ref ""

(* Set the link commands properly, ensure output directory exists *)
let configure_os () =
  if os = "Linux"
  then (
    linux := true ;
    target_triple := linux_target_triple ;
    platform_flags := "" )
  else if os = "Darwin"
  then (
    linux := false ;
    target_triple := osx_target_triple ;
    platform_flags := "-fno-asynchronous-unwind-tables -mstackrealign" )
  else failwith @@ "Unsupported OS detected: " ^ os


(* verbose compiler output -------------------------------------------------- *)
let verbose = ref false

let verb msg =
  if !verbose
  then (
    print_string msg ;
    flush Stdlib.stdout )


let verb_os () =
  verb
  @@ Printf.sprintf
       "* PLATFORM: %s TRIPLE: %s FLAGS %s\n"
       os
       !target_triple
       !platform_flags


let enable_verbose () =
  verbose := true ;
  verb_os ()


(* create the output directory, which is assumed to exist *)
let create_output_dir () =
  try ignore (stat !output_path) with
  | Unix_error (ENOENT, _, _) ->
      verb @@ Printf.sprintf "creating output directory: %s\n" !output_path ;
      mkdir !output_path 0o755


(* clang invocation stuff --------------------------------------------------- *)
let common_flags = "-Wno-override-module"

let link_flags = "-Wno-unused-command-line-argument -mstackrealign"

let clang_ll_mode = "-S"

let as_mode = "-c"

let rosetta_prefix = "arch -x86_64 "

let prefix = if cpu = "arm64" then rosetta_prefix else ""

let opt_level = ref "-O1 -Wall"

let clang args = Printf.sprintf "%sclang %s -o " prefix (String.concat " " args)

let clang_cmd () =
  clang [ clang_ll_mode; !opt_level; common_flags; !platform_flags ]


let as_cmd () = clang [ as_mode; !opt_level; common_flags; !platform_flags ]

let link_cmd () = clang [ common_flags; !opt_level; !platform_flags; link_flags ]

(* filename munging --------------------------------------------------------- *)
let path_to_basename_ext (path : string) : string * string =
  (* The path is of the form ... "foo/bar/baz/<file>.ext" *)
  let paths = Str.split (Str.regexp_string path_sep) path in
  let _ =
    if List.length paths = 0 then failwith @@ sprintf "bad path: %s" path
  in
  let filename = List.hd (List.rev paths) in
  match Str.split (Str.regexp_string ".") filename with
  | [ root ] ->
      (root, "")
  | [ root; ext ] ->
      (root, ext)
  | _ ->
      failwith @@ sprintf "bad filename: %s" filename


(* compilation and shell commands-------------------------------------------- *)

(* Platform independent shell command *)
let sh (cmd : string) (ret : string -> int -> 'a) : 'a =
  verb (sprintf "* %s\n" cmd) ;
  match system cmd with
  | WEXITED i ->
      ret cmd i
  | WSIGNALED i ->
      raise (PlatformError (cmd, sprintf "Signaled with %d." i))
  | WSTOPPED i ->
      raise (PlatformError (cmd, sprintf "Stopped with %d." i))

(* Platform independent shell command with a timeout (in seconds) *)
let timeout_sh (time: int)(cmd : string) (ret : string -> int -> 'a) : 'a =
  let timeout_cmd = sprintf "%s/timeout3 -t %d %s" bin_path time cmd in
  verb (sprintf "* %s\n" timeout_cmd) ;
  match system timeout_cmd with
  | WEXITED i ->
      ret cmd i
  | WSIGNALED i ->
      if i == Sys.sigterm
      then raise (PlatformError (cmd, sprintf "Timed-out after %d s" time))
      else raise (PlatformError (cmd, sprintf "Signaled with %d." i))
  | WSTOPPED i ->
      raise (PlatformError (cmd, sprintf "Stopped with %d." i))


(* Generate a file name that does not already exist.
   basedir includes the path separator
*)
let gen_name (basedir : string) (basen : string) (baseext : string) : string =
  let rec nocollide ofs =
    let nfn =
      sprintf
        "%s/%s%s%s"
        basedir
        basen
        (if ofs = 0 then "" else "_" ^ string_of_int ofs)
        baseext
    in
    try
      ignore (stat nfn) ;
      nocollide (ofs + 1)
    with
    | Unix_error (ENOENT, _, _) ->
        nfn
  in
  nocollide 0


let raise_error cmd i =
  if i <> 0 then raise (PlatformError (cmd, sprintf "Exited with status %d." i))


let ignore_error _ _ = ()

let preprocess (dot_oat : string) (dot_i : string) : unit =
  sh
    (sprintf
       "%s%s %s %s"
       !pp_cmd
       (List.fold_left (fun s i -> s ^ " -I" ^ i) "" !include_paths)
       dot_oat
       dot_i)
    raise_error


let clang_compile (dot_ll : string) (dot_s : string) : unit =
  sh (sprintf "%s%s %s" (clang_cmd ()) dot_s dot_ll) raise_error


let assemble (dot_s : string) (dot_o : string) : unit =
  sh (sprintf "%s%s %s" (as_cmd ()) dot_o dot_s) raise_error


let link (mods : string list) (out_fn : string) : unit =
  sh
    (sprintf
       "%s%s %s %s %s %s"
       (link_cmd ())
       out_fn
       (String.concat " " (mods @ !lib_paths))
       (List.fold_left (fun s i -> s ^ " -L" ^ i) "" !lib_search_paths)
       (List.fold_left (fun s i -> s ^ " -I" ^ i) "" !include_paths)
       (List.fold_left (fun s l -> s ^ " -l" ^ l) "" !libs))
    raise_error