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