1 /* Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
2 * 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public License
6 * as published by the Free Software Foundation; either version 3 of
7 * the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
38 #ifdef TIME_WITH_SYS_TIME
39 # include <sys/time.h>
43 # include <sys/time.h>
53 #ifdef LIBC_H_WITH_UNISTD_H
57 #include <sys/types.h>
68 #include "libguile/_scm.h"
69 #include "libguile/dynwind.h"
70 #include "libguile/fports.h"
71 #include "libguile/scmsigs.h"
72 #include "libguile/feature.h"
73 #include "libguile/strings.h"
74 #include "libguile/srfi-13.h"
75 #include "libguile/srfi-14.h"
76 #include "libguile/vectors.h"
77 #include "libguile/values.h"
79 #include "libguile/validate.h"
80 #include "libguile/posix.h"
81 #include "libguile/gettext.h"
82 #include "libguile/threads.h"
86 # include <sys/wait.h>
89 # define WEXITSTATUS(stat_val) ((unsigned)(stat_val) >> 8)
92 # define WIFEXITED(stat_val) (((stat_val) & 255) == 0)
100 #ifdef HAVE_SYS_UTSNAME_H
101 #include <sys/utsname.h>
104 #ifdef HAVE_SETLOCALE
108 #if (defined HAVE_NEWLOCALE) && (defined HAVE_STRCOLL_L)
109 # define USE_GNU_LOCALE_API
112 #if (defined USE_GNU_LOCALE_API) && (defined HAVE_XLOCALE_H)
113 # include <xlocale.h>
121 #include <netdb.h> /* for MAXHOSTNAMELEN on Solaris */
124 #ifdef HAVE_SYS_PARAM_H
125 #include <sys/param.h> /* for MAXHOSTNAMELEN */
128 #if HAVE_SYS_RESOURCE_H
129 # include <sys/resource.h>
132 #include <sys/file.h> /* from Gnulib */
134 /* Some Unix systems don't define these. CPP hair is dangerous, but
135 this seems safe enough... */
152 /* No prototype for this on Solaris 10. The man page says it's in
153 <unistd.h> ... but it lies. */
154 #if ! HAVE_DECL_SETHOSTNAME
155 int sethostname (char *name
, size_t namelen
);
158 #if defined HAVE_GETLOGIN && !HAVE_DECL_GETLOGIN
159 /* MinGW doesn't supply this decl; see
160 http://lists.gnu.org/archive/html/bug-gnulib/2013-03/msg00030.html for more
162 char *getlogin (void);
165 /* On NextStep, <utime.h> doesn't define struct utime, unless we
166 #define _POSIX_SOURCE before #including it. I think this is less
167 of a kludge than defining struct utimbuf ourselves. */
168 #ifdef UTIMBUF_NEEDS_POSIX
169 #define _POSIX_SOURCE
172 #ifdef HAVE_SYS_UTIME_H
173 #include <sys/utime.h>
180 /* Please don't add any more #includes or #defines here. The hack
181 above means that _POSIX_SOURCE may be #defined, which will
182 encourage header files to do strange things.
184 FIXME: Maybe should undef _POSIX_SOURCE after it's done its job.
186 FIXME: Probably should do all the includes first, then all the fallback
187 declarations and defines, in case things are not in the header we
195 /* Two often used patterns
198 #define WITH_STRING(str,cstr,code) \
200 char *cstr = scm_to_locale_string (str); \
205 #define STRING_SYSCALL(str,cstr,code) \
208 char *cstr = scm_to_locale_string (str); \
209 SCM_SYSCALL (code); \
210 eno = errno; free (cstr); errno = eno; \
215 SCM_SYMBOL (sym_read_pipe
, "read pipe");
216 SCM_SYMBOL (sym_write_pipe
, "write pipe");
218 SCM_DEFINE (scm_pipe
, "pipe", 0, 0, 0,
220 "Return a newly created pipe: a pair of ports which are linked\n"
221 "together on the local machine. The @emph{car} is the input\n"
222 "port and the @emph{cdr} is the output port. Data written (and\n"
223 "flushed) to the output port can be read from the input port.\n"
224 "Pipes are commonly used for communication with a newly forked\n"
225 "child process. The need to flush the output port can be\n"
226 "avoided by making it unbuffered using @code{setvbuf}.\n"
228 "Writes occur atomically provided the size of the data in bytes\n"
229 "is not greater than the value of @code{PIPE_BUF}. Note that\n"
230 "the output port is likely to block if too much data (typically\n"
231 "equal to @code{PIPE_BUF}) has been written but not yet read\n"
232 "from the input port.")
233 #define FUNC_NAME s_scm_pipe
242 p_rd
= scm_fdes_to_port (fd
[0], "r", sym_read_pipe
);
243 p_wt
= scm_fdes_to_port (fd
[1], "w", sym_write_pipe
);
244 return scm_cons (p_rd
, p_wt
);
249 #ifdef HAVE_GETGROUPS
250 SCM_DEFINE (scm_getgroups
, "getgroups", 0, 0, 0,
252 "Return a vector of integers representing the current\n"
253 "supplementary group IDs.")
254 #define FUNC_NAME s_scm_getgroups
261 ngroups
= getgroups (0, NULL
);
264 else if (ngroups
== 0)
265 return scm_c_make_vector (0, SCM_BOOL_F
);
267 size
= ngroups
* sizeof (GETGROUPS_T
);
268 groups
= scm_malloc (size
);
269 ngroups
= getgroups (ngroups
, groups
);
271 result
= scm_c_make_vector (ngroups
, SCM_BOOL_F
);
272 while (--ngroups
>= 0)
273 SCM_SIMPLE_VECTOR_SET (result
, ngroups
, scm_from_ulong (groups
[ngroups
]));
281 #ifdef HAVE_SETGROUPS
282 SCM_DEFINE (scm_setgroups
, "setgroups", 1, 0, 0,
284 "Set the current set of supplementary group IDs to the integers\n"
285 "in the given vector @var{group_vec}. The return value is\n"
288 "Generally only the superuser can set the process group IDs.")
289 #define FUNC_NAME s_scm_setgroups
298 SCM_VALIDATE_VECTOR (SCM_ARG1
, group_vec
);
300 ngroups
= SCM_SIMPLE_VECTOR_LENGTH (group_vec
);
302 /* validate before allocating, so we don't have to worry about leaks */
303 for (i
= 0; i
< ngroups
; i
++)
305 unsigned long ulong_gid
;
307 SCM_VALIDATE_ULONG_COPY (1, SCM_SIMPLE_VECTOR_REF (group_vec
, i
),
310 if (gid
!= ulong_gid
)
311 SCM_OUT_OF_RANGE (1, SCM_SIMPLE_VECTOR_REF (group_vec
, i
));
314 size
= ngroups
* sizeof (GETGROUPS_T
);
315 if (size
/ sizeof (GETGROUPS_T
) != ngroups
)
316 SCM_OUT_OF_RANGE (SCM_ARG1
, scm_from_int (ngroups
));
317 groups
= scm_malloc (size
);
318 for(i
= 0; i
< ngroups
; i
++)
319 groups
[i
] = SCM_NUM2ULONG (1, SCM_SIMPLE_VECTOR_REF (group_vec
, i
));
321 result
= setgroups (ngroups
, groups
);
322 save_errno
= errno
; /* don't let free() touch errno */
327 return SCM_UNSPECIFIED
;
333 SCM_DEFINE (scm_getpwuid
, "getpw", 0, 1, 0,
335 "Look up an entry in the user database. @var{user} can be an\n"
336 "integer, a string, or omitted, giving the behaviour of\n"
337 "@code{getpwuid}, @code{getpwnam} or @code{getpwent}\n"
339 #define FUNC_NAME s_scm_getpwuid
341 struct passwd
*entry
;
343 SCM result
= scm_c_make_vector (7, SCM_UNSPECIFIED
);
344 if (SCM_UNBNDP (user
) || scm_is_false (user
))
346 SCM_SYSCALL (entry
= getpwent ());
352 else if (scm_is_integer (user
))
354 entry
= getpwuid (scm_to_int (user
));
358 WITH_STRING (user
, c_user
,
359 entry
= getpwnam (c_user
));
362 SCM_MISC_ERROR ("entry not found", SCM_EOL
);
364 SCM_SIMPLE_VECTOR_SET(result
, 0, scm_from_locale_string (entry
->pw_name
));
365 SCM_SIMPLE_VECTOR_SET(result
, 1, scm_from_locale_string (entry
->pw_passwd
));
366 SCM_SIMPLE_VECTOR_SET(result
, 2, scm_from_ulong (entry
->pw_uid
));
367 SCM_SIMPLE_VECTOR_SET(result
, 3, scm_from_ulong (entry
->pw_gid
));
368 SCM_SIMPLE_VECTOR_SET(result
, 4, scm_from_locale_string (entry
->pw_gecos
));
370 SCM_SIMPLE_VECTOR_SET(result
, 5, scm_from_locale_string (""));
372 SCM_SIMPLE_VECTOR_SET(result
, 5, scm_from_locale_string (entry
->pw_dir
));
373 if (!entry
->pw_shell
)
374 SCM_SIMPLE_VECTOR_SET(result
, 6, scm_from_locale_string (""));
376 SCM_SIMPLE_VECTOR_SET(result
, 6, scm_from_locale_string (entry
->pw_shell
));
380 #endif /* HAVE_GETPWENT */
384 SCM_DEFINE (scm_setpwent
, "setpw", 0, 1, 0,
386 "If called with a true argument, initialize or reset the password data\n"
387 "stream. Otherwise, close the stream. The @code{setpwent} and\n"
388 "@code{endpwent} procedures are implemented on top of this.")
389 #define FUNC_NAME s_scm_setpwent
391 if (SCM_UNBNDP (arg
) || scm_is_false (arg
))
395 return SCM_UNSPECIFIED
;
402 /* Combines getgrgid and getgrnam. */
403 SCM_DEFINE (scm_getgrgid
, "getgr", 0, 1, 0,
405 "Look up an entry in the group database. @var{name} can be an\n"
406 "integer, a string, or omitted, giving the behaviour of\n"
407 "@code{getgrgid}, @code{getgrnam} or @code{getgrent}\n"
409 #define FUNC_NAME s_scm_getgrgid
412 SCM result
= scm_c_make_vector (4, SCM_UNSPECIFIED
);
414 if (SCM_UNBNDP (name
) || scm_is_false (name
))
416 SCM_SYSCALL (entry
= getgrent ());
422 else if (scm_is_integer (name
))
423 SCM_SYSCALL (entry
= getgrgid (scm_to_int (name
)));
425 STRING_SYSCALL (name
, c_name
,
426 entry
= getgrnam (c_name
));
430 SCM_SIMPLE_VECTOR_SET(result
, 0, scm_from_locale_string (entry
->gr_name
));
431 SCM_SIMPLE_VECTOR_SET(result
, 1, scm_from_locale_string (entry
->gr_passwd
));
432 SCM_SIMPLE_VECTOR_SET(result
, 2, scm_from_ulong (entry
->gr_gid
));
433 SCM_SIMPLE_VECTOR_SET(result
, 3, scm_makfromstrs (-1, entry
->gr_mem
));
440 SCM_DEFINE (scm_setgrent
, "setgr", 0, 1, 0,
442 "If called with a true argument, initialize or reset the group data\n"
443 "stream. Otherwise, close the stream. The @code{setgrent} and\n"
444 "@code{endgrent} procedures are implemented on top of this.")
445 #define FUNC_NAME s_scm_setgrent
447 if (SCM_UNBNDP (arg
) || scm_is_false (arg
))
451 return SCM_UNSPECIFIED
;
454 #endif /* HAVE_GETGRENT */
457 #ifdef HAVE_GETRLIMIT
459 SCM_SYMBOL (sym_as
, "as");
462 SCM_SYMBOL (sym_core
, "core");
465 SCM_SYMBOL (sym_cpu
, "cpu");
468 SCM_SYMBOL (sym_data
, "data");
471 SCM_SYMBOL (sym_fsize
, "fsize");
473 #ifdef RLIMIT_MEMLOCK
474 SCM_SYMBOL (sym_memlock
, "memlock");
476 #ifdef RLIMIT_MSGQUEUE
477 SCM_SYMBOL (sym_msgqueue
, "msgqueue");
480 SCM_SYMBOL (sym_nice
, "nice");
483 SCM_SYMBOL (sym_nofile
, "nofile");
486 SCM_SYMBOL (sym_nproc
, "nproc");
489 SCM_SYMBOL (sym_rss
, "rss");
492 SCM_SYMBOL (sym_rtprio
, "rtprio");
495 SCM_SYMBOL (sym_rttime
, "rttime");
497 #ifdef RLIMIT_SIGPENDING
498 SCM_SYMBOL (sym_sigpending
, "sigpending");
501 SCM_SYMBOL (sym_stack
, "stack");
505 scm_to_resource (SCM s
, const char *func
, int pos
)
507 if (scm_is_number (s
))
508 return scm_to_int (s
);
510 SCM_ASSERT_TYPE (scm_is_symbol (s
), s
, pos
, func
, "symbol");
513 if (scm_is_eq (s
, sym_as
))
517 if (scm_is_eq (s
, sym_core
))
521 if (scm_is_eq (s
, sym_cpu
))
525 if (scm_is_eq (s
, sym_data
))
529 if (scm_is_eq (s
, sym_fsize
))
532 #ifdef RLIMIT_MEMLOCK
533 if (scm_is_eq (s
, sym_memlock
))
534 return RLIMIT_MEMLOCK
;
536 #ifdef RLIMIT_MSGQUEUE
537 if (scm_is_eq (s
, sym_msgqueue
))
538 return RLIMIT_MSGQUEUE
;
541 if (scm_is_eq (s
, sym_nice
))
545 if (scm_is_eq (s
, sym_nofile
))
546 return RLIMIT_NOFILE
;
549 if (scm_is_eq (s
, sym_nproc
))
553 if (scm_is_eq (s
, sym_rss
))
557 if (scm_is_eq (s
, sym_rtprio
))
558 return RLIMIT_RTPRIO
;
561 if (scm_is_eq (s
, sym_rttime
))
562 return RLIMIT_RTPRIO
;
564 #ifdef RLIMIT_SIGPENDING
565 if (scm_is_eq (s
, sym_sigpending
))
566 return RLIMIT_SIGPENDING
;
569 if (scm_is_eq (s
, sym_stack
))
573 scm_misc_error (func
, "invalid rlimit resource ~A", scm_list_1 (s
));
577 SCM_DEFINE (scm_getrlimit
, "getrlimit", 1, 0, 0,
579 "Get a resource limit for this process. @var{resource} identifies the resource,\n"
580 "either as an integer or as a symbol. For example, @code{(getrlimit 'stack)}\n"
581 "gets the limits associated with @code{RLIMIT_STACK}.\n\n"
582 "@code{getrlimit} returns two values, the soft and the hard limit. If no\n"
583 "limit is set for the resource in question, the returned limit will be @code{#f}.")
584 #define FUNC_NAME s_scm_getrlimit
587 struct rlimit lim
= { 0, 0 };
589 iresource
= scm_to_resource (resource
, FUNC_NAME
, 1);
591 if (getrlimit (iresource
, &lim
) != 0)
592 scm_syserror (FUNC_NAME
);
594 return scm_values (scm_list_2 ((lim
.rlim_cur
== RLIM_INFINITY
) ? SCM_BOOL_F
595 : scm_from_long (lim
.rlim_cur
),
596 (lim
.rlim_max
== RLIM_INFINITY
) ? SCM_BOOL_F
597 : scm_from_long (lim
.rlim_max
)));
602 #ifdef HAVE_SETRLIMIT
603 SCM_DEFINE (scm_setrlimit
, "setrlimit", 3, 0, 0,
604 (SCM resource
, SCM soft
, SCM hard
),
605 "Set a resource limit for this process. @var{resource} identifies the resource,\n"
606 "either as an integer or as a symbol. @var{soft} and @var{hard} should be integers,\n"
607 "or @code{#f} to indicate no limit (i.e., @code{RLIM_INFINITY}).\n\n"
608 "For example, @code{(setrlimit 'stack 150000 300000)} sets the @code{RLIMIT_STACK}\n"
609 "limit to 150 kilobytes, with a hard limit of 300 kB.")
610 #define FUNC_NAME s_scm_setrlimit
613 struct rlimit lim
= { 0, 0 };
615 iresource
= scm_to_resource (resource
, FUNC_NAME
, 1);
617 lim
.rlim_cur
= scm_is_false (soft
) ? RLIM_INFINITY
: scm_to_long (soft
);
618 lim
.rlim_max
= scm_is_false (hard
) ? RLIM_INFINITY
: scm_to_long (hard
);
620 if (setrlimit (iresource
, &lim
) != 0)
621 scm_syserror (FUNC_NAME
);
623 return SCM_UNSPECIFIED
;
626 #endif /* HAVE_SETRLIMIT */
627 #endif /* HAVE_GETRLIMIT */
630 SCM_DEFINE (scm_kill
, "kill", 2, 0, 0,
632 "Sends a signal to the specified process or group of processes.\n\n"
633 "@var{pid} specifies the processes to which the signal is sent:\n\n"
635 "@item @var{pid} greater than 0\n"
636 "The process whose identifier is @var{pid}.\n"
637 "@item @var{pid} equal to 0\n"
638 "All processes in the current process group.\n"
639 "@item @var{pid} less than -1\n"
640 "The process group whose identifier is -@var{pid}\n"
641 "@item @var{pid} equal to -1\n"
642 "If the process is privileged, all processes except for some special\n"
643 "system processes. Otherwise, all processes with the current effective\n"
646 "@var{sig} should be specified using a variable corresponding to\n"
647 "the Unix symbolic name, e.g.,\n\n"
652 "Interrupt signal.\n"
654 #define FUNC_NAME s_scm_kill
656 /* Signal values are interned in scm_init_posix(). */
658 if (kill (scm_to_int (pid
), scm_to_int (sig
)) != 0)
661 /* Mingw has raise(), but not kill(). (Other raw DOS environments might
662 be similar.) Use raise() when the requested pid is our own process,
664 if (scm_to_int (pid
) == getpid ())
666 if (raise (scm_to_int (sig
)) != 0)
678 return SCM_UNSPECIFIED
;
683 SCM_DEFINE (scm_waitpid
, "waitpid", 1, 1, 0,
684 (SCM pid
, SCM options
),
685 "This procedure collects status information from a child process which\n"
686 "has terminated or (optionally) stopped. Normally it will\n"
687 "suspend the calling process until this can be done. If more than one\n"
688 "child process is eligible then one will be chosen by the operating system.\n\n"
689 "The value of @var{pid} determines the behaviour:\n\n"
691 "@item @var{pid} greater than 0\n"
692 "Request status information from the specified child process.\n"
693 "@item @var{pid} equal to -1 or WAIT_ANY\n"
694 "Request status information for any child process.\n"
695 "@item @var{pid} equal to 0 or WAIT_MYPGRP\n"
696 "Request status information for any child process in the current process\n"
698 "@item @var{pid} less than -1\n"
699 "Request status information for any child process whose process group ID\n"
702 "The @var{options} argument, if supplied, should be the bitwise OR of the\n"
703 "values of zero or more of the following variables:\n\n"
705 "Return immediately even if there are no child processes to be collected.\n"
707 "@defvar WUNTRACED\n"
708 "Report status information for stopped processes as well as terminated\n"
711 "The return value is a pair containing:\n\n"
714 "The process ID of the child process, or 0 if @code{WNOHANG} was\n"
715 "specified and no process was collected.\n"
717 "The integer status value.\n"
719 #define FUNC_NAME s_scm_waitpid
724 if (SCM_UNBNDP (options
))
728 /* Flags are interned in scm_init_posix. */
729 ioptions
= scm_to_int (options
);
731 SCM_SYSCALL (i
= waitpid (scm_to_int (pid
), &status
, ioptions
));
734 return scm_cons (scm_from_int (i
), scm_from_int (status
));
737 #endif /* HAVE_WAITPID */
740 SCM_DEFINE (scm_status_exit_val
, "status:exit-val", 1, 0, 0,
742 "Return the exit status value, as would be set if a process\n"
743 "ended normally through a call to @code{exit} or @code{_exit},\n"
744 "if any, otherwise @code{#f}.")
745 #define FUNC_NAME s_scm_status_exit_val
749 /* On Ultrix, the WIF... macros assume their argument is an lvalue;
751 lstatus
= scm_to_int (status
);
752 if (WIFEXITED (lstatus
))
753 return (scm_from_int (WEXITSTATUS (lstatus
)));
759 SCM_DEFINE (scm_status_term_sig
, "status:term-sig", 1, 0, 0,
761 "Return the signal number which terminated the process, if any,\n"
762 "otherwise @code{#f}.")
763 #define FUNC_NAME s_scm_status_term_sig
767 lstatus
= scm_to_int (status
);
768 if (WIFSIGNALED (lstatus
))
769 return scm_from_int (WTERMSIG (lstatus
));
775 SCM_DEFINE (scm_status_stop_sig
, "status:stop-sig", 1, 0, 0,
777 "Return the signal number which stopped the process, if any,\n"
778 "otherwise @code{#f}.")
779 #define FUNC_NAME s_scm_status_stop_sig
783 lstatus
= scm_to_int (status
);
784 if (WIFSTOPPED (lstatus
))
785 return scm_from_int (WSTOPSIG (lstatus
));
790 #endif /* __MINGW32__ */
793 SCM_DEFINE (scm_getppid
, "getppid", 0, 0, 0,
795 "Return an integer representing the process ID of the parent\n"
797 #define FUNC_NAME s_scm_getppid
799 return scm_from_int (getppid ());
802 #endif /* HAVE_GETPPID */
806 SCM_DEFINE (scm_getuid
, "getuid", 0, 0, 0,
808 "Return an integer representing the current real user ID.")
809 #define FUNC_NAME s_scm_getuid
811 return scm_from_int (getuid ());
817 SCM_DEFINE (scm_getgid
, "getgid", 0, 0, 0,
819 "Return an integer representing the current real group ID.")
820 #define FUNC_NAME s_scm_getgid
822 return scm_from_int (getgid ());
828 SCM_DEFINE (scm_geteuid
, "geteuid", 0, 0, 0,
830 "Return an integer representing the current effective user ID.\n"
831 "If the system does not support effective IDs, then the real ID\n"
832 "is returned. @code{(provided? 'EIDs)} reports whether the\n"
833 "system supports effective IDs.")
834 #define FUNC_NAME s_scm_geteuid
837 return scm_from_int (geteuid ());
839 return scm_from_int (getuid ());
845 SCM_DEFINE (scm_getegid
, "getegid", 0, 0, 0,
847 "Return an integer representing the current effective group ID.\n"
848 "If the system does not support effective IDs, then the real ID\n"
849 "is returned. @code{(provided? 'EIDs)} reports whether the\n"
850 "system supports effective IDs.")
851 #define FUNC_NAME s_scm_getegid
854 return scm_from_int (getegid ());
856 return scm_from_int (getgid ());
862 SCM_DEFINE (scm_setuid
, "setuid", 1, 0, 0,
864 "Sets both the real and effective user IDs to the integer @var{id}, provided\n"
865 "the process has appropriate privileges.\n"
866 "The return value is unspecified.")
867 #define FUNC_NAME s_scm_setuid
869 if (setuid (scm_to_int (id
)) != 0)
871 return SCM_UNSPECIFIED
;
875 SCM_DEFINE (scm_setgid
, "setgid", 1, 0, 0,
877 "Sets both the real and effective group IDs to the integer @var{id}, provided\n"
878 "the process has appropriate privileges.\n"
879 "The return value is unspecified.")
880 #define FUNC_NAME s_scm_setgid
882 if (setgid (scm_to_int (id
)) != 0)
884 return SCM_UNSPECIFIED
;
888 SCM_DEFINE (scm_seteuid
, "seteuid", 1, 0, 0,
890 "Sets the effective user ID to the integer @var{id}, provided the process\n"
891 "has appropriate privileges. If effective IDs are not supported, the\n"
892 "real ID is set instead -- @code{(provided? 'EIDs)} reports whether the\n"
893 "system supports effective IDs.\n"
894 "The return value is unspecified.")
895 #define FUNC_NAME s_scm_seteuid
900 rv
= seteuid (scm_to_int (id
));
902 rv
= setuid (scm_to_int (id
));
906 return SCM_UNSPECIFIED
;
909 #endif /* __MINGW32__ */
913 SCM_DEFINE (scm_setegid
, "setegid", 1, 0, 0,
915 "Sets the effective group ID to the integer @var{id}, provided the process\n"
916 "has appropriate privileges. If effective IDs are not supported, the\n"
917 "real ID is set instead -- @code{(provided? 'EIDs)} reports whether the\n"
918 "system supports effective IDs.\n"
919 "The return value is unspecified.")
920 #define FUNC_NAME s_scm_setegid
925 rv
= setegid (scm_to_int (id
));
927 rv
= setgid (scm_to_int (id
));
931 return SCM_UNSPECIFIED
;
939 SCM_DEFINE (scm_getpgrp
, "getpgrp", 0, 0, 0,
941 "Return an integer representing the current process group ID.\n"
942 "This is the POSIX definition, not BSD.")
943 #define FUNC_NAME s_scm_getpgrp
946 fn
= (int (*) ()) getpgrp
;
947 return scm_from_int (fn (0));
950 #endif /* HAVE_GETPGRP */
954 SCM_DEFINE (scm_setpgid
, "setpgid", 2, 0, 0,
956 "Move the process @var{pid} into the process group @var{pgid}. @var{pid} or\n"
957 "@var{pgid} must be integers: they can be zero to indicate the ID of the\n"
959 "Fails on systems that do not support job control.\n"
960 "The return value is unspecified.")
961 #define FUNC_NAME s_scm_setpgid
963 /* FIXME(?): may be known as setpgrp. */
964 if (setpgid (scm_to_int (pid
), scm_to_int (pgid
)) != 0)
966 return SCM_UNSPECIFIED
;
969 #endif /* HAVE_SETPGID */
972 SCM_DEFINE (scm_setsid
, "setsid", 0, 0, 0,
974 "Creates a new session. The current process becomes the session leader\n"
975 "and is put in a new process group. The process will be detached\n"
976 "from its controlling terminal if it has one.\n"
977 "The return value is an integer representing the new process group ID.")
978 #define FUNC_NAME s_scm_setsid
980 pid_t sid
= setsid ();
983 return SCM_UNSPECIFIED
;
986 #endif /* HAVE_SETSID */
989 SCM_DEFINE (scm_getsid
, "getsid", 1, 0, 0,
991 "Returns the session ID of process @var{pid}. (The session\n"
992 "ID of a process is the process group ID of its session leader.)")
993 #define FUNC_NAME s_scm_getsid
995 return scm_from_int (getsid (scm_to_int (pid
)));
998 #endif /* HAVE_GETSID */
1001 /* ttyname returns its result in a single static buffer, hence
1002 scm_i_misc_mutex for thread safety. In glibc 2.3.2 two threads
1003 continuously calling ttyname will otherwise get an overwrite quite
1006 ttyname_r (when available) could be used instead of scm_i_misc_mutex, but
1007 there's probably little to be gained in either speed or parallelism. */
1010 SCM_DEFINE (scm_ttyname
, "ttyname", 1, 0, 0,
1012 "Return a string with the name of the serial terminal device\n"
1013 "underlying @var{port}.")
1014 #define FUNC_NAME s_scm_ttyname
1018 SCM ret
= SCM_BOOL_F
;
1020 port
= SCM_COERCE_OUTPORT (port
);
1021 SCM_VALIDATE_OPPORT (1, port
);
1022 if (!SCM_FPORTP (port
))
1024 fd
= SCM_FPORT_FDES (port
);
1026 scm_i_scm_pthread_mutex_lock (&scm_i_misc_mutex
);
1028 SCM_SYSCALL (result
= ttyname (fd
));
1031 result
= strdup (result
);
1033 scm_i_pthread_mutex_unlock (&scm_i_misc_mutex
);
1041 ret
= scm_take_locale_string (result
);
1046 #endif /* HAVE_TTYNAME */
1049 /* For thread safety "buf" is used instead of NULL for the ctermid static
1050 buffer. Actually it's unlikely the controlling terminal will change
1051 during program execution, and indeed on glibc (2.3.2) it's always just
1052 "/dev/tty", but L_ctermid on the stack is easy and fast and guarantees
1053 safety everywhere. */
1055 SCM_DEFINE (scm_ctermid
, "ctermid", 0, 0, 0,
1057 "Return a string containing the file name of the controlling\n"
1058 "terminal for the current process.")
1059 #define FUNC_NAME s_scm_ctermid
1061 char buf
[L_ctermid
];
1062 char *result
= ctermid (buf
);
1063 if (*result
== '\0')
1065 return scm_from_locale_string (result
);
1068 #endif /* HAVE_CTERMID */
1070 #ifdef HAVE_TCGETPGRP
1071 SCM_DEFINE (scm_tcgetpgrp
, "tcgetpgrp", 1, 0, 0,
1073 "Return the process group ID of the foreground process group\n"
1074 "associated with the terminal open on the file descriptor\n"
1075 "underlying @var{port}.\n"
1077 "If there is no foreground process group, the return value is a\n"
1078 "number greater than 1 that does not match the process group ID\n"
1079 "of any existing process group. This can happen if all of the\n"
1080 "processes in the job that was formerly the foreground job have\n"
1081 "terminated, and no other job has yet been moved into the\n"
1083 #define FUNC_NAME s_scm_tcgetpgrp
1088 port
= SCM_COERCE_OUTPORT (port
);
1090 SCM_VALIDATE_OPFPORT (1, port
);
1091 fd
= SCM_FPORT_FDES (port
);
1092 if ((pgid
= tcgetpgrp (fd
)) == -1)
1094 return scm_from_int (pgid
);
1097 #endif /* HAVE_TCGETPGRP */
1099 #ifdef HAVE_TCSETPGRP
1100 SCM_DEFINE (scm_tcsetpgrp
, "tcsetpgrp", 2, 0, 0,
1101 (SCM port
, SCM pgid
),
1102 "Set the foreground process group ID for the terminal used by the file\n"
1103 "descriptor underlying @var{port} to the integer @var{pgid}.\n"
1104 "The calling process\n"
1105 "must be a member of the same session as @var{pgid} and must have the same\n"
1106 "controlling terminal. The return value is unspecified.")
1107 #define FUNC_NAME s_scm_tcsetpgrp
1111 port
= SCM_COERCE_OUTPORT (port
);
1113 SCM_VALIDATE_OPFPORT (1, port
);
1114 fd
= SCM_FPORT_FDES (port
);
1115 if (tcsetpgrp (fd
, scm_to_int (pgid
)) == -1)
1117 return SCM_UNSPECIFIED
;
1120 #endif /* HAVE_TCSETPGRP */
1122 SCM_DEFINE (scm_execl
, "execl", 1, 0, 1,
1123 (SCM filename
, SCM args
),
1124 "Executes the file named by @var{filename} as a new process image.\n"
1125 "The remaining arguments are supplied to the process; from a C program\n"
1126 "they are accessible as the @code{argv} argument to @code{main}.\n"
1127 "Conventionally the first @var{arg} is the same as @var{filename}.\n"
1128 "All arguments must be strings.\n\n"
1129 "If @var{arg} is missing, @var{path} is executed with a null\n"
1130 "argument list, which may have system-dependent side-effects.\n\n"
1131 "This procedure is currently implemented using the @code{execv} system\n"
1132 "call, but we call it @code{execl} because of its Scheme calling interface.")
1133 #define FUNC_NAME s_scm_execl
1138 scm_dynwind_begin (0);
1140 exec_file
= scm_to_locale_string (filename
);
1141 scm_dynwind_free (exec_file
);
1143 exec_argv
= scm_i_allocate_string_pointers (args
);
1145 execv (exec_file
, exec_argv
);
1154 SCM_DEFINE (scm_execlp
, "execlp", 1, 0, 1,
1155 (SCM filename
, SCM args
),
1156 "Similar to @code{execl}, however if\n"
1157 "@var{filename} does not contain a slash\n"
1158 "then the file to execute will be located by searching the\n"
1159 "directories listed in the @code{PATH} environment variable.\n\n"
1160 "This procedure is currently implemented using the @code{execvp} system\n"
1161 "call, but we call it @code{execlp} because of its Scheme calling interface.")
1162 #define FUNC_NAME s_scm_execlp
1167 scm_dynwind_begin (0);
1169 exec_file
= scm_to_locale_string (filename
);
1170 scm_dynwind_free (exec_file
);
1172 exec_argv
= scm_i_allocate_string_pointers (args
);
1174 execvp (exec_file
, exec_argv
);
1184 /* OPTIMIZE-ME: scm_execle doesn't need malloced copies of the environment
1185 list strings the way environ_list_to_c gives. */
1187 SCM_DEFINE (scm_execle
, "execle", 2, 0, 1,
1188 (SCM filename
, SCM env
, SCM args
),
1189 "Similar to @code{execl}, but the environment of the new process is\n"
1190 "specified by @var{env}, which must be a list of strings as returned by the\n"
1191 "@code{environ} procedure.\n\n"
1192 "This procedure is currently implemented using the @code{execve} system\n"
1193 "call, but we call it @code{execle} because of its Scheme calling interface.")
1194 #define FUNC_NAME s_scm_execle
1200 scm_dynwind_begin (0);
1202 exec_file
= scm_to_locale_string (filename
);
1203 scm_dynwind_free (exec_file
);
1205 exec_argv
= scm_i_allocate_string_pointers (args
);
1206 exec_env
= scm_i_allocate_string_pointers (env
);
1208 execve (exec_file
, exec_argv
, exec_env
);
1218 SCM_DEFINE (scm_fork
, "primitive-fork", 0, 0, 0,
1220 "Creates a new \"child\" process by duplicating the current \"parent\" process.\n"
1221 "In the child the return value is 0. In the parent the return value is\n"
1222 "the integer process ID of the child.\n\n"
1223 "This procedure has been renamed from @code{fork} to avoid a naming conflict\n"
1224 "with the scsh fork.")
1225 #define FUNC_NAME s_scm_fork
1228 scm_i_finalizer_pre_fork ();
1229 if (scm_ilength (scm_all_threads ()) != 1)
1230 /* Other threads may be holding on to resources that Guile needs --
1231 it is not safe to permit one thread to fork while others are
1234 In addition, POSIX clearly specifies that if a multi-threaded
1235 program forks, the child must only call functions that are
1236 async-signal-safe. We can't guarantee that in general. The best
1237 we can do is to allow forking only very early, before any call to
1238 sigaction spawns the signal-handling thread. */
1240 (scm_from_latin1_string
1241 ("warning: call to primitive-fork while multiple threads are running;\n"
1242 " further behavior unspecified. See \"Processes\" in the\n"
1243 " manual, for more information.\n"),
1244 scm_current_warning_port ());
1248 return scm_from_int (pid
);
1252 /* Since Guile uses threads, we have to be very careful to avoid calling
1253 functions that are not async-signal-safe in the child. That's why
1254 this function is implemented in C. */
1256 scm_open_process (SCM mode
, SCM prog
, SCM args
)
1257 #define FUNC_NAME "open-process"
1260 int reading
, writing
;
1261 int c2p
[2]; /* Child to parent. */
1262 int p2c
[2]; /* Parent to child. */
1263 int in
= -1, out
= -1, err
= -1;
1269 exec_file
= scm_to_locale_string (prog
);
1270 exec_argv
= scm_i_allocate_string_pointers (scm_cons (prog
, args
));
1272 mode_bits
= scm_i_mode_bits (mode
);
1273 reading
= mode_bits
& SCM_RDNG
;
1274 writing
= mode_bits
& SCM_WRTNG
;
1280 int errno_save
= errno
;
1292 int errno_save
= errno
;
1308 if (SCM_OPOUTFPORTP ((port
= scm_current_error_port ())))
1309 err
= SCM_FPORT_FDES (port
);
1310 if (out
== -1 && SCM_OPOUTFPORTP ((port
= scm_current_output_port ())))
1311 out
= SCM_FPORT_FDES (port
);
1312 if (in
== -1 && SCM_OPINFPORTP ((port
= scm_current_input_port ())))
1313 in
= SCM_FPORT_FDES (port
);
1316 #if defined (HAVE_GETRLIMIT) && defined (RLIMIT_NOFILE)
1318 struct rlimit lim
= { 0, 0 };
1319 if (getrlimit (RLIMIT_NOFILE
, &lim
) == 0)
1320 max_fd
= lim
.rlim_cur
;
1328 int errno_save
= errno
;
1347 SCM read_port
= SCM_BOOL_F
, write_port
= SCM_BOOL_F
;
1349 /* There is no sense in catching errors on close(). */
1353 read_port
= scm_fdes_to_port (c2p
[0], "r", sym_read_pipe
);
1354 scm_setvbuf (read_port
, scm_from_int (_IONBF
), SCM_UNDEFINED
);
1359 write_port
= scm_fdes_to_port (p2c
[1], "w", sym_write_pipe
);
1360 scm_setvbuf (write_port
, scm_from_int (_IONBF
), SCM_UNDEFINED
);
1364 (scm_list_3 (read_port
, write_port
, scm_from_int (pid
)));
1373 /* Close all file descriptors in ports inherited from the parent
1374 except for in, out, and err. Heavy-handed, but robust. */
1376 if (max_fd
!= in
&& max_fd
!= out
&& max_fd
!= err
)
1379 /* Ignore errors on these open() calls. */
1381 in
= open ("/dev/null", O_RDONLY
);
1383 out
= open ("/dev/null", O_WRONLY
);
1385 err
= open ("/dev/null", O_WRONLY
);
1390 do out
= dup (out
); while (errno
== EINTR
);
1392 do err
= dup (err
); while (errno
== EINTR
);
1393 do dup2 (in
, 0); while (errno
== EINTR
);
1399 do err
= dup (err
); while (errno
== EINTR
);
1400 do dup2 (out
, 1); while (errno
== EINTR
);
1405 do dup2 (err
, 2); while (errno
== EINTR
);
1409 execvp (exec_file
, exec_argv
);
1411 /* The exec failed! There is nothing sensible to do. */
1414 char *msg
= strerror (errno
);
1415 fprintf (fdopen (err
, "a"), "In execlp of %s: %s\n",
1419 _exit (EXIT_FAILURE
);
1424 #endif /* HAVE_FORK */
1427 # include "win32-uname.h"
1430 #if defined (HAVE_UNAME) || defined (__MINGW32__)
1431 SCM_DEFINE (scm_uname
, "uname", 0, 0, 0,
1433 "Return an object with some information about the computer\n"
1434 "system the program is running on.")
1435 #define FUNC_NAME s_scm_uname
1438 SCM result
= scm_c_make_vector (5, SCM_UNSPECIFIED
);
1439 if (uname (&buf
) < 0)
1441 SCM_SIMPLE_VECTOR_SET(result
, 0, scm_from_locale_string (buf
.sysname
));
1442 SCM_SIMPLE_VECTOR_SET(result
, 1, scm_from_locale_string (buf
.nodename
));
1443 SCM_SIMPLE_VECTOR_SET(result
, 2, scm_from_locale_string (buf
.release
));
1444 SCM_SIMPLE_VECTOR_SET(result
, 3, scm_from_locale_string (buf
.version
));
1445 SCM_SIMPLE_VECTOR_SET(result
, 4, scm_from_locale_string (buf
.machine
));
1448 SCM_SIMPLE_VECTOR_SET(result, 5, scm_from_locale_string (buf.domainname));
1453 #endif /* HAVE_UNAME */
1455 SCM_DEFINE (scm_environ
, "environ", 0, 1, 0,
1457 "If @var{env} is omitted, return the current environment (in the\n"
1458 "Unix sense) as a list of strings. Otherwise set the current\n"
1459 "environment, which is also the default environment for child\n"
1460 "processes, to the supplied list of strings. Each member of\n"
1461 "@var{env} should be of the form @code{NAME=VALUE} and values of\n"
1462 "@code{NAME} should not be duplicated. If @var{env} is supplied\n"
1463 "then the return value is unspecified.")
1464 #define FUNC_NAME s_scm_environ
1466 if (SCM_UNBNDP (env
))
1467 return scm_makfromstrs (-1, environ
);
1470 environ
= scm_i_allocate_string_pointers (env
);
1471 return SCM_UNSPECIFIED
;
1478 SCM_DEFINE (scm_tmpnam
, "tmpnam", 0, 0, 0,
1480 "Return a name in the file system that does not match any\n"
1481 "existing file. However there is no guarantee that another\n"
1482 "process will not create the file after @code{tmpnam} is called.\n"
1483 "Care should be taken if opening the file, e.g., use the\n"
1484 "@code{O_EXCL} open flag or use @code{mkstemp!} instead.")
1485 #define FUNC_NAME s_scm_tmpnam
1487 char name
[L_tmpnam
];
1490 SCM_SYSCALL (rv
= tmpnam (name
));
1492 /* not SCM_SYSERROR since errno probably not set. */
1493 SCM_MISC_ERROR ("tmpnam failed", SCM_EOL
);
1494 return scm_from_locale_string (name
);
1500 SCM_DEFINE (scm_tmpfile
, "tmpfile", 0, 0, 0,
1502 "Return an input/output port to a unique temporary file\n"
1503 "named using the path prefix @code{P_tmpdir} defined in\n"
1505 "The file is automatically deleted when the port is closed\n"
1506 "or the program terminates.")
1507 #define FUNC_NAME s_scm_tmpfile
1512 if (! (rv
= tmpfile ()))
1516 fd
= dup (fileno (rv
));
1520 /* FIXME: leaking the file, it will never be closed! */
1523 return scm_fdes_to_port (fd
, "w+", SCM_BOOL_F
);
1527 SCM_DEFINE (scm_utime
, "utime", 1, 5, 0,
1528 (SCM pathname
, SCM actime
, SCM modtime
, SCM actimens
, SCM modtimens
,
1530 "@code{utime} sets the access and modification times for the\n"
1531 "file named by @var{pathname}. If @var{actime} or @var{modtime} is\n"
1532 "not supplied, then the current time is used. @var{actime} and\n"
1533 "@var{modtime} must be integer time values as returned by the\n"
1534 "@code{current-time} procedure.\n\n"
1535 "The optional @var{actimens} and @var{modtimens} are nanoseconds\n"
1536 "to add @var{actime} and @var{modtime}. Nanosecond precision is\n"
1537 "only supported on some combinations of file systems and operating\n"
1540 "(utime \"foo\" (- (current-time) 3600))\n"
1542 "will set the access time to one hour in the past and the\n"
1543 "modification time to the current time.")
1544 #define FUNC_NAME s_scm_utime
1547 time_t atim_sec
, mtim_sec
;
1548 long atim_nsec
, mtim_nsec
;
1551 if (SCM_UNBNDP (actime
))
1553 #ifdef HAVE_UTIMENSAT
1555 atim_nsec
= UTIME_NOW
;
1557 SCM_SYSCALL (time (&atim_sec
));
1563 atim_sec
= SCM_NUM2ULONG (2, actime
);
1564 if (SCM_UNBNDP (actimens
))
1567 atim_nsec
= SCM_NUM2LONG (4, actimens
);
1570 if (SCM_UNBNDP (modtime
))
1572 #ifdef HAVE_UTIMENSAT
1574 mtim_nsec
= UTIME_NOW
;
1576 SCM_SYSCALL (time (&mtim_sec
));
1582 mtim_sec
= SCM_NUM2ULONG (3, modtime
);
1583 if (SCM_UNBNDP (modtimens
))
1586 mtim_nsec
= SCM_NUM2LONG (5, modtimens
);
1589 if (SCM_UNBNDP (flags
))
1592 f
= SCM_NUM2INT (6, flags
);
1594 #ifdef HAVE_UTIMENSAT
1596 struct timespec times
[2];
1597 times
[0].tv_sec
= atim_sec
;
1598 times
[0].tv_nsec
= atim_nsec
;
1599 times
[1].tv_sec
= mtim_sec
;
1600 times
[1].tv_nsec
= mtim_nsec
;
1602 STRING_SYSCALL (pathname
, c_pathname
,
1603 rv
= utimensat (AT_FDCWD
, c_pathname
, times
, f
));
1608 utm
.actime
= atim_sec
;
1609 utm
.modtime
= mtim_sec
;
1610 /* Silence warnings. */
1615 scm_out_of_range(FUNC_NAME
, flags
);
1617 STRING_SYSCALL (pathname
, c_pathname
,
1618 rv
= utime (c_pathname
, &utm
));
1624 return SCM_UNSPECIFIED
;
1628 SCM_DEFINE (scm_getpid
, "getpid", 0, 0, 0,
1630 "Return an integer representing the current process ID.")
1631 #define FUNC_NAME s_scm_getpid
1633 return scm_from_ulong (getpid ());
1637 SCM_DEFINE (scm_putenv
, "putenv", 1, 0, 0,
1639 "Modifies the environment of the current process, which is also\n"
1640 "the default environment inherited by child processes. If\n"
1641 "@var{str} is of the form @code{NAME=VALUE} then it will be\n"
1642 "written directly into the environment, replacing any existing\n"
1643 "environment string with name matching @code{NAME}. If\n"
1644 "@var{str} does not contain an equal sign, then any existing\n"
1645 "string with name matching @var{str} will be removed.\n"
1647 "The return value is unspecified.")
1648 #define FUNC_NAME s_scm_putenv
1651 char *c_str
= scm_to_locale_string (str
);
1653 /* Leave C_STR in the environment. */
1655 /* Gnulib's `putenv' module honors the semantics described above. */
1656 rv
= putenv (c_str
);
1660 return SCM_UNSPECIFIED
;
1664 /* This mutex is used to serialize invocations of `setlocale ()' on non-GNU
1665 systems (i.e., systems where a reentrant locale API is not available). It
1666 is also acquired before calls to `nl_langinfo ()'. See `i18n.c' for
1668 scm_i_pthread_mutex_t scm_i_locale_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
1670 #ifdef HAVE_SETLOCALE
1672 SCM_DEFINE (scm_setlocale
, "setlocale", 1, 1, 0,
1673 (SCM category
, SCM locale
),
1674 "If @var{locale} is omitted, return the current value of the\n"
1675 "specified locale category as a system-dependent string.\n"
1676 "@var{category} should be specified using the values\n"
1677 "@code{LC_COLLATE}, @code{LC_ALL} etc.\n"
1679 "Otherwise the specified locale category is set to the string\n"
1680 "@var{locale} and the new value is returned as a\n"
1681 "system-dependent string. If @var{locale} is an empty string,\n"
1682 "the locale will be set using environment variables.\n"
1684 "When the locale is changed, the character encoding of the new\n"
1685 "locale (UTF-8, ISO-8859-1, etc.) is used for the current\n"
1686 "input, output, and error ports\n")
1687 #define FUNC_NAME s_scm_setlocale
1694 scm_dynwind_begin (0);
1696 if (SCM_UNBNDP (locale
))
1702 clocale
= scm_to_locale_string (locale
);
1703 scm_dynwind_free (clocale
);
1706 c_category
= scm_i_to_lc_category (category
, 1);
1708 scm_i_pthread_mutex_lock (&scm_i_locale_mutex
);
1709 rv
= setlocale (c_category
, clocale
);
1710 scm_i_pthread_mutex_unlock (&scm_i_locale_mutex
);
1714 /* POSIX and C99 don't say anything about setlocale setting errno, so
1715 force a sensible value here. glibc leaves ENOENT, which would be
1716 fine, but it's not a documented feature. */
1721 enc
= locale_charset ();
1723 /* Set the default encoding for new ports. */
1724 scm_i_set_default_port_encoding (enc
);
1726 /* Set the encoding for the stdio ports. */
1727 scm_i_set_port_encoding_x (scm_current_input_port (), enc
);
1728 scm_i_set_port_encoding_x (scm_current_output_port (), enc
);
1729 scm_i_set_port_encoding_x (scm_current_error_port (), enc
);
1732 return scm_from_locale_string (rv
);
1735 #endif /* HAVE_SETLOCALE */
1738 SCM_DEFINE (scm_mknod
, "mknod", 4, 0, 0,
1739 (SCM path
, SCM type
, SCM perms
, SCM dev
),
1740 "Creates a new special file, such as a file corresponding to a device.\n"
1741 "@var{path} specifies the name of the file. @var{type} should\n"
1742 "be one of the following symbols:\n"
1743 "regular, directory, symlink, block-special, char-special,\n"
1744 "fifo, or socket. @var{perms} (an integer) specifies the file permissions.\n"
1745 "@var{dev} (an integer) specifies which device the special file refers\n"
1746 "to. Its exact interpretation depends on the kind of special file\n"
1747 "being created.\n\n"
1750 "(mknod \"/dev/fd0\" 'block-special #o660 (+ (* 2 256) 2))\n"
1752 "The return value is unspecified.")
1753 #define FUNC_NAME s_scm_mknod
1759 SCM_VALIDATE_STRING (1, path
);
1760 SCM_VALIDATE_SYMBOL (2, type
);
1762 p
= scm_i_symbol_chars (type
);
1763 if (strcmp (p
, "regular") == 0)
1765 else if (strcmp (p
, "directory") == 0)
1768 /* systems without symlinks probably don't have S_IFLNK defined */
1769 else if (strcmp (p
, "symlink") == 0)
1772 else if (strcmp (p
, "block-special") == 0)
1774 else if (strcmp (p
, "char-special") == 0)
1776 else if (strcmp (p
, "fifo") == 0)
1779 else if (strcmp (p
, "socket") == 0)
1783 SCM_OUT_OF_RANGE (2, type
);
1785 STRING_SYSCALL (path
, c_path
,
1786 val
= mknod (c_path
,
1787 ctype
| scm_to_int (perms
),
1791 return SCM_UNSPECIFIED
;
1794 #endif /* HAVE_MKNOD */
1797 SCM_DEFINE (scm_nice
, "nice", 1, 0, 0,
1799 "Increment the priority of the current process by @var{incr}. A higher\n"
1800 "priority value means that the process runs less often.\n"
1801 "The return value is unspecified.")
1802 #define FUNC_NAME s_scm_nice
1804 /* nice() returns "prio-NZERO" on success or -1 on error, but -1 can arise
1805 from "prio-NZERO", so an error must be detected from errno changed */
1807 nice (scm_to_int (incr
));
1811 return SCM_UNSPECIFIED
;
1814 #endif /* HAVE_NICE */
1817 SCM_DEFINE (scm_sync
, "sync", 0, 0, 0,
1819 "Flush the operating system disk buffers.\n"
1820 "The return value is unspecified.")
1821 #define FUNC_NAME s_scm_sync
1824 return SCM_UNSPECIFIED
;
1827 #endif /* HAVE_SYNC */
1830 /* crypt() returns a pointer to a static buffer, so we use scm_i_misc_mutex
1831 to avoid another thread overwriting it. A test program running crypt
1832 continuously in two threads can be quickly seen tripping this problem.
1833 crypt() is pretty slow normally, so a mutex shouldn't add much overhead.
1835 glibc has a thread-safe crypt_r, but (in version 2.3.2) it runs a lot
1836 slower (about 5x) than plain crypt if you pass an uninitialized data
1837 block each time. Presumably there's some one-time setups. The best way
1838 to use crypt_r for parallel execution in multiple threads would probably
1839 be to maintain a little pool of initialized crypt_data structures, take
1840 one and use it, then return it to the pool. That pool could be garbage
1841 collected so it didn't add permanently to memory use if only a few crypt
1842 calls are made. But we expect crypt will be used rarely, and even more
1843 rarely will there be any desire for lots of parallel execution on
1844 multiple cpus. So for now we don't bother with anything fancy, just
1848 SCM_DEFINE (scm_crypt
, "crypt", 2, 0, 0,
1849 (SCM key
, SCM salt
),
1850 "Encrypt @var{key} using @var{salt} as the salt value to the\n"
1851 "crypt(3) library call.")
1852 #define FUNC_NAME s_scm_crypt
1855 char *c_key
, *c_salt
, *c_ret
;
1857 scm_dynwind_begin (0);
1858 scm_i_dynwind_pthread_mutex_lock (&scm_i_misc_mutex
);
1860 c_key
= scm_to_locale_string (key
);
1861 scm_dynwind_free (c_key
);
1862 c_salt
= scm_to_locale_string (salt
);
1863 scm_dynwind_free (c_salt
);
1865 /* The Linux crypt(3) man page says crypt will return NULL and set errno
1866 on error. (Eg. ENOSYS if legal restrictions mean it cannot be
1868 c_ret
= crypt (c_key
, c_salt
);
1872 ret
= scm_from_locale_string (c_ret
);
1877 #endif /* HAVE_CRYPT */
1880 SCM_DEFINE (scm_chroot
, "chroot", 1, 0, 0,
1882 "Change the root directory to that specified in @var{path}.\n"
1883 "This directory will be used for path names beginning with\n"
1884 "@file{/}. The root directory is inherited by all children\n"
1885 "of the current process. Only the superuser may change the\n"
1887 #define FUNC_NAME s_scm_chroot
1891 WITH_STRING (path
, c_path
,
1892 rv
= chroot (c_path
));
1895 return SCM_UNSPECIFIED
;
1898 #endif /* HAVE_CHROOT */
1900 SCM_DEFINE (scm_getlogin
, "getlogin", 0, 0, 0,
1902 "Return a string containing the name of the user logged in on\n"
1903 "the controlling terminal of the process, or @code{#f} if this\n"
1904 "information cannot be obtained.")
1905 #define FUNC_NAME s_scm_getlogin
1912 return scm_from_locale_string (p
);
1916 #if HAVE_GETPRIORITY
1917 SCM_DEFINE (scm_getpriority
, "getpriority", 2, 0, 0,
1918 (SCM which
, SCM who
),
1919 "Return the scheduling priority of the process, process group\n"
1920 "or user, as indicated by @var{which} and @var{who}. @var{which}\n"
1921 "is one of the variables @code{PRIO_PROCESS}, @code{PRIO_PGRP}\n"
1922 "or @code{PRIO_USER}, and @var{who} is interpreted relative to\n"
1923 "@var{which} (a process identifier for @code{PRIO_PROCESS},\n"
1924 "process group identifier for @code{PRIO_PGRP}, and a user\n"
1925 "identifier for @code{PRIO_USER}. A zero value of @var{who}\n"
1926 "denotes the current process, process group, or user. Return\n"
1927 "the highest priority (lowest numerical value) of any of the\n"
1928 "specified processes.")
1929 #define FUNC_NAME s_scm_getpriority
1931 int cwhich
, cwho
, ret
;
1933 cwhich
= scm_to_int (which
);
1934 cwho
= scm_to_int (who
);
1936 /* We have to clear errno and examine it later, because -1 is a
1937 legal return value for getpriority(). */
1939 ret
= getpriority (cwhich
, cwho
);
1942 return scm_from_int (ret
);
1945 #endif /* HAVE_GETPRIORITY */
1947 #if HAVE_SETPRIORITY
1948 SCM_DEFINE (scm_setpriority
, "setpriority", 3, 0, 0,
1949 (SCM which
, SCM who
, SCM prio
),
1950 "Set the scheduling priority of the process, process group\n"
1951 "or user, as indicated by @var{which} and @var{who}. @var{which}\n"
1952 "is one of the variables @code{PRIO_PROCESS}, @code{PRIO_PGRP}\n"
1953 "or @code{PRIO_USER}, and @var{who} is interpreted relative to\n"
1954 "@var{which} (a process identifier for @code{PRIO_PROCESS},\n"
1955 "process group identifier for @code{PRIO_PGRP}, and a user\n"
1956 "identifier for @code{PRIO_USER}. A zero value of @var{who}\n"
1957 "denotes the current process, process group, or user.\n"
1958 "@var{prio} is a value in the range -20 and 20, the default\n"
1959 "priority is 0; lower priorities cause more favorable\n"
1960 "scheduling. Sets the priority of all of the specified\n"
1961 "processes. Only the super-user may lower priorities.\n"
1962 "The return value is not specified.")
1963 #define FUNC_NAME s_scm_setpriority
1965 int cwhich
, cwho
, cprio
;
1967 cwhich
= scm_to_int (which
);
1968 cwho
= scm_to_int (who
);
1969 cprio
= scm_to_int (prio
);
1971 if (setpriority (cwhich
, cwho
, cprio
) == -1)
1973 return SCM_UNSPECIFIED
;
1976 #endif /* HAVE_SETPRIORITY */
1978 #ifdef HAVE_SCHED_GETAFFINITY
1981 cpu_set_to_bitvector (const cpu_set_t
*cs
)
1986 bv
= scm_c_make_bitvector (sizeof (*cs
), SCM_BOOL_F
);
1988 for (cpu
= 0; cpu
< sizeof (*cs
); cpu
++)
1990 if (CPU_ISSET (cpu
, cs
))
1991 /* XXX: This is inefficient but avoids code duplication. */
1992 scm_c_bitvector_set_x (bv
, cpu
, SCM_BOOL_T
);
1998 SCM_DEFINE (scm_getaffinity
, "getaffinity", 1, 0, 0,
2000 "Return a bitvector representing the CPU affinity mask for\n"
2001 "process @var{pid}. Each CPU the process has affinity with\n"
2002 "has its corresponding bit set in the returned bitvector.\n"
2003 "The number of bits set is a good estimate of how many CPUs\n"
2004 "Guile can use without stepping on other processes' toes.\n\n"
2005 "Currently this procedure is only defined on GNU variants\n"
2006 "(@pxref{CPU Affinity, @code{sched_getaffinity},, libc, The\n"
2007 "GNU C Library Reference Manual}).\n")
2008 #define FUNC_NAME s_scm_getaffinity
2014 err
= sched_getaffinity (scm_to_int (pid
), sizeof (cs
), &cs
);
2018 return cpu_set_to_bitvector (&cs
);
2022 #endif /* HAVE_SCHED_GETAFFINITY */
2024 #ifdef HAVE_SCHED_SETAFFINITY
2026 SCM_DEFINE (scm_setaffinity
, "setaffinity", 2, 0, 0,
2027 (SCM pid
, SCM mask
),
2028 "Install the CPU affinity mask @var{mask}, a bitvector, for\n"
2029 "the process or thread with ID @var{pid}. The return value\n"
2030 "is unspecified.\n\n"
2031 "Currently this procedure is only defined on GNU variants\n"
2032 "(@pxref{CPU Affinity, @code{sched_setaffinity},, libc, The\n"
2033 "GNU C Library Reference Manual}).\n")
2034 #define FUNC_NAME s_scm_setaffinity
2037 scm_t_array_handle handle
;
2038 const scm_t_uint32
*c_mask
;
2039 size_t len
, off
, cpu
;
2043 c_mask
= scm_bitvector_elements (mask
, &handle
, &off
, &len
, &inc
);
2046 for (cpu
= 0; cpu
< len
; cpu
++)
2050 idx
= cpu
* inc
+ off
;
2051 if (c_mask
[idx
/ 32] & (1UL << (idx
% 32)))
2055 err
= sched_setaffinity (scm_to_int (pid
), sizeof (cs
), &cs
);
2059 return SCM_UNSPECIFIED
;
2063 #endif /* HAVE_SCHED_SETAFFINITY */
2067 SCM_DEFINE (scm_getpass
, "getpass", 1, 0, 0,
2069 "Display @var{prompt} to the standard error output and read\n"
2070 "a password from @file{/dev/tty}. If this file is not\n"
2071 "accessible, it reads from standard input. The password may be\n"
2072 "up to 127 characters in length. Additional characters and the\n"
2073 "terminating newline character are discarded. While reading\n"
2074 "the password, echoing and the generation of signals by special\n"
2075 "characters is disabled.")
2076 #define FUNC_NAME s_scm_getpass
2081 SCM_VALIDATE_STRING (1, prompt
);
2083 WITH_STRING (prompt
, c_prompt
,
2084 p
= getpass(c_prompt
));
2085 passwd
= scm_from_locale_string (p
);
2087 /* Clear out the password in the static buffer. */
2088 memset (p
, 0, strlen (p
));
2093 #endif /* HAVE_GETPASS */
2095 SCM_DEFINE (scm_flock
, "flock", 2, 0, 0,
2096 (SCM file
, SCM operation
),
2097 "Apply or remove an advisory lock on an open file.\n"
2098 "@var{operation} specifies the action to be done:\n"
2101 "Shared lock. More than one process may hold a shared lock\n"
2102 "for a given file at a given time.\n"
2105 "Exclusive lock. Only one process may hold an exclusive lock\n"
2106 "for a given file at a given time.\n"
2109 "Unlock the file.\n"
2112 "Don't block when locking. This is combined with one of the\n"
2113 "other operations using @code{logior}. If @code{flock} would\n"
2114 "block an @code{EWOULDBLOCK} error is thrown.\n"
2117 "The return value is not specified. @var{file} may be an open\n"
2118 "file descriptor or an open file descriptor port.\n"
2120 "Note that @code{flock} does not lock files across NFS.")
2121 #define FUNC_NAME s_scm_flock
2125 if (scm_is_integer (file
))
2126 fdes
= scm_to_int (file
);
2129 SCM_VALIDATE_OPFPORT (2, file
);
2131 fdes
= SCM_FPORT_FDES (file
);
2133 if (flock (fdes
, scm_to_int (operation
)) == -1)
2135 return SCM_UNSPECIFIED
;
2139 #if HAVE_SETHOSTNAME
2140 SCM_DEFINE (scm_sethostname
, "sethostname", 1, 0, 0,
2142 "Set the host name of the current processor to @var{name}. May\n"
2143 "only be used by the superuser. The return value is not\n"
2145 #define FUNC_NAME s_scm_sethostname
2149 WITH_STRING (name
, c_name
,
2150 rv
= sethostname (c_name
, strlen(c_name
)));
2153 return SCM_UNSPECIFIED
;
2156 #endif /* HAVE_SETHOSTNAME */
2159 #if HAVE_GETHOSTNAME
2160 SCM_DEFINE (scm_gethostname
, "gethostname", 0, 0, 0,
2162 "Return the host name of the current processor.")
2163 #define FUNC_NAME s_scm_gethostname
2165 #ifdef MAXHOSTNAMELEN
2167 /* Various systems define MAXHOSTNAMELEN (including Solaris in fact).
2168 * On GNU/Linux this doesn't include the terminating '\0', hence "+ 1". */
2169 const int len
= MAXHOSTNAMELEN
+ 1;
2170 char *const p
= scm_malloc (len
);
2171 const int res
= gethostname (p
, len
);
2173 scm_dynwind_begin (0);
2174 scm_dynwind_unwind_handler (free
, p
, 0);
2178 /* Default 256 is for Solaris, under Linux ENAMETOOLONG is returned if not
2179 * large enough. SUSv2 specifies 255 maximum too, apparently. */
2184 # if HAVE_SYSCONF && defined (_SC_HOST_NAME_MAX)
2186 /* POSIX specifies the HOST_NAME_MAX system parameter for the max size,
2187 * which may reflect a particular kernel configuration.
2188 * Must watch out for this existing but giving -1, as happens for instance
2189 * in gnu/linux glibc 2.3.2. */
2191 const long int n
= sysconf (_SC_HOST_NAME_MAX
);
2198 p
= scm_malloc (len
);
2200 scm_dynwind_begin (0);
2201 scm_dynwind_unwind_handler (free
, p
, 0);
2203 res
= gethostname (p
, len
);
2204 while (res
== -1 && errno
== ENAMETOOLONG
)
2208 /* scm_realloc may throw an exception. */
2209 p
= scm_realloc (p
, len
);
2210 res
= gethostname (p
, len
);
2217 const int save_errno
= errno
;
2219 /* No guile exceptions can occur before we have freed p's memory. */
2228 /* scm_from_locale_string may throw an exception. */
2229 const SCM name
= scm_from_locale_string (p
);
2231 /* No guile exceptions can occur before we have freed p's memory. */
2239 #endif /* HAVE_GETHOSTNAME */
2244 scm_init_popen (void)
2246 scm_c_define_gsubr ("open-process", 2, 0, 1, scm_open_process
);
2253 scm_add_feature ("posix");
2255 scm_add_feature ("EIDs");
2258 scm_c_define ("WAIT_ANY", scm_from_int (WAIT_ANY
));
2261 scm_c_define ("WAIT_MYPGRP", scm_from_int (WAIT_MYPGRP
));
2264 scm_c_define ("WNOHANG", scm_from_int (WNOHANG
));
2267 scm_c_define ("WUNTRACED", scm_from_int (WUNTRACED
));
2271 scm_c_define ("LC_COLLATE", scm_from_int (LC_COLLATE
));
2274 scm_c_define ("LC_CTYPE", scm_from_int (LC_CTYPE
));
2277 scm_c_define ("LC_MONETARY", scm_from_int (LC_MONETARY
));
2280 scm_c_define ("LC_NUMERIC", scm_from_int (LC_NUMERIC
));
2283 scm_c_define ("LC_TIME", scm_from_int (LC_TIME
));
2286 scm_c_define ("LC_MESSAGES", scm_from_int (LC_MESSAGES
));
2289 scm_c_define ("LC_ALL", scm_from_int (LC_ALL
));
2292 scm_c_define ("LC_PAPER", scm_from_int (LC_PAPER
));
2295 scm_c_define ("LC_NAME", scm_from_int (LC_NAME
));
2298 scm_c_define ("LC_ADDRESS", scm_from_int (LC_ADDRESS
));
2301 scm_c_define ("LC_TELEPHONE", scm_from_int (LC_TELEPHONE
));
2303 #ifdef LC_MEASUREMENT
2304 scm_c_define ("LC_MEASUREMENT", scm_from_int (LC_MEASUREMENT
));
2306 #ifdef LC_IDENTIFICATION
2307 scm_c_define ("LC_IDENTIFICATION", scm_from_int (LC_IDENTIFICATION
));
2310 scm_c_define ("PIPE_BUF", scm_from_long (PIPE_BUF
));
2314 scm_c_define ("PRIO_PROCESS", scm_from_int (PRIO_PROCESS
));
2317 scm_c_define ("PRIO_PGRP", scm_from_int (PRIO_PGRP
));
2320 scm_c_define ("PRIO_USER", scm_from_int (PRIO_USER
));
2324 scm_c_define ("LOCK_SH", scm_from_int (LOCK_SH
));
2327 scm_c_define ("LOCK_EX", scm_from_int (LOCK_EX
));
2330 scm_c_define ("LOCK_UN", scm_from_int (LOCK_UN
));
2333 scm_c_define ("LOCK_NB", scm_from_int (LOCK_NB
));
2336 #include "libguile/cpp-SIG.c"
2337 #include "libguile/posix.x"
2340 scm_add_feature ("fork");
2341 scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION
,
2343 (scm_t_extension_init_func
) scm_init_popen
,
2345 #endif /* HAVE_FORK */