hurd/hurd.h

   1 /* Copyright (C) 1993-2017 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Lesser General Public
   6    License as published by the Free Software Foundation; either
   7    version 2.1 of the License, or (at your option) any later version.
   8
   9    The GNU C Library is distributed in the hope that it will be useful,
  10    but 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.
  13
  14    You should have received a copy of the GNU Lesser General Public
  15    License along with the GNU C Library; if not, see
  16    <http://www.gnu.org/licenses/>.  */
  17
  18 #ifndef _HURD_H
  19
  20 #define _HURD_H 1
  21 #include <features.h>
  22
  23
  24 /* Get types, macros, constants and function declarations
  25    for all Mach microkernel interaction.  */
  26 #include <mach.h>
  27 #include <mach/mig_errors.h>
  28
  29 /* Get types and constants necessary for Hurd interfaces.  */
  30 #include <hurd/hurd_types.h>
  31
  32 /* Get MiG stub declarations for commonly used Hurd interfaces.  */
  33 #include <hurd/auth.h>
  34 #include <hurd/process.h>
  35 #include <hurd/fs.h>
  36 #include <hurd/io.h>
  37
  38 /* Get `struct hurd_port' and related definitions implementing lightweight
  39    user references for ports.  These are used pervasively throughout the C
  40    library; this is here to avoid putting it in nearly every source file.  */
  41 #include <hurd/port.h>
  42
  43 #include <errno.h>
  44
  45 #ifndef _HURD_H_EXTERN_INLINE
  46 #define _HURD_H_EXTERN_INLINE __extern_inline
  47 #endif
  48
  49 _HURD_H_EXTERN_INLINE int
  50 __hurd_fail (error_t err)
  51 {
  52   switch (err)
  53     {
  54     case EMACH_SEND_INVALID_DEST:
  55     case EMIG_SERVER_DIED:
  56       /* The server has disappeared!  */
  57       err = (error_t) EIEIO;
  58       break;
  59
  60     case KERN_NO_SPACE:
  61       err = (error_t) ENOMEM;
  62       break;
  63
  64     case KERN_INVALID_ARGUMENT:
  65       err = (error_t) EINVAL;
  66       break;
  67
  68     case 0:
  69       return 0;
  70
  71     default:
  72       break;
  73     }
  74
  75   errno = err;
  76   return -1;
  77 }
  78 \f
  79 /* Basic ports and info, initialized by startup.  */
  80
  81 extern int _hurd_exec_flags;    /* Flags word passed in exec_startup.  */
  82 extern struct hurd_port *_hurd_ports;
  83 extern unsigned int _hurd_nports;
  84 extern mode_t _hurd_umask;
  85 extern sigset_t _hurdsig_traced;
  86
  87 /* Shorthand macro for internal library code referencing _hurd_ports (see
  88    <hurd/port.h>).  */
  89
  90 #define __USEPORT(which, expr) \
  91   HURD_PORT_USE (&_hurd_ports[INIT_PORT_##which], (expr))
  92
  93 /* Function version of __USEPORT: calls OPERATE with a send right.  */
  94
  95 extern error_t _hurd_ports_use (int which, error_t (*operate) (mach_port_t));
  96
  97
  98 /* Base address and size of the initial stack set up by the exec server.
  99    If using cthreads, this stack is deallocated in startup.
 100    Not locked.  */
 101
 102 extern vm_address_t _hurd_stack_base;
 103 extern vm_size_t _hurd_stack_size;
 104
 105 /* Initial file descriptor table we were passed at startup.  If we are
 106    using a real dtable, these are turned into that and then cleared at
 107    startup.  If not, these are never changed after startup.  Not locked.  */
 108
 109 extern mach_port_t *_hurd_init_dtable;
 110 extern mach_msg_type_number_t _hurd_init_dtablesize;
 111 \f
 112 /* Current process IDs.  */
 113
 114 extern pid_t _hurd_pid, _hurd_ppid, _hurd_pgrp;
 115 extern int _hurd_orphaned;
 116
 117 /* This variable is incremented every time the process IDs change.  */
 118 extern unsigned int _hurd_pids_changed_stamp;
 119
 120 /* This condition is broadcast every time the process IDs change.  */
 121 extern struct condition _hurd_pids_changed_sync;
 122 \f
 123 /* Unix `data break', for brk and sbrk.
 124    If brk and sbrk are not used, this info will not be initialized or used.  */
 125
 126
 127 /* Data break.  This is what `sbrk (0)' returns.  */
 128
 129 extern vm_address_t _hurd_brk;
 130
 131 /* End of allocated space.  This is generally `round_page (_hurd_brk)'.  */
 132
 133 extern vm_address_t _hurd_data_end;
 134
 135 /* This mutex locks _hurd_brk and _hurd_data_end.  */
 136
 137 extern struct mutex _hurd_brk_lock;
 138
 139 /* Set the data break to NEWBRK; _hurd_brk_lock must
 140    be held, and is released on return.  */
 141
 142 extern int _hurd_set_brk (vm_address_t newbrk);
 143 \f
 144 #include <bits/types/FILE.h>
 145
 146 /* Calls to get and set basic ports.  */
 147
 148 extern error_t _hurd_ports_get (unsigned int which, mach_port_t *result);
 149 extern error_t _hurd_ports_set (unsigned int which, mach_port_t newport);
 150
 151 extern process_t getproc (void);
 152 extern file_t getcwdir (void), getcrdir (void);
 153 extern auth_t getauth (void);
 154 extern mach_port_t getcttyid (void);
 155 extern int setproc (process_t);
 156 extern int setcwdir (file_t), setcrdir (file_t);
 157 extern int setcttyid (mach_port_t);
 158
 159 /* Does reauth with the proc server and fd io servers.  */
 160 extern int __setauth (auth_t), setauth (auth_t);
 161
 162
 163 /* Modify a port cell by looking up a directory name.
 164    This verifies that it is a directory and that we have search permission.  */
 165 extern int _hurd_change_directory_port_from_name (struct hurd_port *portcell,
 166                                                   const char *name);
 167 /* Same thing, but using an open file descriptor.
 168    Also verifies that it is a directory and that we have search permission.  */
 169 extern int _hurd_change_directory_port_from_fd (struct hurd_port *portcell,
 170                                                 int fd);
 171
 172
 173
 174 /* Get and set the effective UID set.  */
 175 extern int geteuids (int __n, uid_t *__uidset);
 176 extern int seteuids (int __n, const uid_t *__uidset);
 177
 178
 179 /* Split FILE into a directory and a name within the directory.  The
 180    directory lookup uses the current root and working directory.  If
 181    successful, stores in *NAME a pointer into FILE where the name
 182    within directory begins and returns a port to the directory;
 183    otherwise sets `errno' and returns MACH_PORT_NULL.  */
 184
 185 extern file_t __file_name_split (const char *file, char **name);
 186 extern file_t file_name_split (const char *file, char **name);
 187
 188 /* Split DIRECTORY into a parent directory and a name within the directory.
 189    This is the same as file_name_split, but ignores trailing slashes.  */
 190
 191 extern file_t __directory_name_split (const char *file, char **name);
 192 extern file_t directory_name_split (const char *file, char **name);
 193
 194 /* Open a port to FILE with the given FLAGS and MODE (see <fcntl.h>).
 195    The file lookup uses the current root and working directory.
 196    Returns a port to the file if successful; otherwise sets `errno'
 197    and returns MACH_PORT_NULL.  */
 198
 199 extern file_t __file_name_lookup (const char *file, int flags, mode_t mode);
 200 extern file_t file_name_lookup (const char *file, int flags, mode_t mode);
 201
 202 /* Open a port to FILE with the given FLAGS and MODE (see <fcntl.h>).  The
 203    file lookup uses the current root directory, but uses STARTDIR as the
 204    "working directory" for file relative names.  Returns a port to the file
 205    if successful; otherwise sets `errno' and returns MACH_PORT_NULL.  */
 206
 207 extern file_t __file_name_lookup_under (file_t startdir, const char *file,
 208                                         int flags, mode_t mode);
 209 extern file_t file_name_lookup_under (file_t startdir, const char *file,
 210                                       int flags, mode_t mode);
 211
 212
 213 /* Lookup FILE_NAME and return the node opened with FLAGS & MODE
 214    (see hurd_file_name_lookup for details), but a simple file name (without
 215    any directory prefixes) will be consecutively prefixed with the pathnames
 216    in the `:' separated list PATH until one succeeds in a successful lookup.
 217    If none succeed, then the first error that wasn't ENOENT is returned, or
 218    ENOENT if no other errors were returned.  If PREFIXED_NAME is non-NULL,
 219    then if the result is looked up directly, *PREFIXED_NAME is set to NULL, and
 220    if it is looked up using a prefix from PATH, *PREFIXED_NAME is set to
 221    malloc'd storage containing the prefixed name.  */
 222 extern file_t file_name_path_lookup (const char *file_name, const char *path,
 223                                      int flags, mode_t mode,
 224                                      char **prefixed_name);
 225
 226
 227
 228 /* Open a file descriptor on a port.  FLAGS are as for `open'; flags
 229    affected by io_set_openmodes are not changed by this.  If successful,
 230    this consumes a user reference for PORT (which will be deallocated on
 231    close).  */
 232
 233 extern int openport (io_t port, int flags);
 234
 235 /* Open a stream on a port.  MODE is as for `fopen'.
 236    If successful, this consumes a user reference for PORT
 237    (which will be deallocated on fclose).  */
 238
 239 extern FILE *fopenport (io_t port, const char *mode);
 240 extern FILE *__fopenport (io_t port, const char *mode);
 241
 242
 243 /* Execute a file, replacing TASK's current program image.  */
 244
 245 extern error_t _hurd_exec (task_t task,
 246                            file_t file,
 247                            char *const argv[],
 248                            char *const envp[]);
 249
 250
 251 /* Inform the proc server we have exited with STATUS, and kill the
 252    task thoroughly.  This function never returns, no matter what.  */
 253
 254 extern void _hurd_exit (int status) __attribute__ ((noreturn));
 255
 256
 257 /* Initialize the library data structures from the
 258    ints and ports passed to us by the exec server.
 259    Then vm_deallocate PORTARRAY and INTARRAY.  */
 260
 261 extern void _hurd_init (int flags, char **argv,
 262                         mach_port_t *portarray, size_t portarraysize,
 263                         int *intarray, size_t intarraysize);
 264
 265 /* Do startup handshaking with the proc server, and initialize library data
 266    structures that require proc server interaction.  This includes
 267    initializing signals; see _hurdsig_init in <hurd/signal.h>.  */
 268
 269 extern void _hurd_proc_init (char **argv,
 270                              const int *intarray, size_t intarraysize);
 271
 272
 273 /* Return the socket server for sockaddr domain DOMAIN.  If DEAD is
 274    nonzero, remove the old cached port and always do a fresh lookup.
 275
 276    It is assumed that a socket server will stay alive during a complex socket
 277    operation involving several RPCs.  But a socket server may die during
 278    long idle periods between socket operations.  Callers should first pass
 279    zero for DEAD; if the first socket RPC tried on the returned port fails
 280    with MACH_SEND_INVALID_DEST or MIG_SERVER_DIED (indicating the server
 281    went away), the caller should call _hurd_socket_server again with DEAD
 282    nonzero and retry the RPC on the new socket server port.  */
 283
 284 extern socket_t _hurd_socket_server (int domain, int dead);
 285
 286 /* Send a `sig_post' RPC to process number PID.  If PID is zero,
 287    send the message to all processes in the current process's process group.
 288    If PID is < -1, send SIG to all processes in process group - PID.
 289    SIG and REFPORT are passed along in the request message.  */
 290
 291 extern error_t _hurd_sig_post (pid_t pid, int sig, mach_port_t refport);
 292 extern error_t hurd_sig_post (pid_t pid, int sig, mach_port_t refport);
 293
 294 /* Fetch the host privileged port and device master port from the proc
 295    server.  They are fetched only once and then cached in the
 296    variables below.  A special program that gets them from somewhere
 297    other than the proc server (such as a bootstrap filesystem) can set
 298    these variables to install the ports.  */
 299
 300 extern kern_return_t __get_privileged_ports (mach_port_t *host_priv_ptr,
 301                                              device_t *device_master_ptr);
 302 extern kern_return_t get_privileged_ports (mach_port_t *host_priv_ptr,
 303                                            device_t *device_master_ptr);
 304 extern mach_port_t _hurd_host_priv, _hurd_device_master;
 305
 306 /* Return the PID of the task whose control port is TASK.
 307    On error, sets `errno' and returns -1.  */
 308
 309 extern pid_t __task2pid (task_t task), task2pid (task_t task);
 310
 311 /* Return the task control port of process PID.
 312    On error, sets `errno' and returns MACH_PORT_NULL.  */
 313
 314 extern task_t __pid2task (pid_t pid), pid2task (pid_t pid);
 315
 316 /* Return the current thread's thread port.  This is a cheap operation (no
 317    system call), but it relies on Hurd signal state being set up.  */
 318 extern thread_t hurd_thread_self (void);
 319
 320
 321 /* Cancel pending operations on THREAD.  If it is doing an interruptible RPC,
 322    that RPC will now return EINTR; otherwise, the "cancelled" flag will be
 323    set, causing the next `hurd_check_cancel' call to return nonzero or the
 324    next interruptible RPC to return EINTR (whichever is called first).  */
 325 extern error_t hurd_thread_cancel (thread_t thread);
 326
 327 /* Test and clear the calling thread's "cancelled" flag.  */
 328 extern int hurd_check_cancel (void);
 329
 330
 331 /* Return the io server port for file descriptor FD.
 332    This adds a Mach user reference to the returned port.
 333    On error, sets `errno' and returns MACH_PORT_NULL.  */
 334
 335 extern io_t __getdport (int fd), getdport (int fd);
 336
 337
 338 #include <stdarg.h>
 339
 340 /* Write formatted output to PORT, a Mach port supporting the i/o protocol,
 341    according to the format string FORMAT, using the argument list in ARG.  */
 342 int vpprintf (io_t port, const char *format, va_list arg);
 343
 344
 345 #endif  /* hurd.h */