Add {Sys,Unix,UnixLabels}.io_buffer_size functions

ocaml · Nov 4, 2024 · 8388a24 · 8388a24
1 parent 9ddc048
commit 8388a24
Show file tree

Hide file tree

Showing 9 changed files with 42 additions and 0 deletions.
diff --git a/otherlibs/unix/read_unix.c b/otherlibs/unix/read_unix.c
@@ -54,3 +54,8 @@ CAMLprim value caml_unix_read_bigarray(value vfd, value vbuf,
   if (ret == -1) caml_uerror("read_bigarray", Nothing);
   CAMLreturn(Val_long(ret));
 }
+
+CAMLprim value caml_unix_io_buffer_size(value unit) 
+{
+  return Val_long(UNIX_BUFFER_SIZE);
+}
diff --git a/otherlibs/unix/read_win32.c b/otherlibs/unix/read_win32.c
@@ -103,3 +103,8 @@ CAMLprim value caml_unix_read_bigarray(value fd, value vbuf,
   }
   CAMLreturn(Val_int(numread));
 }
+
+CAMLprim value caml_unix_io_buffer_size(value unit) 
+{
+  return Val_long(UNIX_BUFFER_SIZE);
+}
diff --git a/otherlibs/unix/unix.mli b/otherlibs/unix/unix.mli
@@ -334,6 +334,12 @@ val stdout : file_descr
 val stderr : file_descr
 (** File descriptor for standard error. *)
 
+val io_buffer_size: int
+(** Size of the unix io buffers
+
+    @since 5.4
+*)
+
 type open_flag =
     O_RDONLY                    (** Open for reading *)
   | O_WRONLY                    (** Open for writing *)

diff --git a/otherlibs/unix/unixLabels.mli b/otherlibs/unix/unixLabels.mli
@@ -334,6 +334,12 @@ val stdout : file_descr
 val stderr : file_descr
 (** File descriptor for standard error. *)
 
+val io_buffer_size: int
+(** Size of the unix io buffers
+
+    @since 5.4
+*)
+
 type open_flag = Unix.open_flag =
     O_RDONLY                    (** Open for reading *)
   | O_WRONLY                    (** Open for writing *)

diff --git a/otherlibs/unix/unix_unix.ml b/otherlibs/unix/unix_unix.ml
@@ -232,6 +232,9 @@ let stdin = 0
 let stdout = 1
 let stderr = 2
 
+external io_buffer_size : unit -> int = "caml_unix_io_buffer_size"
+let io_buffer_size = io_buffer_size ()
+
 type open_flag =
     O_RDONLY
   | O_WRONLY

diff --git a/otherlibs/unix/unix_win32.ml b/otherlibs/unix/unix_win32.ml
@@ -256,6 +256,9 @@ let stdin = filedescr_of_unix_fd_num 0
 let stdout = filedescr_of_unix_fd_num 1
 let stderr = filedescr_of_unix_fd_num 2
 
+external io_buffer_size : unit -> int = "caml_unix_io_buffer_size"
+let io_buffer_size = io_buffer_size ()
+
 type open_flag =
     O_RDONLY
   | O_WRONLY

diff --git a/runtime/sys.c b/runtime/sys.c
@@ -687,6 +687,11 @@ CAMLprim value caml_sys_const_max_wosize(value unit)
   return Val_long(Max_wosize) ;
 }
 
+CAMLprim value caml_sys_io_buffer_size(value unit)
+{
+  return Val_long(IO_BUFFER_SIZE);
+}
+
 CAMLprim value caml_sys_const_ostype_unix(value unit)
 {
   return Val_bool(0 == strcmp(OCAML_OS_TYPE,"Unix"));

diff --git a/stdlib/sys.ml.in b/stdlib/sys.ml.in
@@ -70,6 +70,9 @@ external rmdir: string -> unit = "caml_sys_rmdir"
 external getcwd: unit -> string = "caml_sys_getcwd"
 external readdir : string -> string array = "caml_sys_read_directory"
 
+external io_buffer_size: unit -> int = "caml_sys_io_buffer_size"
+let io_buffer_size = io_buffer_size ()
+
 let interactive = ref false
 
 type signal_behavior =

diff --git a/stdlib/sys.mli b/stdlib/sys.mli
@@ -126,6 +126,12 @@ external readdir : string -> string array = "caml_sys_read_directory"
    in any specific order; they are not, in particular, guaranteed to
    appear in alphabetical order. *)
 
+val io_buffer_size: int
+(** Size of the buffer channels
+
+    @since 5.4
+*)
+
 val interactive : bool ref
 [@@alert unsynchronized_access
     "The interactive status is a mutable global state."