]> git.ipfire.org Git - thirdparty/glibc.git/blobdiff - hurd/hurd.h
Prefer https to http for gnu.org and fsf.org URLs
[thirdparty/glibc.git] / hurd / hurd.h
index b0bbfbea3bc845843e427efbd7cdcb575e92fddc..ff7700a6c7d1991405bec0dcb47e688084f889c2 100644 (file)
@@ -1,20 +1,19 @@
-/* Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
-This file is part of the GNU C Library.
+/* Copyright (C) 1993-2019 Free Software Foundation, Inc.
+   This file is part of the GNU C Library.
 
-The GNU C Library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Library General Public License as
-published by the Free Software Foundation; either version 2 of the
-License, or (at your option) any later version.
+   The GNU C Library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
 
-The GNU C Library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-Library General Public License for more details.
+   The GNU C Library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Lesser General Public License for more details.
 
-You should have received a copy of the GNU Library General Public
-License along with the GNU C Library; see the file COPYING.LIB.  If
-not, write to the Free Software Foundation, Inc., 675 Mass Ave,
-Cambridge, MA 02139, USA.  */
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, see
+   <https://www.gnu.org/licenses/>.  */
 
 #ifndef        _HURD_H
 
@@ -42,20 +41,65 @@ Cambridge, MA 02139, USA.  */
 #include <hurd/port.h>
 
 #include <errno.h>
-#define        __hurd_fail(err)        (errno = (err), -1)
+#include <bits/types/error_t.h>
+#include <bits/types/sigset_t.h>
+
+#ifndef _HURD_H_EXTERN_INLINE
+#define _HURD_H_EXTERN_INLINE __extern_inline
+#endif
+
+extern int __hurd_fail (error_t err);
+
+#ifdef __USE_EXTERN_INLINES
+_HURD_H_EXTERN_INLINE int
+__hurd_fail (error_t err)
+{
+  switch (err)
+    {
+    case EMACH_SEND_INVALID_DEST:
+    case EMIG_SERVER_DIED:
+      /* The server has disappeared!  */
+      err = (error_t) EIEIO;
+      break;
+
+    case KERN_NO_SPACE:
+      err = (error_t) ENOMEM;
+      break;
+
+    case KERN_INVALID_ARGUMENT:
+      err = (error_t) EINVAL;
+      break;
+
+    case 0:
+      return 0;
+
+    default:
+      break;
+    }
+
+  errno = err;
+  return -1;
+}
+#endif
 \f
 /* Basic ports and info, initialized by startup.  */
 
 extern int _hurd_exec_flags;   /* Flags word passed in exec_startup.  */
 extern struct hurd_port *_hurd_ports;
 extern unsigned int _hurd_nports;
-extern volatile mode_t _hurd_umask;
+extern mode_t _hurd_umask;
+extern sigset_t _hurdsig_traced;
 
-/* Shorthand macro for referencing _hurd_ports (see <hurd/port.h>).  */
+/* Shorthand macro for internal library code referencing _hurd_ports (see
+   <hurd/port.h>).  */
 
 #define        __USEPORT(which, expr) \
   HURD_PORT_USE (&_hurd_ports[INIT_PORT_##which], (expr))
 
+/* Function version of __USEPORT: calls OPERATE with a send right.  */
+
+extern error_t _hurd_ports_use (int which, error_t (*operate) (mach_port_t));
+
 
 /* Base address and size of the initial stack set up by the exec server.
    If using cthreads, this stack is deallocated in startup.
@@ -77,11 +121,10 @@ extern pid_t _hurd_pid, _hurd_ppid, _hurd_pgrp;
 extern int _hurd_orphaned;
 
 /* This variable is incremented every time the process IDs change.  */
-
-unsigned int _hurd_pids_changed_stamp;
+extern unsigned int _hurd_pids_changed_stamp;
 
 /* This condition is broadcast every time the process IDs change.  */
-struct condition _hurd_pids_changed_sync;
+extern struct condition _hurd_pids_changed_sync;
 \f
 /* Unix `data break', for brk and sbrk.
    If brk and sbrk are not used, this info will not be initialized or used.  */
@@ -104,8 +147,7 @@ extern struct mutex _hurd_brk_lock;
 
 extern int _hurd_set_brk (vm_address_t newbrk);
 \f
-#define __need_FILE
-#include <stdio.h>
+#include <bits/types/FILE.h>
 
 /* Calls to get and set basic ports.  */
 
@@ -115,7 +157,7 @@ extern error_t _hurd_ports_set (unsigned int which, mach_port_t newport);
 extern process_t getproc (void);
 extern file_t getcwdir (void), getcrdir (void);
 extern auth_t getauth (void);
-extern mach_port_t getcttyid ();
+extern mach_port_t getcttyid (void);
 extern int setproc (process_t);
 extern int setcwdir (file_t), setcrdir (file_t);
 extern int setcttyid (mach_port_t);
@@ -124,50 +166,20 @@ extern int setcttyid (mach_port_t);
 extern int __setauth (auth_t), setauth (auth_t);
 
 
-/* Split FILE into a directory and a name within the directory.  Look up a
-   port for the directory and store it in *DIR; store in *NAME a pointer
-   into FILE where the name within directory begins.  The directory lookup
-   uses CRDIR for the root directory and CWDIR for the current directory.
-   Returns zero on success or an error code.  */
+/* Modify a port cell by looking up a directory name.
+   This verifies that it is a directory and that we have search permission.  */
+extern int _hurd_change_directory_port_from_name (struct hurd_port *portcell,
+                                                 const char *name);
+/* Same thing, but using an open file descriptor.
+   Also verifies that it is a directory and that we have search permission.  */
+extern int _hurd_change_directory_port_from_fd (struct hurd_port *portcell,
+                                               int fd);
 
-extern error_t __hurd_file_name_split (file_t crdir, file_t cwdir,
-                                      const char *file,
-                                      file_t *dir, char **name);
-extern error_t hurd_file_name_split (file_t crdir, file_t cwdir,
-                                    const char *file,
-                                    file_t *dir, char **name);
 
-/* Open a port to FILE with the given FLAGS and MODE (see <fcntl.h>).
-   The file lookup uses CRDIR for the root directory and CWDIR for the
-   current directory.  If successful, returns zero and store the port
-   to FILE in *PORT; otherwise returns an error code. */
-
-extern error_t __hurd_file_name_lookup (file_t crdir, file_t cwdir,
-                                       const char *file,
-                                       int flags, mode_t mode,
-                                       file_t *port);
-extern error_t hurd_file_name_lookup (file_t crdir, file_t cwdir,
-                                     const char *filename,
-                                     int flags, mode_t mode,
-                                     file_t *port);
-
-/* Process the values returned by `dir_lookup' et al, and loop doing
-   `dir_lookup' calls until one returns FS_RETRY_NONE.  CRDIR is the
-   root directory used for things like symlinks to absolute file names; the
-   other arguments should be those just passed to and/or returned from
-   `dir_lookup', `fsys_getroot', or `file_invoke_translator'.  This
-   function consumes the reference in *RESULT even if it returns an error.  */
-
-extern error_t __hurd_file_name_lookup_retry (file_t crdir,
-                                             enum retry_type doretry,
-                                             char retryname[1024],
-                                             int flags, mode_t mode,
-                                             file_t *result);
-extern error_t hurd_file_name_lookup_retry (file_t crdir,
-                                           enum retry_type doretry,
-                                           char retryname[1024],
-                                           int flags, mode_t mode,
-                                           file_t *result);
+
+/* Get and set the effective UID set.  */
+extern int geteuids (int __n, uid_t *__uidset);
+extern int seteuids (int __n, const uid_t *__uidset);
 
 
 /* Split FILE into a directory and a name within the directory.  The
@@ -179,6 +191,12 @@ extern error_t hurd_file_name_lookup_retry (file_t crdir,
 extern file_t __file_name_split (const char *file, char **name);
 extern file_t file_name_split (const char *file, char **name);
 
+/* Split DIRECTORY into a parent directory and a name within the directory.
+   This is the same as file_name_split, but ignores trailing slashes.  */
+
+extern file_t __directory_name_split (const char *file, char **name);
+extern file_t directory_name_split (const char *file, char **name);
+
 /* Open a port to FILE with the given FLAGS and MODE (see <fcntl.h>).
    The file lookup uses the current root and working directory.
    Returns a port to the file if successful; otherwise sets `errno'
@@ -187,15 +205,30 @@ extern file_t file_name_split (const char *file, char **name);
 extern file_t __file_name_lookup (const char *file, int flags, mode_t mode);
 extern file_t file_name_lookup (const char *file, int flags, mode_t mode);
 
-/* Invoke any translator set on the node FILE represents, and return in
-   *TRANSLATED a port to the translated node.  FLAGS are as for
-   `dir_lookup' et al, but the returned port will not necessarily have
-   any more access rights than FILE does.  */
+/* Open a port to FILE with the given FLAGS and MODE (see <fcntl.h>).  The
+   file lookup uses the current root directory, but uses STARTDIR as the
+   "working directory" for file relative names.  Returns a port to the file
+   if successful; otherwise sets `errno' and returns MACH_PORT_NULL.  */
+
+extern file_t __file_name_lookup_under (file_t startdir, const char *file,
+                                       int flags, mode_t mode);
+extern file_t file_name_lookup_under (file_t startdir, const char *file,
+                                     int flags, mode_t mode);
+
+
+/* Lookup FILE_NAME and return the node opened with FLAGS & MODE
+   (see hurd_file_name_lookup for details), but a simple file name (without
+   any directory prefixes) will be consecutively prefixed with the pathnames
+   in the `:' separated list PATH until one succeeds in a successful lookup.
+   If none succeed, then the first error that wasn't ENOENT is returned, or
+   ENOENT if no other errors were returned.  If PREFIXED_NAME is non-NULL,
+   then if the result is looked up directly, *PREFIXED_NAME is set to NULL, and
+   if it is looked up using a prefix from PATH, *PREFIXED_NAME is set to
+   malloc'd storage containing the prefixed name.  */
+extern file_t file_name_path_lookup (const char *file_name, const char *path,
+                                    int flags, mode_t mode,
+                                    char **prefixed_name);
 
-extern error_t __hurd_invoke_translator (file_t file, int flags,
-                                        file_t *translated);
-extern error_t hurd_invoke_translator (file_t file, int flags,
-                                      file_t *translated);
 
 
 /* Open a file descriptor on a port.  FLAGS are as for `open'; flags
@@ -213,40 +246,29 @@ extern FILE *fopenport (io_t port, const char *mode);
 extern FILE *__fopenport (io_t port, const char *mode);
 
 
-/* Execute a file, replacing TASK's current program image.  */
+/* Deprecated: use _hurd_exec_paths instead.  */
 
 extern error_t _hurd_exec (task_t task,
                           file_t file,
                           char *const argv[],
-                          char *const envp[]);
+                          char *const envp[]) __attribute_deprecated__;
+
+/* Execute a file, replacing TASK's current program image.  */
+
+extern error_t _hurd_exec_paths (task_t task,
+                                file_t file,
+                                const char *path,
+                                const char *abspath,
+                                char *const argv[],
+                                char *const envp[]);
 
 
-/* Inform the proc server we have exitted with STATUS, and kill the
+/* Inform the proc server we have exited with STATUS, and kill the
    task thoroughly.  This function never returns, no matter what.  */
 
 extern void _hurd_exit (int status) __attribute__ ((noreturn));
 
 
-/* Initialize Mach RPCs and essential Hurd things (_hurd_preinit_hook); do
-   initial handshake with the exec server (or extract the arguments from
-   the stack in the case of the bootstrap task); if cthreads is in use,
-   initialize it now and switch the calling thread to a cthread stack;
-   finally, call *MAIN with the information gleaned.  That function is not
-   expected to return.  ARGPTR should be the address of the first argument
-   of the entry point function that is called with the stack exactly as the
-   exec server or kernel sets it.  */
-
-extern void _hurd_startup (void **argptr,
-                          void (*main) (int argc, char **argv, char **envp,
-                                        int flags,
-                                        mach_port_t *portarray,
-                                        mach_msg_type_number_t portarraysize,
-                                        int *intarray,
-                                        mach_msg_type_number_t intarraysize,
-                                        vm_address_t phdr, vm_size_t phdrsz,
-                                        vm_address_t user_entry))
-     __attribute__ ((noreturn));
-
 /* Initialize the library data structures from the
    ints and ports passed to us by the exec server.
    Then vm_deallocate PORTARRAY and INTARRAY.  */
@@ -255,9 +277,12 @@ extern void _hurd_init (int flags, char **argv,
                        mach_port_t *portarray, size_t portarraysize,
                        int *intarray, size_t intarraysize);
 
-/* Do startup handshaking with the proc server.  */
+/* Do startup handshaking with the proc server, and initialize library data
+   structures that require proc server interaction.  This includes
+   initializing signals; see _hurdsig_init in <hurd/signal.h>.  */
 
-extern void _hurd_proc_init (char **argv);
+extern void _hurd_proc_init (char **argv,
+                            const int *intarray, size_t intarraysize);
 
 
 /* Return the socket server for sockaddr domain DOMAIN.  If DEAD is
@@ -287,7 +312,9 @@ extern error_t hurd_sig_post (pid_t pid, int sig, mach_port_t refport);
    other than the proc server (such as a bootstrap filesystem) can set
    these variables to install the ports.  */
 
-extern kern_return_t get_privileged_ports (host_priv_t *host_priv_ptr,
+extern kern_return_t __get_privileged_ports (mach_port_t *host_priv_ptr,
+                                            device_t *device_master_ptr);
+extern kern_return_t get_privileged_ports (mach_port_t *host_priv_ptr,
                                           device_t *device_master_ptr);
 extern mach_port_t _hurd_host_priv, _hurd_device_master;
 
@@ -301,6 +328,20 @@ extern pid_t __task2pid (task_t task), task2pid (task_t task);
 
 extern task_t __pid2task (pid_t pid), pid2task (pid_t pid);
 
+/* Return the current thread's thread port.  This is a cheap operation (no
+   system call), but it relies on Hurd signal state being set up.  */
+extern thread_t hurd_thread_self (void);
+
+
+/* Cancel pending operations on THREAD.  If it is doing an interruptible RPC,
+   that RPC will now return EINTR; otherwise, the "cancelled" flag will be
+   set, causing the next `hurd_check_cancel' call to return nonzero or the
+   next interruptible RPC to return EINTR (whichever is called first).  */
+extern error_t hurd_thread_cancel (thread_t thread);
+
+/* Test and clear the calling thread's "cancelled" flag.  */
+extern int hurd_check_cancel (void);
+
 
 /* Return the io server port for file descriptor FD.
    This adds a Mach user reference to the returned port.
@@ -309,4 +350,11 @@ extern task_t __pid2task (pid_t pid), pid2task (pid_t pid);
 extern io_t __getdport (int fd), getdport (int fd);
 
 
+#include <stdarg.h>
+
+/* Write formatted output to PORT, a Mach port supporting the i/o protocol,
+   according to the format string FORMAT, using the argument list in ARG.  */
+int vpprintf (io_t port, const char *format, va_list arg);
+
+
 #endif /* hurd.h */