package shell
Yet another implementation of fork&exec and related functionality
Install
Dune Dependency
Authors
Maintainers
Sources
v0.17.0.tar.gz
sha256=d6f76ca1c3e7fa523da5affe9c1ebb74fe17bec2a2f22c239746b72905bc5f61
doc/src/shell.unix_extended/unix_extended.ml.html
Source file unix_extended.ml
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
module Stable0 = struct open Core.Core_stable module Inet_port = struct module V1 = struct module T = struct type t = int [@@deriving compare, equal, hash] let of_int_exn x = if x > 0 && x < 65536 then x else failwith (Core.sprintf "%d is not a valid port number." x) ;; let to_int x = x include Sexpable.Of_sexpable.V1 (Int.V1) (struct type nonrec t = t let of_sexpable = of_int_exn let to_sexpable = to_int end) include Binable.Of_binable.V1 [@alert "-legacy"] (Int.V1) (struct type nonrec t = t let of_binable = of_int_exn let to_binable = to_int end) include (val Comparator.V1.make ~compare ~sexp_of_t) let%expect_test _ = print_string [%bin_digest: t]; [%expect {| 698cfa4093fe5e51523842d37b92aeac |}] ;; end include T include Comparable.V1.Make (T) end end end open Core open Poly module Unix = Core_unix open Unix module Time = Time_float_unix external raw_fork_exec : stdin:File_descr.t -> stdout:File_descr.t -> stderr:File_descr.t -> ?working_dir:string -> ?setuid:int -> ?setgid:int -> ?env:string array -> string -> string array -> Pid.t = "extended_ml_spawn_bc" "extended_ml_spawn" let raw_fork_exec ~stdin ~stdout ~stderr ?working_dir ?setuid ?setgid ?env prog argv = (* [spawn] is generally preferred: it seems better tested and more actively maintained. It also uses [vfork] so it's more efficient. For now we still must fall back to [extended_ml_spawn] for the case when [setuid] or [setgid] is requested, but we should completely switch to [spawn] when/if it supports that. *) match setuid, setgid with | None, None -> let env = Option.map ~f:(fun env -> Spawn.Env.of_list (Array.to_list env)) env in let cwd = Option.value_map ~default:Spawn.Working_dir.Inherit ~f:(fun cwd -> Path cwd) working_dir in let argv = Array.to_list argv in Pid.of_int (Spawn.spawn ?env ~cwd ~prog ~argv ~stdin ~stdout ~stderr ()) | Some _, _ | _, Some _ -> raw_fork_exec ~stdin ~stdout ~stderr ?working_dir ?setuid ?setgid ?env prog argv ;; module Env = struct open String.Map type t = string String.Map.t let empty : t = empty let get () = Array.fold (Unix.environment ()) ~init:empty ~f:(fun env str -> match String.lsplit2 ~on:'=' str with | Some (key, data) -> Map.set ~key ~data env | None -> failwithf "extended_unix.Env.get %S is not in the form of key=value" str ()) ;; let add ~key ~data env = if String.mem key '=' then failwithf "extended_unix.Env.add:variable to export in the environment %S contains an \ equal sign" key () else if String.mem key '\000' then failwithf "extended_unix.Env.add:variable to export in the environment %S contains an null \ character" key () else if String.mem data '\000' then failwithf "extended_unix.Env.add:value (%S) to export in the environment for %S contains \ an null character" data key () else Map.set ~key ~data (env : _ String.Map.t) ;; let to_string_array env = Map.to_alist (env : _ String.Map.t) |> List.map ~f:(fun (k, v) -> k ^ "=" ^ v) |> List.to_array ;; end let fork_exec ?(stdin = Unix.stdin) ?(stdout = Unix.stdout) ?(stderr = Unix.stderr) ?(path_lookup = true) ?env ?working_dir ?setuid ?setgid prog args = let env = Option.map env ~f:(fun e -> let init, l = match e with | `Extend l -> Env.get (), l | `Replace l -> Env.empty, l in List.fold_left l ~init ~f:(fun env (key, data) -> Env.add ~key ~data env) |> Env.to_string_array) and full_prog = if path_lookup then ( match Shell_internal.which prog with | Some s -> s | None -> failwithf "fork_exec: File not found %s" prog ()) else prog in raw_fork_exec ~stdin ~stdout ~stderr ?working_dir ?setuid ?setgid ?env full_prog (Array.of_list (prog :: args)) ;; external seteuid : int -> unit = "extended_ml_seteuid" external setreuid : uid:int -> euid:int -> unit = "extended_ml_setreuid" external htonl : Int32.t -> Int32.t = "extended_ml_htonl" external ntohl : Int32.t -> Int32.t = "extended_ml_ntohl" let%test _ = htonl (ntohl 0xdeadbeefl) = 0xdeadbeefl type statvfs = { bsize : int (** file system block size *) ; frsize : int (** fragment size *) ; blocks : int (** size of fs in frsize units *) ; bfree : int (** # free blocks *) ; bavail : int (** # free blocks for non-root *) ; files : int (** # inodes *) ; ffree : int (** # free inodes *) ; favail : int (** # free inodes for non-root *) ; fsid : int (** file system ID *) ; flag : int (** mount flags *) ; namemax : int (** maximum filename length *) } [@@deriving sexp, bin_io] (** get file system statistics *) external statvfs : string -> statvfs = "statvfs_stub" (** get load averages *) external getloadavg : unit -> float * float * float = "getloadavg_stub" module Extended_passwd = struct open Passwd let of_passwd_line_exn s = match String.split s ~on:':' with | [ name; passwd; uid; gid; gecos; dir; shell ] -> { name ; passwd ; uid = Int.of_string uid ; gid = Int.of_string gid ; gecos ; dir ; shell } | _ -> failwithf "of_passwd_line: failed to parse: %s" s () ;; let of_passwd_line s = Option.try_with (fun () -> of_passwd_line_exn s) let of_passwd_file_exn fn = Exn.protectx (In_channel.create fn) ~f:(fun chan -> List.map (In_channel.input_lines chan) ~f:of_passwd_line_exn) ~finally:In_channel.close ;; let of_passwd_file f = Option.try_with (fun () -> of_passwd_file_exn f) end let strptime = Core_unix.strptime module Inet_port = struct module Stable = Stable0.Inet_port module T = struct type t = int [@@deriving compare, equal, hash] type comparator_witness = Stable.V1.comparator_witness let comparator = Stable.V1.comparator let sexp_of_t = Stable.V1.sexp_of_t end include T let of_int_exn = Stable.V1.of_int_exn let of_int x = try Some (of_int_exn x) with | _ -> None ;; let of_string_exn x = Int.of_string x |> of_int_exn let of_string x = try Some (of_string_exn x) with | _ -> None ;; let to_string x = Int.to_string x let to_int x = x let arg_type = Command.Spec.Arg_type.create of_string_exn include Comparable.Make_plain_using_comparator (T) end let%test _ = Inet_port.of_string "88" = Some 88 let%test _ = Inet_port.of_string "2378472398572" = None let%test _ = Inet_port.of_int 88 = Some 88 let%test _ = Inet_port.of_int 872342 = None (* the code for [Unix_extended.Mac_address] has been moved to [Mac_address_deprecated] (in lib/mac_address/src/deprecated) *) module Mac_address = Nothing [@@deprecated "[since 2020-11] New code should use the [Mac_address] library. Existing code can use \ [Mac_address_deprecated] as a quick fix (which is an exact drop-in replacement)."] module Quota = struct type bytes = Int63.t [@@deriving sexp] type inodes = Int63.t [@@deriving sexp] let bytes x = x let inodes x = x type 'units limit = { soft : 'units option [@sexp.option] ; hard : 'units option [@sexp.option] ; grace : Time.t option [@sexp.option] } [@@deriving sexp] type 'units usage = private 'units (* None is encoded as zero *) type 'units c_limit = { c_soft : 'units ; c_hard : 'units ; c_grace : Time.t } let zero_bytes = bytes Int63.zero let zero_inodes = inodes Int63.zero let ml_limit_of_c_limit ~zero { c_soft; c_hard; c_grace } = { soft = (if c_soft = zero then None else Some c_soft) ; hard = (if c_hard = zero then None else Some c_hard) ; grace = (if c_grace = Time.epoch then None else Some c_grace) } ;; let c_limit_of_ml_limit ~zero { soft; hard; grace } = { c_soft = (match soft with | None -> zero | Some x -> x) ; c_hard = (match hard with | None -> zero | Some x -> x) ; c_grace = (match grace with | None -> Time.epoch | Some x -> x) } ;; external quota_query : [ `User | `Group ] -> id:int -> path:string -> bytes c_limit * bytes usage * inodes c_limit * inodes usage = "quota_query" external quota_modify : [ `User | `Group ] -> id:int -> path:string -> bytes c_limit -> inodes c_limit -> unit = "quota_modify" let query user_or_group ~id ~path = try let blimit, busage, ilimit, iusage = quota_query user_or_group ~id ~path in Ok ( ml_limit_of_c_limit ~zero:zero_bytes blimit , busage , ml_limit_of_c_limit ~zero:zero_inodes ilimit , iusage ) with | Unix.Unix_error _ as exn -> Or_error.of_exn exn ;; let set user_or_group ~id ~path byte_limit inode_limit = try Ok (quota_modify user_or_group ~id ~path (c_limit_of_ml_limit ~zero:zero_bytes byte_limit) (c_limit_of_ml_limit ~zero:zero_inodes inode_limit)) with | Unix.Unix_error _ as exn -> Or_error.of_exn exn ;; end module Mount_entry = struct (* see: man 3 getmntent *) type t = { fsname : string ; directory : string ; fstype : string ; options : string ; dump_freq : int option [@sexp.option] ; fsck_pass : int option [@sexp.option] } [@@deriving sexp, fields ~getters] let escape_seqs = [ "040", " "; "011", "\t"; "012", "\n"; "134", "\\"; "\\", "\\" ] let unescape s = let find_and_drop_prefix s (prefix, replacement) = Option.map (String.chop_prefix ~prefix s) ~f:(fun s -> replacement, s) in let rec loop s = match String.lsplit2 s ~on:'\\' with | None -> [ s ] | Some (l, r) -> (match List.find_map escape_seqs ~f:(find_and_drop_prefix r) with | None -> l :: "\\" :: loop r | Some (x, r) -> l :: x :: loop r) in String.concat (loop s) ;; let parse_optional_int s = match Int.of_string s with | 0 -> None | n -> Some n ;; let split_and_normalize line = let inside_comment = ref false in let whitespace = ' ' in String.map line ~f:(fun x -> if Char.equal x '#' then inside_comment := true; if Char.is_whitespace x || !inside_comment then whitespace else x) |> String.split ~on:whitespace |> List.filter ~f:(fun x -> not (String.is_empty x)) ;; let parse_line line = match split_and_normalize line |> List.map ~f:unescape with | [] -> Ok None | fsname :: directory :: fstype :: options :: (([] | [ _ ] | [ _; _ ]) as dump_freq_and_fsck_pass) -> let dump_freq, fsck_pass = match dump_freq_and_fsck_pass with | [] -> None, None | [ dump_freq ] -> Some dump_freq, None | [ dump_freq; fsck_pass ] -> Some dump_freq, Some fsck_pass | _ -> assert false in Or_error.try_with (fun () -> let dump_freq = Option.bind dump_freq ~f:parse_optional_int in let fsck_pass = Option.bind fsck_pass ~f:parse_optional_int in if String.equal fstype "ignore" then None else Some { fsname; directory; fstype; options; dump_freq; fsck_pass }) | _ -> Or_error.error "wrong number of fields" line String.sexp_of_t ;; let visible_filesystem ts = let add_slash_if_needed s = if String.is_suffix s ~suffix:"/" then s else s ^ "/" in let overlay map t = let remove_prefix = add_slash_if_needed (directory t) in let rec loop map = match Map.closest_key (map : _ String.Map.t) `Greater_than remove_prefix with | None -> map | Some (key, _) -> if not (String.is_prefix ~prefix:remove_prefix key) then map else loop (Map.remove (map : _ String.Map.t) key) in Map.set (loop map : _ String.Map.t) ~key:(directory t) ~data:t in List.fold ts ~init:String.Map.empty ~f:(fun map t -> if not (String.is_prefix ~prefix:"/" (directory t)) then map else overlay map t) ;; end let tput_property ~default prop = (* When both stdout and stderr are not terminals, tput outputs 80 (cols) or 24 (lines) rather than the actual size, so we can't use [Process.run]. Instead, we use [open_process_in] so that stderr is still the terminal. But, we don't want tput's error messages to be sent to stderr and seen by the user, so we first run tput with no output to see if it succeeds, and only then do we run it with stderr not redirected. *) try Exn.protectx (Core_unix.open_process_in (Core.sprintf "/usr/bin/tput %s &> /dev/null && /usr/bin/tput %s" prop prop)) ~f:(fun in_channel -> In_channel.input_line in_channel |> Option.value_exn |> Int.of_string) ~finally:In_channel.close with | _ -> default ;; let terminal_width = lazy (tput_property ~default:90 "cols") let terminal_height = lazy (tput_property ~default:24 "lines")
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>