kibi-swipl-linux-x64-gnu 1.0.0

package/lib/swipl/library/ext/clib/uid.pl

@@ -0,0 +1,220 @@
+/*  Part of SWI-Prolog
+
+    Author:        Jan Wielemaker
+    E-mail:        J.Wielemaker@vu.nl
+    WWW:           http://www.swi-prolog.org
+    Copyright (c)  2011-2013, VU University Amsterdam
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in
+       the documentation and/or other materials provided with the
+       distribution.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
+*/
+
+:- module(uid,
+          [ getuid/1,                   % -UID
+            getgid/1,                   % -GID
+            geteuid/1,                  % -UID
+            getegid/1,                  % -GID
+            getgroups/1,                % -GIDs
+            user_info/2,                % +User, -UserInfo
+            group_info/2,               % +Group, -GroupInfo
+            user_data/3,                % +Field, +UserInfo, -Value
+            group_data/3,               % +Field, +GroupInfo, -Value
+            setuid/1,                   % +UID
+            setgid/1,                   % +GID
+            seteuid/1,                  % +UID
+            setegid/1,                  % +GID
+
+            set_user_and_group/1,       % +User
+            set_user_and_group/2        % +User, +Group
+          ]).
+
+:- use_foreign_library(foreign(uid)).
+
+:- if(predicate_property(initgroups(_,_), defined)).
+:- export(initgroups/2).
+:- else.
+initgroups(_,_).
+:- endif.
+
+:- if(predicate_property(setgroups(_), defined)).
+:- export(setgroups/1).
+:- endif.
+
+/** <module> User and group management on Unix systems
+
+This module provides and interface  to   user  and  group information on
+Posix systems. In addition, it allows for   changing user and group ids.
+When changing user and group settings for   the calling process, bear in
+mind that:
+
+  - Changing user and groups of the calling process requires permission.
+  - The functions setgroups() and initgroups() are not part of the
+    POSIX standard and therefore the derived predicates may not be
+    present.
+
+@see    Please check the documentation of your OS for details on the
+        semantics of this predicates.
+*/
+
+%!  getuid(-UID) is det.
+%
+%   UID is the real user ID of the calling process.
+
+%!  getgid(-GID) is det.
+%
+%   GID is the real group ID of the calling process.
+
+%!  geteuid(-UID) is det.
+%
+%   UID is the effective user ID of the calling process.
+
+%!  getegid(-GID) is det.
+%
+%   GID is the effective group ID of the calling process.
+
+%!  getgroups(-GroupsIDs:list(integer)) is det.
+%
+%   GroupsIDs is the set of supplementary   group IDs of the calling
+%   process.  Note  that  these   are    numeric   identifiers.  Use
+%   group_info/2  to  obtain  details   on    the   returned   group
+%   identifiers.
+
+%!  user_info(+User, -UserData) is det.
+%
+%   UserData represent the passwd  information   for  User.  User is
+%   either a numeric UID or a   user name. The predicate user_data/3
+%   can be used to extract information from UserData.
+
+%!  user_data(?Field, ?UserData, ?Value)
+%
+%   Value is the value for Field in UserData.  Defined fields are:
+%
+%     * name
+%     Name of the user
+%     * password
+%     Password hash of the user (or =x= if this is not accessible)
+%     * uid
+%     Numeric user id of the user
+%     * gid
+%     Numeric primary group id of the user
+%     * comment
+%     The _gecos_ field
+%     * home
+%     Home directory of the user
+%     * shell
+%     Default (login) shell of the user.
+
+user_data(name,     user_info(Nam, _, _, _, _, _, _), Nam).
+user_data(password, user_info(_, PWD, _, _, _, _, _), PWD).
+user_data(uid,      user_info(_, _, UID, _, _, _, _), UID).
+user_data(gid,      user_info(_, _, _, GID, _, _, _), GID).
+user_data(comment,  user_info(_, _, _, _, GEC, _, _), GEC).
+user_data(home,     user_info(_, _, _, _, _, HOM, _), HOM).
+user_data(shell,    user_info(_, _, _, _, _, _, SHE), SHE).
+
+%!  group_info(+Group, -GroupData) is det.
+%
+%   GroupData represent the group information   for  Group. Group is
+%   either a numeric GID or a group name. The predicate group_data/3
+%   can be used to extract information from GroupData.
+
+%!  group_data(?Field, ?GroupData, ?Value)
+%
+%   Value is the value for Field  GroupData.  Defined fields are:
+%
+%     * name
+%     Name of the user
+%     * password
+%     Password hash of the user (or =x= if this is not accessible)
+%     * gid
+%     Numeric group id of the group
+%     * members
+%     List of user-names that are member of this group.
+
+group_data(name,     group_info(Nam, _, _, _), Nam).
+group_data(password, group_info(_, PWD, _, _), PWD).
+group_data(gid,      group_info(_, _, GID, _), GID).
+group_data(members,  group_info(_, _, _, MBR), MBR).
+
+                 /*******************************
+                 *             SETTING          *
+                 *******************************/
+
+%!  setuid(+UID)
+%
+%   Set the user id of the calling process.
+
+%!  seteuid(+UID)
+%
+%   Set the effective user id of the calling process.
+
+
+%!  setgid(+GID)
+%
+%   Set the group id of the calling process.
+
+%!  setegid(+GID)
+%
+%   Set the effective group id of the calling process.
+
+%!  initgroups(+User, +Group) is det.
+%
+%   Initialise the group access list of   the calling process to the
+%   registered groups for User and the   group Group. This predicate
+%   is only available if the underlying OS provides it.
+
+%!  setgroups(+Groups:list(integer)) is det.
+%
+%   Set the group access list of the caling process to the indicated
+%   groups. This predicate is only available   if  the underlying OS
+%   provides it.
+
+%!  set_user_and_group(+User) is det.
+%!  set_user_and_group(+User, +Group) is det.
+%
+%   Set the UID and GID to the User. User  is either a UID or a user
+%   name. If Group is not specified, the   primary  group of User is
+%   used. If initgroups/2 is available,   the resulting group access
+%   list of the calling process consists   of  the registered groups
+%   for User and the specified Group.
+
+set_user_and_group(User) :-
+    user_info(User, Data),
+    user_data(uid, Data, UID),
+    user_data(gid, Data, GID),
+    initgroups(User, GID),
+    setgid(GID),
+    setuid(UID).
+
+set_user_and_group(User, Group) :-
+    user_info(User, Data),
+    group_info(Group, GData),
+    user_data(uid, Data, UID),
+    user_data(gid, Data, UGID),
+    group_data(gid, GData, GID),
+    initgroups(User, UGID),
+    setgid(GID),
+    setuid(UID).

package/lib/swipl/library/ext/clib/unix.pl

@@ -0,0 +1,317 @@
+/*  Part of SWI-Prolog
+
+    Author:        Jan Wielemaker
+    E-mail:        J.Wielemaker@vu.nl
+    WWW:           http://www.swi-prolog.org
+    Copyright (c)  2000-2022, University of Amsterdam
+                              VU University Amsterdam
+                              SWI-Prolog Solutions b.v.
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in
+       the documentation and/or other materials provided with the
+       distribution.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
+*/
+
+:- module(unix,
+          [ fork/1,                     % -'client'|pid
+            exec/1,                     % +Command(...Args...)
+            fork_exec/1,                % +Command(...Args...)
+            wait/2,                     % -Pid, -Reason
+            kill/2,                     % +Pid. +Signal
+            pipe/2,                     % +Read, +Write
+            dup/2,                      % +From, +To
+            detach_IO/0,
+            detach_IO/1,                % +Stream
+            environ/1                   % -[Name=Value]
+          ]).
+
+/** <module> Unix specific operations
+
+The library(unix) library provides the commonly  used Unix primitives to
+deal with process management.  These  primitives   are  useful  for many
+tasks, including server management, parallel computation, exploiting and
+controlling other processes, etc.
+
+The predicates in this library are   modelled closely after their native
+Unix counterparts.
+
+@see library(process) provides a portable high level interface to create
+and manage processes.
+*/
+
+:- use_foreign_library(foreign(unix)).
+
+%!  fork(-Pid) is det.
+%
+%   Clone the current process into two   branches. In the child, Pid
+%   is unified to child. In the original  process, Pid is unified to
+%   the process identifier of the  created   child.  Both parent and
+%   child are fully functional  Prolog   processes  running the same
+%   program. The processes share open I/O streams that refer to Unix
+%   native streams, such as files, sockets   and  pipes. Data is not
+%   shared, though on most Unix systems data is initially shared and
+%   duplicated only if one of the   programs  attempts to modify the
+%   data.
+%
+%   Unix fork() is the only way to   create new processes and fork/1
+%   is a simple direct interface to it.
+%
+%   @error  permission_error(fork, process, main) is raised if
+%           the calling thread is not the only thread in the
+%           process.  Forking a Prolog process with threads
+%           will typically deadlock because only the calling
+%           thread is cloned in the fork, while all thread
+%           synchronization are cloned.
+
+fork(Pid) :-
+    fork_warn_threads,
+    fork_(Pid).
+
+%!  fork_warn_threads
+%
+%   See whether we are the  only thread.  If not, we cannot fork
+
+fork_warn_threads :-
+    set_prolog_gc_thread(stop),
+    findall(T, other_thread(T), Others),
+    (   Others == []
+    ->  true
+    ;   throw(error(permission_error(fork, process, main),
+                    context(_, running_threads(Others))))
+    ).
+
+other_thread(T) :-
+    thread_self(Me),
+    thread_property(T, status(Status)),
+    T \== Me,
+    (   Status == running
+    ->  true
+    ;   print_message(warning, fork(join(T, Status))),
+        thread_join(T, _),
+        fail
+    ).
+
+%!  fork_exec(+Command) is det.
+%
+%   Fork (as fork/1) and exec (using  exec/1) the child immediately.
+%   This behaves as the code below, but   bypasses the check for the
+%   existence of other threads because this is a safe scenario.
+%
+%     ==
+%     fork_exec(Command) :-
+%           (   fork(child)
+%           ->  exec(Command)
+%           ;   true
+%           ).
+%     ==
+
+fork_exec(Command) :-
+    (   fork_(child)
+    ->  exec(Command)
+    ;   true
+    ).
+
+%!  exec(+Command)
+%
+%   Replace the running program by starting   Command.  Command is a
+%   callable term. The functor is  the   command  and  the arguments
+%   provide  the  command-line  arguments  for   the  command.  Each
+%   command-line argument must be  atomic  and   is  converted  to a
+%   string before passed to the Unix   call  execvp(). Here are some
+%   examples:
+%
+%     - exec(ls('-l'))
+%     - exec('/bin/ls'('-l', '/home/jan'))
+%
+%   Unix exec() is  the  only  way   to  start  an  executable  file
+%   executing. It is commonly used together with fork/1. For example
+%   to start netscape on an URL in the background, do:
+%
+%     ==
+%     run_netscape(URL) :-
+%             (    fork(child),
+%                  exec(netscape(URL))
+%             ;    true
+%             ).
+%     ==
+%
+%   Using this code, netscape remains part   of the process-group of
+%   the invoking Prolog  process  and  Prolog   does  not  wait  for
+%   netscape to terminate. The predicate wait/2 allows waiting for a
+%   child, while detach_IO/0  disconnects  the   child  as  a deamon
+%   process.
+
+%!  wait(?Pid, -Status) is det.
+%
+%   Wait for a child to change status.   Then  report the child that
+%   changed status as well as the reason.   If Pid is bound on entry
+%   then the status of the specified child is reported. If not, then
+%   the status of any child  is   reported.  Status  is unified with
+%   exited(ExitCode) if the child with  pid   Pid  was terminated by
+%   calling exit() (Prolog halt/1). ExitCode   is the return status.
+%   Status is unified with signaled(Signal) if the child died due to
+%   a software interrupt (see kill/2).   Signal  contains the signal
+%   number. Finally, if the process  suspended   execution  due to a
+%   signal, Status is unified with stopped(Signal).
+
+%!  kill(+Pid, +Signal) is det.
+%
+%   Deliver a software interrupt to the  process with identifier Pid
+%   using software-interrupt number Signal.   See  also on_signal/2.
+%   Signals can be specified as  an   integer  or signal name, where
+%   signal names are derived from  the   C  constant by dropping the
+%   =SIG= prefix and mapping to lowercase. E.g. =int= is the same as
+%   =SIGINT= in C. The meaning of the signal numbers can be found in
+%   the Unix manual.
+
+%!  pipe(-InSream, -OutStream) is det.
+%
+%   Create a communication-pipe. This is  normally   used  to make a
+%   child communicate to its parent. After   pipe/2,  the process is
+%   cloned and, depending on the   desired direction, both processes
+%   close the end of the pipe they  do   not  use. Then they use the
+%   remaining stream to communicate. Here is a simple example:
+%
+%     ==
+%     :- use_module(library(unix)).
+%
+%     fork_demo(Result) :-
+%             pipe(Read, Write),
+%             fork(Pid),
+%             (   Pid == child
+%             ->  close(Read),
+%                 format(Write, '~q.~n',
+%                        [hello(world)]),
+%                 flush_output(Write),
+%                 halt
+%             ;   close(Write),
+%                 read(Read, Result),
+%                 close(Read)
+%             ).
+%     ==
+
+
+%!  dup(+FromStream, +ToStream) is det.
+%
+%   Interface to Unix dup2(), copying  the underlying filedescriptor
+%   and thus making both  streams  point   to  the  same  underlying
+%   object. This is normally used together with fork/1 and pipe/2 to
+%   talk to an external program  that   is  designed  to communicate
+%   using standard I/O.
+%
+%   Both FromStream and ToStream either refer  to a Prolog stream or
+%   an  integer  descriptor  number   to    refer   directly  to  OS
+%   descriptors. See also demo/pipe.pl in the source-distribution of
+%   this package.
+
+
+%!  detach_IO(+Stream) is det.
+%
+%   This predicate is intended to create Unix _deamon_ processes. It
+%   performs two actions.
+%
+%     1. The I/O streams =user_input=, =user_output= and
+%     =user_error= are closed if they are connected to a terminal
+%     (see =tty= property in stream_property/2). Input streams are
+%     rebound to a dummy stream that returns EOF. Output streams are
+%     reboud to forward their output to Stream.
+%
+%     2. The process is detached from the current process-group and
+%     its controlling terminal. This is achieved using setsid() if
+%     provided or using ioctl() =TIOCNOTTY= on =|/dev/tty|=.
+%
+%   To ignore all output, it may be   rebound  to a null stream. For
+%   example:
+%
+%     ==
+%           ...,
+%           open_null_stream(Out),
+%           detach_IO(Out).
+%     ==
+%
+%   The  detach_IO/1  should  be  called   only  once  per  process.
+%   Subsequent calls silently succeed without any side effects.
+%
+%   @see detach_IO/0 and library(syslog).
+
+%!  detach_IO is det.
+%
+%   Detach I/O similar to detach_IO/1. The  output streams are bound
+%   to a file =|/tmp/pl-out.<pid>|=. Output   is  line buffered (see
+%   set_stream/2).
+%
+%   @compat Older versions of this predicate only created this file
+%           if there was output.
+%   @see    library(syslog) allows for sending output to the Unix
+%           logging service.
+
+detach_IO :-
+    current_prolog_flag(pid, Pid),
+    atom_concat('/tmp/pl-out.', Pid, TmpFile),
+    open(TmpFile, write, Out, [alias(daemon_output)]),
+    set_stream(Out, buffer(line)),
+    detach_IO(Out).
+
+:- if(current_predicate(prctl/1)).
+:- export(prctl/1).
+
+%!  prctl(+Option) is det.
+%
+%   Access to Linux process control operations.  Defines values for
+%   Option are:
+%
+%     - set_dumpable(+Boolean)
+%     Control whether the process is allowed to dump core. This
+%     right is dropped under several uid and gid conditions.
+%     - get_dumpable(-Boolean)
+%     Get the value of the dumpable flag.
+
+:- endif.
+
+:- if(current_predicate(sysconf/1)).
+:- export(sysconf/1).
+
+%!  sysconf(+Conf) is semidet.
+%
+%   Access system configuration. See sysconf(1) for details. Conf is
+%   a term Config(Value), where Value is   always an integer. Config
+%   is the sysconf() name after removing   =_SC_=  and conversion to
+%   lowercase. Currently support the   following configuration info:
+%   =arg_max=,  =child_max=,  =clk_tck=,    =open_max=,  =pagesize=,
+%   =phys_pages=,     =avphys_pages=,     =nprocessors_conf=     and
+%   =nprocessors_onln=. Note that not all values may be supported on
+%   all operating systems.
+
+:- endif.
+
+                 /*******************************
+                 *           MESSAGES           *
+                 *******************************/
+
+:- multifile
+    prolog:message//1.
+
+prolog:message(fork(join(T, Status))) -->
+    [ 'Fork: joining thead ~p (status: ~p)'-[T, Status] ].