![]()
|
Module UnixLabelsmodule UnixLabels:
Interface to the Unix system.
To use as replacement to default
Unix module,
add module Unix = UnixLabels in your implementation.
type error =
The type of error codes.
Errors defined in the POSIX standard
and additional errors, mostly BSD.
All other errors are mapped to EUNKNOWNERR.
exception Unix_error of
Raised by the system calls below when an error is encountered.
The first component is the error code; the second component
is the function name; the third component is the string parameter
to the function, if it has one, or the empty string otherwise.
val error_message :
Return a string describing the given error code.
val handle_unix_error : handle_unix_error f x applies f to x and returns the result.
If the exception Unix_error is raised, it prints a message
describing the error and exits with code 2.
val environment :
Return the process environment, as an array of strings
with the format ``variable=value''.
val getenv :
Return the value associated to a variable in the process
environment. Raise
Not_found if the variable is unbound.
(This function is identical to Sys.getenv .)val putenv : Unix.putenv name value sets the value associated to a
variable in the process environment.
name is the name of the environment variable,
and value its new associated value.
type process_status =
The termination status of a process.
type wait_flag =
Flags for
UnixLabels.waitpid .val execv : execv prog args execute the program in file prog , with
the arguments args , and the current process environment.val execve :
Same as
UnixLabels.execv , except that the third argument provides the
environment to the program executed.val execvp :
Same as
UnixLabels.execv respectively, except that
the program is searched in the path.val execvpe :
Same as
UnixLabels.execvp respectively, except that
the program is searched in the path.val fork :
Fork a new process. The returned integer is 0 for the child
process, the pid of the child process for the parent process.
val wait :
Wait until one of the children processes die, and return its pid
and termination status.
val waitpid :
Same as
UnixLabels.wait , but waits for the process whose pid is given.
A pid of -1 means wait for any child.
A pid of 0 means wait for any child in the same process group
as the current process.
Negative pid arguments represent process groups.
The list of options indicates whether waitpid should return
immediately without waiting, or also report stopped children.val system :
Execute the given command, wait until it terminates, and return
its termination status. The string is interpreted by the shell
/bin/sh and therefore can contain redirections, quotes, variables,
etc. The result WEXITED 127 indicates that the shell couldn't
be executed.val getpid :
Return the pid of the process.
val getppid :
Return the pid of the parent process.
val nice :
Change the process priority. The integer argument is added to the
``nice'' value. (Higher values of the ``nice'' value mean
lower priorities.) Return the new nice value.
type file_descr =
The abstract type of file descriptors.
val stdin :
File descriptor for standard input.
val stdout :
File descriptor for standard output.
val stderr :
File descriptor for standard standard error.
type open_flag =
The flags to
UnixLabels.openfile .type file_perm =
The type of file access rights.
val openfile :
Open the named file with the given flags. Third argument is
the permissions to give to the file if it is created. Return
a file descriptor on the named file.
val close :
Close a file descriptor.
val read : read fd buff ofs len reads len characters from descriptor
fd , storing them in string buff , starting at position ofs
in string buff . Return the number of characters actually read.val write : write fd buff ofs len writes len characters to descriptor
fd , taking them from string buff , starting at position ofs
in string buff . Return the number of characters actually
written.
val in_channel_of_descr :
Create an input channel reading from the given descriptor.
The channel is initially in binary mode; use
set_binary_mode_in ic false if text mode is desired.val out_channel_of_descr :
Create an output channel writing on the given descriptor.
The channel is initially in binary mode; use
set_binary_mode_out oc false if text mode is desired.val descr_of_in_channel :
Return the descriptor corresponding to an input channel.
val descr_of_out_channel :
Return the descriptor corresponding to an output channel.
type seek_command =
Positioning modes for
UnixLabels.lseek .val lseek :
Set the current position for a file descriptor
val truncate :
Truncates the named file to the given size.
val ftruncate :
Truncates the file corresponding to the given descriptor
to the given size.
type file_kind =
type stats =
The informations returned by the
UnixLabels.stat calls.val stat :
Return the information for the named file.
val lstat :
Same as
UnixLabels.stat , but in case the file is a symbolic link,
return the information for the link itself.val fstat :
Return the information for the file associated with the given
descriptor.
module LargeFile:
This sub-module provides 64-bit variants of the functions
UnixLabels.lseek (for positioning a file descriptor),
UnixLabels.truncate and UnixLabels.ftruncate
(for changing the size of a file),
and UnixLabels.stat , UnixLabels.lstat and UnixLabels.fstat
(for obtaining information on files).
val unlink :
Removes the named file
val rename : rename old new changes the name of a file from old to new .val link : link source dest creates a hard link named dest to the file
named new .
type access_permission =
Flags for the
UnixLabels.access call.val chmod :
Change the permissions of the named file.
val fchmod :
Change the permissions of an opened file.
val chown :
Change the owner uid and owner gid of the named file.
val fchown :
Change the owner uid and owner gid of an opened file.
val umask :
Set the process creation mask, and return the previous mask.
val access :
Check that the process has the given permissions over the named
file. Raise
Unix_error otherwise.
val dup :
Return a new file descriptor referencing the same file as
the given descriptor.
val dup2 : dup2 fd1 fd2 duplicates fd1 to fd2 , closing fd2 if already
opened.val set_nonblock :
Set the ``non-blocking'' flag on the given descriptor.
When the non-blocking flag is set, reading on a descriptor
on which there is temporarily no data available raises the
EAGAIN or EWOULDBLOCK error instead of blocking;
writing on a descriptor on which there is temporarily no room
for writing also raises EAGAIN or EWOULDBLOCK .val clear_nonblock :
Clear the ``non-blocking'' flag on the given descriptor.
See
UnixLabels.set_nonblock .val set_close_on_exec :
Set the ``close-on-exec'' flag on the given descriptor.
A descriptor with the close-on-exec flag is automatically
closed when the current process starts another program with
one of the
exec functions.val clear_close_on_exec :
Clear the ``close-on-exec'' flag on the given descriptor.
See
UnixLabels.set_close_on_exec .
val mkdir :
Create a directory with the given permissions.
val rmdir :
Remove an empty directory.
val chdir :
Change the process working directory.
val getcwd :
Return the name of the current working directory.
val chroot :
Change the process root directory.
type dir_handle =
The type of descriptors over opened directories.
val opendir :
Open a descriptor on a directory
val readdir :
Return the next entry in a directory.
Raises End_of_file when the end of the directory has been reached.val rewinddir :
Reposition the descriptor to the beginning of the directory
val closedir :
Close a directory descriptor.
val pipe :
Create a pipe. The first component of the result is opened
for reading, that's the exit to the pipe. The second component is
opened for writing, that's the entrance to the pipe.
val mkfifo :
Create a named pipe with the given permissions.
val create_process : create_process prog args new_stdin new_stdout new_stderr
forks a new process that executes the program
in file prog , with arguments args . The pid of the new
process is returned immediately; the new process executes
concurrently with the current process.
The standard input and outputs of the new process are connected
to the descriptors new_stdin , new_stdout and new_stderr .
Passing e.g. stdout for new_stdout prevents the redirection
and causes the new process to have the same standard output
as the current process.
The executable file prog is searched in the path.
The new process has the same environment as the current process.
All file descriptors of the current process are closed in the
new process, except those redirected to standard input and
outputs.val create_process_env : create_process_env prog args env new_stdin new_stdout new_stderr
works as UnixLabels.create_process , except that the extra argument
env specifies the environment passed to the program.val open_process_in :
High-level pipe and process management. These functions
(with
UnixLabels.open_process_out and UnixLabels.open_process )
run the given command in parallel with the program,
and return channels connected to the standard input and/or
the standard output of the command. The command is interpreted
by the shell /bin/sh (cf. system ). Warning: writes on channels
are buffered, hence be careful to call Pervasives.flush at the right times
to ensure correct synchronization.val open_process_out :
val open_process :
val open_process_full :
Similar to
UnixLabels.open_process , but the second argument specifies
the environment passed to the command. The result is a triple
of channels connected to the standard output, standard input,
and standard error of the command.val close_process_in :
Close channels opened by
UnixLabels.open_process_in ,
wait for the associated command to terminate,
and return its termination status.val close_process_out :
Close channels opened by
UnixLabels.open_process_out ,
wait for the associated command to terminate,
and return its termination status.val close_process :
Close channels opened by
UnixLabels.open_process ,
wait for the associated command to terminate,
and return its termination status.val close_process_full :
Close channels opened by
UnixLabels.open_process_full ,
wait for the associated command to terminate,
and return its termination status.
val symlink : symlink source dest creates the file dest as a symbolic link
to the file source .val readlink :
Read the contents of a link.
val select :
Wait until some input/output operations become possible on
some channels. The three list arguments are, respectively, a set
of descriptors to check for reading (first argument), for writing
(second argument), or for exceptional conditions (third argument).
The fourth argument is the maximal timeout, in seconds; a
negative fourth argument means no timeout (unbounded wait).
The result is composed of three sets of descriptors: those ready
for reading (first component), ready for writing (second component),
and over which an exceptional condition is pending (third
component).
type lock_command =
Commands for
UnixLabels.lockf .val lockf : lockf fd cmd size puts a lock on a region of the file opened
as fd . The region starts at the current read/write position for
fd (as set by UnixLabels.lseek ), and extends size bytes forward if
size is positive, size bytes backwards if size is negative,
or to the end of the file if size is zero.
A write lock (set with F_LOCK or F_TLOCK ) prevents any other
process from acquiring a read or write lock on the region.
A read lock (set with F_RLOCK or F_TRLOCK ) prevents any other
process from acquiring a write lock on the region, but lets
other processes acquire read locks on it.
Sys.signal and Sys.set_signal .val kill : kill pid sig sends signal number sig to the process
with id pid .type sigprocmask_command =
val sigprocmask : sigprocmask cmd sigs changes the set of blocked signals.
If cmd is SIG_SETMASK , blocked signals are set to those in
the list sigs .
If cmd is SIG_BLOCK , the signals in sigs are added to
the set of blocked signals.
If cmd is SIG_UNBLOCK , the signals in sigs are removed
from the set of blocked signals.
sigprocmask returns the set of previously blocked signals.val sigpending :
Return the set of blocked signals that are currently pending.
val sigsuspend : sigsuspend sigs atomically sets the blocked signals to sig
and waits for a non-ignored, non-blocked signal to be delivered.
On return, the blocked signals are reset to their initial value.val pause :
Wait until a non-ignored, non-blocked signal is delivered.
type process_times =
The execution times (CPU times) of a process.
type tm =
The type representing wallclock time and calendar date.
val time :
Return the current time since 00:00:00 GMT, Jan. 1, 1970,
in seconds.
val gettimeofday :
Same as
UnixLabels.time , but with resolution better than 1 second.val gmtime :
Convert a time in seconds, as returned by
UnixLabels.time , into a date and
a time. Assumes Greenwich meridian time zone, also known as UTC.val localtime :
Convert a time in seconds, as returned by
UnixLabels.time , into a date and
a time. Assumes the local time zone.val mktime :
Convert a date and time, specified by the
tm argument, into
a time in seconds, as returned by UnixLabels.time . Also return a normalized
copy of the given tm record, with the tm_wday , tm_yday ,
and tm_isdst fields recomputed from the other fields.
The tm argument is interpreted in the local time zone.val alarm :
Schedule a
SIGALRM signal after the given number of seconds.val sleep :
Stop execution for the given number of seconds.
val times :
Return the execution times of the process.
val utimes :
Set the last access time (second arg) and last modification time
(third arg) for a file. Times are expressed in seconds from
00:00:00 GMT, Jan. 1, 1970.
type interval_timer =
The three kinds of interval timers.
type interval_timer_status =
The type describing the status of an interval timer
val getitimer :
Return the current status of the given interval timer.
val setitimer : setitimer t s sets the interval timer t and returns
its previous status. The s argument is interpreted as follows:
s.it_value , if nonzero, is the time to the next timer expiration;
s.it_interval , if nonzero, specifies a value to
be used in reloading it_value when the timer expires.
Setting s.it_value to zero disable the timer.
Setting s.it_interval to zero causes the timer to be disabled
after its next expiration.
val getuid :
Return the user id of the user executing the process.
val geteuid :
Return the effective user id under which the process runs.
val setuid :
Set the real user id and effective user id for the process.
val getgid :
Return the group id of the user executing the process.
val getegid :
Return the effective group id under which the process runs.
val setgid :
Set the real group id and effective group id for the process.
val getgroups :
Return the list of groups to which the user executing the process
belongs.
type passwd_entry =
Structure of entries in the
passwd database.type group_entry =
Structure of entries in the
groups database.val getlogin :
Return the login name of the user executing the process.
val getpwnam :
Find an entry in
passwd with the given name, or raise
Not_found .val getgrnam :
Find an entry in
group with the given name, or raise
Not_found .val getpwuid :
Find an entry in
passwd with the given user id, or raise
Not_found .val getgrgid :
Find an entry in
group with the given group id, or raise
Not_found .
type inet_addr =
The abstract type of Internet addresses.
val inet_addr_of_string :
Conversions between string with the format
XXX.YYY.ZZZ.TTT
and Internet addresses. inet_addr_of_string raises Failure
when given a string that does not match this format.val string_of_inet_addr :
val inet_addr_any :
A special Internet address, for use only with
bind , representing
all the Internet addresses that the host machine possesses.
type socket_domain =
The type of socket domains.
type socket_type =
The type of socket kinds, specifying the semantics of
communications.
type sockaddr =
val socket :
Create a new socket in the given domain, and with the
given kind. The third argument is the protocol type; 0 selects
the default protocol for that kind of sockets.
val socketpair :
Create a pair of unnamed sockets, connected together.
val accept :
Accept connections on the given socket. The returned descriptor
is a socket connected to the client; the returned address is
the address of the connecting client.
val bind :
Bind a socket to an address.
val connect :
Connect a socket to an address.
val listen :
Set up a socket for receiving connection requests. The integer
argument is the maximal number of pending requests.
type shutdown_command =
The type of commands for
shutdown .val shutdown :
Shutdown a socket connection.
SHUTDOWN_SEND as second argument
causes reads on the other end of the connection to return
an end-of-file condition.
SHUTDOWN_RECEIVE causes writes on the other end of the connection
to return a closed pipe condition (SIGPIPE signal).val getsockname :
Return the address of the given socket.
val getpeername :
Return the address of the host connected to the given socket.
type msg_flag =
val recv :
Receive data from an unconnected socket.
val recvfrom :
Receive data from an unconnected socket.
val send :
Send data over an unconnected socket.
val sendto :
Send data over an unconnected socket.
type socket_bool_option =
The socket options that can be consulted with
UnixLabels.getsockopt
and modified with UnixLabels.setsockopt . These options have a boolean
(true /false ) value.type socket_int_option =
The socket options that can be consulted with
UnixLabels.getsockopt_int
and modified with UnixLabels.setsockopt_int . These options have an
integer value.type socket_optint_option =
The socket options that can be consulted with
UnixLabels.getsockopt_optint
and modified with UnixLabels.setsockopt_optint . These options have a
value of type int option , with None meaning ``disabled''.type socket_float_option =
The socket options that can be consulted with
UnixLabels.getsockopt_float
and modified with UnixLabels.setsockopt_float . These options have a
floating-point value representing a time in seconds.
The value 0 means infinite timeout.val getsockopt :
Return the current status of a boolean-valued option
in the given socket.
val setsockopt :
Set or clear a boolean-valued option in the given socket.
val getsockopt_int :
Same as
UnixLabels.getsockopt for an integer-valued socket option.val setsockopt_int :
Same as
UnixLabels.setsockopt for an integer-valued socket option.val getsockopt_optint :
val setsockopt_optint :
val getsockopt_float :
Same as
UnixLabels.getsockopt for a socket option whose value is a floating-point number.val setsockopt_float :
Same as
UnixLabels.setsockopt for a socket option whose value is a floating-point number.
val open_connection :
Connect to a server at the given address.
Return a pair of buffered channels connected to the server.
Remember to call
Pervasives.flush on the output channel at the right times
to ensure correct synchronization.val shutdown_connection :
``Shut down'' a connection established with
UnixLabels.open_connection ;
that is, transmit an end-of-file condition to the server reading
on the other side of the connection.val establish_server :
Establish a server on the given address.
The function given as first argument is called for each connection
with two buffered channels connected to the client. A new process
is created for each connection. The function
UnixLabels.establish_server
never returns normally.
type host_entry =
Structure of entries in the
hosts database.type protocol_entry =
Structure of entries in the
protocols database.type service_entry =
Structure of entries in the
services database.val gethostname :
Return the name of the local host.
val gethostbyname :
Find an entry in
hosts with the given name, or raise
Not_found .val gethostbyaddr :
Find an entry in
hosts with the given address, or raise
Not_found .val getprotobyname :
Find an entry in
protocols with the given name, or raise
Not_found .val getprotobynumber :
Find an entry in
protocols with the given protocol number,
or raise Not_found .val getservbyname :
Find an entry in
services with the given name, or raise
Not_found .val getservbyport :
Find an entry in
services with the given service number,
or raise Not_found .
The following functions implement the POSIX standard terminal interface. They provide control over asynchronous communication ports and pseudo-terminals. Refer to the termios man page for a
complete description.type terminal_io =
val tcgetattr :
Return the status of the terminal referred to by the given
file descriptor.
type setattr_when =
val tcsetattr :
Set the status of the terminal referred to by the given
file descriptor. The second argument indicates when the
status change takes place: immediately (
TCSANOW ),
when all pending output has been transmitted (TCSADRAIN ),
or after flushing all input that has been received but not
read (TCSAFLUSH ). TCSADRAIN is recommended when changing
the output parameters; TCSAFLUSH , when changing the input
parameters.val tcsendbreak :
Send a break condition on the given file descriptor.
The second argument is the duration of the break, in 0.1s units;
0 means standard duration (0.25s).
val tcdrain :
Waits until all output written on the given file descriptor
has been transmitted.
type flush_queue =
val tcflush :
Discard data written on the given file descriptor but not yet
transmitted, or data received but not yet read, depending on the
second argument:
TCIFLUSH flushes data received but not read,
TCOFLUSH flushes data written but not transmitted, and
TCIOFLUSH flushes both.type flow_action =
val tcflow :
Suspend or restart reception or transmission of data on
the given file descriptor, depending on the second argument:
TCOOFF suspends output, TCOON restarts output,
TCIOFF transmits a STOP character to suspend input,
and TCION transmits a START character to restart input.val setsid :
Put the calling process in a new session and detach it from
its controlling terminal.
|