]>
Commit | Line | Data |
---|---|---|
c84142e8 UD |
1 | /* Copyright (C) 1993, 1994, 1995, 1996, 1997 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. */ | |
28f540f4 RM |
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> | |
b122c703 RM |
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 | } | |
28f540f4 RM |
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; | |
8f0c527e | 79 | extern sigset_t _hurdsig_traced; |
28f540f4 | 80 | |
8f5ca04b RM |
81 | /* Shorthand macro for internal library code referencing _hurd_ports (see |
82 | <hurd/port.h>). */ | |
28f540f4 RM |
83 | |
84 | #define __USEPORT(which, expr) \ | |
85 | HURD_PORT_USE (&_hurd_ports[INIT_PORT_##which], (expr)) | |
86 | ||
8f5ca04b RM |
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 | ||
28f540f4 RM |
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. */ | |
6bac11d9 | 112 | extern unsigned int _hurd_pids_changed_stamp; |
28f540f4 RM |
113 | |
114 | /* This condition is broadcast every time the process IDs change. */ | |
6bac11d9 | 115 | extern struct condition _hurd_pids_changed_sync; |
28f540f4 RM |
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 | ||
1e9dc039 RM |
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); | |
28f540f4 RM |
145 | |
146 | extern process_t getproc (void); | |
147 | extern file_t getcwdir (void), getcrdir (void); | |
148 | extern auth_t getauth (void); | |
1d8dc429 | 149 | extern mach_port_t getcttyid (void); |
28f540f4 RM |
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 | ||
28f540f4 RM |
158 | /* Split FILE into a directory and a name within the directory. The |
159 | directory lookup uses the current root and working directory. If | |
160 | successful, stores in *NAME a pointer into FILE where the name | |
161 | within directory begins and returns a port to the directory; | |
162 | otherwise sets `errno' and returns MACH_PORT_NULL. */ | |
163 | ||
164 | extern file_t __file_name_split (const char *file, char **name); | |
165 | extern file_t file_name_split (const char *file, char **name); | |
166 | ||
167 | /* Open a port to FILE with the given FLAGS and MODE (see <fcntl.h>). | |
168 | The file lookup uses the current root and working directory. | |
169 | Returns a port to the file if successful; otherwise sets `errno' | |
170 | and returns MACH_PORT_NULL. */ | |
171 | ||
172 | extern file_t __file_name_lookup (const char *file, int flags, mode_t mode); | |
173 | extern file_t file_name_lookup (const char *file, int flags, mode_t mode); | |
174 | ||
8f5ca04b RM |
175 | /* Open a port to FILE with the given FLAGS and MODE (see <fcntl.h>). The |
176 | file lookup uses the current root directory, but uses STARTDIR as the | |
177 | "working directory" for file relative names. Returns a port to the file | |
178 | if successful; otherwise sets `errno' and returns MACH_PORT_NULL. */ | |
28f540f4 | 179 | |
8f5ca04b RM |
180 | extern file_t __file_name_lookup_under (file_t startdir, const char *file, |
181 | int flags, mode_t mode); | |
182 | extern file_t file_name_lookup_under (file_t startdir, const char *file, | |
183 | int flags, mode_t mode); | |
28f540f4 RM |
184 | |
185 | ||
8f0c527e RM |
186 | /* Lookup FILE_NAME and return the node opened with FLAGS & MODE |
187 | (see hurd_file_name_lookup for details), but a simple file name (without | |
188 | any directory prefixes) will be consecutively prefixed with the pathnames | |
189 | in the `:' separated list PATH until one succeeds in a successful lookup. | |
190 | If none succeed, then the first error that wasn't ENOENT is returned, or | |
191 | ENOENT if no other errors were returned. If PREFIXED_NAME is non-NULL, | |
192 | then if the result is looked up directly, *PREFIXED_NAME is set to NULL, and | |
193 | if it is looked up using a prefix from PATH, *PREFIXED_NAME is set to | |
194 | malloc'd storage containing the prefixed name. */ | |
195 | extern file_t file_name_path_lookup (const char *file_name, const char *path, | |
196 | int flags, mode_t mode, | |
197 | char **prefixed_name); | |
198 | ||
199 | ||
200 | ||
28f540f4 RM |
201 | /* Open a file descriptor on a port. FLAGS are as for `open'; flags |
202 | affected by io_set_openmodes are not changed by this. If successful, | |
203 | this consumes a user reference for PORT (which will be deallocated on | |
204 | close). */ | |
205 | ||
206 | extern int openport (io_t port, int flags); | |
207 | ||
208 | /* Open a stream on a port. MODE is as for `fopen'. | |
209 | If successful, this consumes a user reference for PORT | |
210 | (which will be deallocated on fclose). */ | |
211 | ||
212 | extern FILE *fopenport (io_t port, const char *mode); | |
213 | extern FILE *__fopenport (io_t port, const char *mode); | |
214 | ||
215 | ||
216 | /* Execute a file, replacing TASK's current program image. */ | |
217 | ||
218 | extern error_t _hurd_exec (task_t task, | |
219 | file_t file, | |
220 | char *const argv[], | |
221 | char *const envp[]); | |
222 | ||
223 | ||
6d52618b | 224 | /* Inform the proc server we have exited with STATUS, and kill the |
28f540f4 RM |
225 | task thoroughly. This function never returns, no matter what. */ |
226 | ||
227 | extern void _hurd_exit (int status) __attribute__ ((noreturn)); | |
228 | ||
229 | ||
230 | /* Initialize the library data structures from the | |
231 | ints and ports passed to us by the exec server. | |
232 | Then vm_deallocate PORTARRAY and INTARRAY. */ | |
233 | ||
234 | extern void _hurd_init (int flags, char **argv, | |
235 | mach_port_t *portarray, size_t portarraysize, | |
236 | int *intarray, size_t intarraysize); | |
237 | ||
238 | /* Do startup handshaking with the proc server. */ | |
239 | ||
240 | extern void _hurd_proc_init (char **argv); | |
241 | ||
242 | ||
243 | /* Return the socket server for sockaddr domain DOMAIN. If DEAD is | |
244 | nonzero, remove the old cached port and always do a fresh lookup. | |
245 | ||
246 | It is assumed that a socket server will stay alive during a complex socket | |
247 | operation involving several RPCs. But a socket server may die during | |
248 | long idle periods between socket operations. Callers should first pass | |
249 | zero for DEAD; if the first socket RPC tried on the returned port fails | |
250 | with MACH_SEND_INVALID_DEST or MIG_SERVER_DIED (indicating the server | |
251 | went away), the caller should call _hurd_socket_server again with DEAD | |
252 | nonzero and retry the RPC on the new socket server port. */ | |
253 | ||
254 | extern socket_t _hurd_socket_server (int domain, int dead); | |
255 | ||
256 | /* Send a `sig_post' RPC to process number PID. If PID is zero, | |
257 | send the message to all processes in the current process's process group. | |
258 | If PID is < -1, send SIG to all processes in process group - PID. | |
259 | SIG and REFPORT are passed along in the request message. */ | |
260 | ||
261 | extern error_t _hurd_sig_post (pid_t pid, int sig, mach_port_t refport); | |
262 | extern error_t hurd_sig_post (pid_t pid, int sig, mach_port_t refport); | |
263 | ||
264 | /* Fetch the host privileged port and device master port from the proc | |
265 | server. They are fetched only once and then cached in the | |
266 | variables below. A special program that gets them from somewhere | |
267 | other than the proc server (such as a bootstrap filesystem) can set | |
268 | these variables to install the ports. */ | |
269 | ||
270 | extern kern_return_t get_privileged_ports (host_priv_t *host_priv_ptr, | |
271 | device_t *device_master_ptr); | |
272 | extern mach_port_t _hurd_host_priv, _hurd_device_master; | |
273 | ||
274 | /* Return the PID of the task whose control port is TASK. | |
275 | On error, sets `errno' and returns -1. */ | |
276 | ||
277 | extern pid_t __task2pid (task_t task), task2pid (task_t task); | |
278 | ||
279 | /* Return the task control port of process PID. | |
280 | On error, sets `errno' and returns MACH_PORT_NULL. */ | |
281 | ||
282 | extern task_t __pid2task (pid_t pid), pid2task (pid_t pid); | |
283 | ||
ded29119 RM |
284 | /* Return the current thread's thread port. This is a cheap operation (no |
285 | system call), but it relies on Hurd signal state being set up. */ | |
286 | extern thread_t hurd_thread_self (void); | |
287 | ||
28f540f4 | 288 | |
54da5be3 RM |
289 | /* Cancel pending operations on THREAD. If it is doing an interruptible RPC, |
290 | that RPC will now return EINTR; otherwise, the "cancelled" flag will be | |
291 | set, causing the next `hurd_check_cancel' call to return nonzero or the | |
292 | next interruptible RPC to return EINTR (whichever is called first). */ | |
293 | extern error_t hurd_thread_cancel (thread_t thread); | |
294 | ||
295 | /* Test and clear the calling thread's "cancelled" flag. */ | |
296 | extern int hurd_check_cancel (void); | |
297 | ||
298 | ||
28f540f4 RM |
299 | /* Return the io server port for file descriptor FD. |
300 | This adds a Mach user reference to the returned port. | |
301 | On error, sets `errno' and returns MACH_PORT_NULL. */ | |
302 | ||
303 | extern io_t __getdport (int fd), getdport (int fd); | |
304 | ||
305 | ||
306 | #endif /* hurd.h */ |