unpipc.h

1. /* include unpipch */
2. /* Our own header.  Tabs are set for 4 spaces, not 8 */
4. #ifndef __unpipc_h
5. #define __unpipc_h
7. #include "../config.h" /* configuration options for current OS */
8. /* "../config.h" is generated by configure */
10. /* If anything changes in the following list of #includes, must change
11.    ../aclocal.m4 and ../configure.in also, for configure's tests. */
13. #include <sys/types.h> /* basic system data types */
14. #include <sys/time.h> /* timeval{} for select() */
15. #include <time.h> /* timespec{} for pselect() */
16. #include <errno.h>
17. #include <fcntl.h> /* for nonblocking */
18. #include <limits.h> /* PIPE_BUF */
19. #include <signal.h>
20. #include <stdio.h>
21. #include <stdlib.h>
22. #include <string.h>
23. #include <sys/stat.h> /* for S_xxx file mode constants */
24. #include <unistd.h>
25. #include <sys/wait.h>
27. #ifdef HAVE_MQUEUE_H
28. # include <mqueue.h> /* Posix message queues */
29. #endif
31. #ifdef HAVE_SEMAPHORE_H
32. # include <semaphore.h> /* Posix semaphores */
34. #ifndef SEM_FAILED
35. #define SEM_FAILED ((sem_t *)(-1))
36. #endif
38. #endif
40. #ifdef HAVE_SYS_MMAN_H
41. # include <sys/mman.h> /* Posix shared memory */
42. #endif
44. #ifndef MAP_FAILED
45. #define MAP_FAILED ((void *)(-1))
46. #endif
48. #ifdef HAVE_SYS_IPC_H
49. # include <sys/ipc.h> /* System V IPC */
50. #endif
52. #ifdef HAVE_SYS_MSG_H
53. # include <sys/msg.h> /* System V message queues */
54. #endif
56. #ifdef HAVE_SYS_SEM_H
57. #ifdef __bsdi__
58. #undef HAVE_SYS_SEM_H /* hack: BSDI's semctl() prototype is wrong */
59. #else
60. # include <sys/sem.h> /* System V semaphores */
61. #endif
63. #ifndef HAVE_SEMUN_UNION
64. /* $$.It semun$$ */
65. union semun { /* define union for semctl() */
66.   int              val;
67.   struct semid_ds *buf;
68.   unsigned short  *array;
69. };
70. #endif
71. #endif /* HAVE_SYS_SEM_H */
73. #ifdef HAVE_SYS_SHM_H
74. # include <sys/shm.h> /* System V shared memory */
75. #endif
77. #ifdef HAVE_SYS_SELECT_H
78. # include <sys/select.h> /* for convenience */
79. #endif
81. #ifdef HAVE_POLL_H
82. # include <poll.h> /* for convenience */
83. #endif
85. #ifdef HAVE_STROPTS_H
86. # include <stropts.h> /* for convenience */
87. #endif
89. #ifdef HAVE_STRINGS_H
90. # include <strings.h> /* for convenience */
91. #endif
93. /* Next three headers are normally needed for socket/file ioctl's:
94.  * <sys/ioctl.h>, <sys/filio.h>, and <sys/sockio.h>.
95.  */
96. #ifdef HAVE_SYS_IOCTL_H
97. # include <sys/ioctl.h>
98. #endif
99. #ifdef HAVE_SYS_FILIO_H
100. # include <sys/filio.h>
101. #endif
103. #ifdef HAVE_PTHREAD_H
104. # include <pthread.h>
105. #endif
107. #ifdef HAVE_DOOR_H
108. # include <door.h> /* Solaris doors API */
109. #endif
111. #ifdef HAVE_RPC_RPC_H
112. #ifdef _PSX4_NSPACE_H_TS /* Digital Unix 4.0b hack, hack, hack */
113. #undef SUCCESS
114. #endif
115. # include <rpc/rpc.h> /* Sun RPC */
116. #endif
118. /* Define bzero() as a macro if it's not in standard C library. */
119. #ifndef HAVE_BZERO
120. #define bzero(ptr,n) memset(ptr, 0, n)
121. #endif
123. /* Posix.1g requires that an #include of <poll.h> DefinE INFTIM, but many
124.    systems still DefinE it in <sys/stropts.h>.  We don't want to include
125.    all the streams stuff if it's not needed, so we just DefinE INFTIM here.
126.    This is the standard value, but there's no guarantee it is -1. */
127. #ifndef INFTIM
128. #define INFTIM          (-1)    /* infinite poll timeout */
129. #ifdef HAVE_POLL_H
130. #define INFTIM_UNPH /* tell unpxti.h we defined it */
131. #endif
132. #endif
134. /* Miscellaneous constants */
135. #ifndef PATH_MAX /* should be in <limits.h> */
136. #define PATH_MAX 1024 /* max # of characters in a pathname */
137. #endif
139. #define MAX_PATH 1024
140. /* $$.ix [MAX_PATH]~constant,~definition~of$$ */
141. #define MAXLINE 4096 /* max text line length */
142. /* $$.ix [MAXLINE]~constant,~definition~of$$ */
143. /* $$.ix [BUFFSIZE]~constant,~definition~of$$ */
144. #define BUFFSIZE 8192 /* buffer size for reads and writes */
146. #define FILE_MODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)
147. /* default permissions for new files */
148. /* $$.ix [FILE_MODE]~constant,~definition~of$$ */
149. #define DIR_MODE (FILE_MODE | S_IXUSR | S_IXGRP | S_IXOTH)
150. /* default permissions for new directories */
151. /* $$.ix [DIR_MODE]~constant,~definition~of$$ */
153. #define SVMSG_MODE (MSG_R | MSG_W | MSG_R>>3 | MSG_R>>6)
154. /* default permissions for new SV message queues */
155. /* $$.ix [SVMSG_MODE]~constant,~definition~of$$ */
156. #define SVSEM_MODE (SEM_R | SEM_A | SEM_R>>3 | SEM_R>>6)
157. /* default permissions for new SV semaphores */
158. /* $$.ix [SVSEM_MODE]~constant,~definition~of$$ */
159. #define SVSHM_MODE (SHM_R | SHM_W | SHM_R>>3 | SHM_R>>6)
160. /* default permissions for new SV shared memory */
161. /* $$.ix [SVSHM_MODE]~constant,~definition~of$$ */
163. typedef void Sigfunc(int); /* for signal handlers */
165. #ifdef HAVE_SIGINFO_T_STRUCT
166. typedef void Sigfunc_rt(int, siginfo_t *, void *);
167. #endif
169. #define min(a,b) ((a) < (b) ? (a) : (b))
170. #define max(a,b) ((a) > (b) ? (a) : (b))
172. #ifndef HAVE_TIMESPEC_STRUCT
173. struct timespec {
174.   time_t tv_sec; /* seconds */
175.   long tv_nsec; /* and nanoseconds */
176. };
177. /* $$.It timespec$$ */
178. /* $$.Ib tv_sec$$ */
179. /* $$.Ib tv_nsec$$ */
180. #endif
182. /*
183.  * In our wrappers for open(), mq_open(), and sem_open() we handle the
184.  * optional arguments using the va_XXX() macros.  But one of the optional
185.  * arguments is of type "mode_t" and this breaks under BSD/OS because it
186.  * uses a 16-bit integer for this datatype.  But when our wrapper function
187.  * is called, the compiler expands the 16-bit short integer to a 32-bit
188.  * integer.  This breaks our call to va_arg().  All we can do is the
189.  * following hack.  Other systems in addition to BSD/OS might have this
190.  * problem too ...
191.  */
193. #ifdef __bsdi__
194. #define va_mode_t int
195. #else
196. #define va_mode_t mode_t
197. #endif
198. /* $$.ix [va_mode_t]~datatype,~definition~of$$ */
200. /* our record locking macros */
201. #define read_lock(fd, offset, whence, len) 
202. lock_reg(fd, F_SETLK, F_RDLCK, offset, whence, len)
203. #define readw_lock(fd, offset, whence, len) 
204. lock_reg(fd, F_SETLKW, F_RDLCK, offset, whence, len)
205. #define write_lock(fd, offset, whence, len) 
206. lock_reg(fd, F_SETLK, F_WRLCK, offset, whence, len)
207. #define writew_lock(fd, offset, whence, len) 
208. lock_reg(fd, F_SETLKW, F_WRLCK, offset, whence, len)
209. #define un_lock(fd, offset, whence, len) 
210. lock_reg(fd, F_SETLK, F_UNLCK, offset, whence, len)
211. #define is_read_lockable(fd, offset, whence, len) 
212. lock_test(fd, F_RDLCK, offset, whence, len)
213. #define is_write_lockable(fd, offset, whence, len) 
214. lock_test(fd, F_WRLCK, offset, whence, len)
215. /* end unpipch */
217. #define Read_lock(fd, offset, whence, len) 
218. Lock_reg(fd, F_SETLK, F_RDLCK, offset, whence, len)
219. #define Readw_lock(fd, offset, whence, len) 
220. Lock_reg(fd, F_SETLKW, F_RDLCK, offset, whence, len)
221. #define Write_lock(fd, offset, whence, len) 
222. Lock_reg(fd, F_SETLK, F_WRLCK, offset, whence, len)
223. #define Writew_lock(fd, offset, whence, len) 
224. Lock_reg(fd, F_SETLKW, F_WRLCK, offset, whence, len)
225. #define Un_lock(fd, offset, whence, len) 
226. Lock_reg(fd, F_SETLK, F_UNLCK, offset, whence, len)
227. #define Is_read_lockable(fd, offset, whence, len) 
228. Lock_test(fd, F_RDLCK, offset, whence, len)
229. #define Is_write_lockable(fd, offset, whence, len) 
230. Lock_test(fd, F_WRLCK, offset, whence, len)
232. /* prototypes for our own library functions */
233. void  daemon_init(const char *, int);
234. void  daemon_inetd(const char *, int);
235. char *gf_time(void);
236. int  lock_reg(int, int, int, off_t, int, off_t);
237. pid_t  lock_test(int, int, off_t, int, off_t);
238. void *my_shm(size_t);
239. char *px_ipc_name(const char *);
240. int  readable_timeo(int, int);
241. ssize_t  readline(int, void *, size_t);
242. ssize_t  readn(int, void *, size_t);
243. int  set_concurrency(int);
244. Sigfunc *signal_intr(int, Sigfunc *);
245. int    sleep_us(unsigned int);
246. int  start_time(void);
247. double  stop_time(void);
248. int  touch(void *, int);
249. void  tv_sub(struct timeval *, struct timeval *);
250. int  writable_timeo(int, int);
251. ssize_t  writen(int, const void *, size_t);
253. #ifndef HAVE_GETHOSTNAME_PROTO
254. int  gethostname(char *, int);
255. #endif
257. #ifndef HAVE_ISFDTYPE_PROTO
258. int  isfdtype(int, int);
259. #endif
261. #ifndef HAVE_PSELECT_PROTO
262. int  pselect(int, fd_set *, fd_set *, fd_set *,
263.  const struct timespec *, const sigset_t *);
264. #endif
266. #ifndef HAVE_SNPRINTF_PROTO
267. int  snprintf(char *, size_t, const char *, ...);
268. #endif
270. /* prototypes for our own library wrapper functions */
271. char *Gf_time(void);
272. void  Lock_reg(int, int, int, off_t, int, off_t);
273. pid_t  Lock_test(int, int, off_t, int, off_t);
274. void *My_shm(size_t);
275. char *Px_ipc_name(const char *);
276. int  Readable_timeo(int, int);
277. ssize_t  Readline(int, void *, size_t);
278. ssize_t  Readn(int, void *, size_t);
279. void  Set_concurrency(int);
280. Sigfunc *Signal(int, Sigfunc *);
281. Sigfunc *Signal_intr(int, Sigfunc *);
283. #ifdef HAVE_SIGINFO_T_STRUCT
284. Sigfunc_rt *Signal_rt(int, Sigfunc_rt *);
285. Sigfunc_rt *Signal_rt_intr(int, Sigfunc_rt *);
286. #endif
288. void  Sleep_us(unsigned int);
289. void  Start_time(void);
290. double  Stop_time(void);
291. void  Touch(void *, int);
292. int  Writable_timeo(int, int);
293. void  Writen(int, void *, size_t);
295. /* prototypes for our Unix wrapper functions */
296. void *Calloc(size_t, size_t);
297. void  Close(int);
298. void  Dup2(int, int);
299. int  Fcntl(int, int, void *);
300. pid_t  Fork(void);
301. long  Fpathconf(int, int);
302. void  Fstat(int, struct stat *);
303. key_t  Ftok(const char *, int);
304. void  Ftruncate(int, off_t);
305. int  Getopt(int, char *const *, const char *);
306. void  Gettimeofday(struct timeval *, void *);
307. int  Ioctl(int, int, void *);
308. void  Kill(pid_t, int);
309. off_t  Lseek(int, off_t, int);
310. void *Malloc(size_t);
311. void  Mkfifo(const char *, mode_t);
312. void  Mktemp(char *);
313. void *Mmap(void *, size_t, int, int, int, off_t);
314. void  Munmap(void *, size_t);
315. int  Open(const char *, int, ...);
316. long  Pathconf(const char *, int);
317. void  Pipe(int *fds);
318. ssize_t  Read(int, void *, size_t);
319. int  Select(int, fd_set *, fd_set *, fd_set *, struct timeval *);
320. void  Sigaddset(sigset_t *, int);
321. void  Sigdelset(sigset_t *, int);
322. void  Sigemptyset(sigset_t *);
323. void  Sigfillset(sigset_t *);
324. int  Sigismember(const sigset_t *, int);
325. void  Sigpending(sigset_t *);
326. void  Sigprocmask(int, const sigset_t *, sigset_t *);
327. #ifdef HAVE_SIGINFO_T_STRUCT
328. void  Sigqueue(pid_t, int, const union sigval);
329. #endif
330. #ifdef HAVE_SIGWAIT
331. void  Sigwait(const sigset_t *, int *);
332. #endif
333. void  Stat(const char *, struct stat *);
334. char *Strdup(const char *);
335. long  Sysconf(int);
336. void  Sysctl(int *, u_int, void *, size_t *, void *, size_t);
337. void  Unlink(const char *);
338. void *Valloc(size_t);
339. pid_t  Wait(int *);
340. pid_t  Waitpid(pid_t, int *, int);
341. void  Write(int, void *, size_t);
343. #ifdef HAVE_MQUEUE_H
344. /* 4Posix message queues */
345. mqd_t  Mq_open(const char *, int, ...);
346. void  Mq_close(mqd_t);
347. void  Mq_unlink(const char *pathname);
348. void  Mq_send(mqd_t, const char *, size_t, unsigned int);
349. ssize_t  Mq_receive(mqd_t, char *, size_t, unsigned int *);
350. void  Mq_notify(mqd_t, const struct sigevent *);
351. void  Mq_getattr(mqd_t, struct mq_attr *);
352. void  Mq_setattr(mqd_t, const struct mq_attr *, struct mq_attr *);
353. #endif /* HAVE_MQUEUE_H */
355. #ifdef HAVE_SEMAPHORE_H
356. /* 4Posix semaphores */
357. sem_t *Sem_open(const char *, int, ...);
358. void  Sem_close(sem_t *);
359. void  Sem_unlink(const char *);
360. void  Sem_init(sem_t *, int, unsigned int);
361. void  Sem_destroy(sem_t *);
362. void  Sem_wait(sem_t *);
363. int  Sem_trywait(sem_t *);
364. void  Sem_post(sem_t *);
365. void  Sem_getvalue(sem_t *, int *);
366. #endif /* HAVE_SEMAPHORE_H */
368. /* Note that <sys/mman.h> is defined on some systems that do not support
369.  * Posix shared memory (e.g., 4.4BSD), because this header predates Posix
370.  * and appears on any system that supports mmap().  Therefore we cannot
371.  * use this to determine whether the implementation supports Posix shared
372.  * memory or not.  We use our own HAVE_SHM_OPEN_PROTO symbol.
373.  */
375. #ifdef HAVE_SHM_OPEN_PROTO
376. /* 4Posix shared memory */
377. int  Shm_open(const char *, int, mode_t);
378. void  Shm_unlink(const char *);
379. #endif
381. #ifdef HAVE_SYS_MSG_H
382. /* 4System V message queues */
383. int  Msgget(key_t key, int flag);
384. void  Msgctl(int, int, struct msqid_ds *);
385. void  Msgsnd(int, const void *, size_t, int);
386. ssize_t  Msgrcv(int, void *, size_t, int, int);
387. #endif /* HAVE_SYS_MSG_H */
389. #ifdef HAVE_SYS_SEM_H
390. /* 4System V semaphores */
391. int  Semget(key_t, int, int);
392. int  Semctl(int, int, int, ...);
393. void  Semop(int, struct sembuf *, size_t);
394. #endif /* HAVE_SYS_SEM_H */
396. #ifdef HAVE_SYS_SHM_H
397. /* 4System V shared memory */
398. int  Shmget(key_t, size_t, int);
399. void *Shmat(int, const void *, int);
400. void  Shmdt(const void *);
401. void  Shmctl(int, int, struct shmid_ds *);
402. #endif /* HAVE_SYS_SHM_H */
404. /* prototypes for our stdio wrapper functions */
405. void  Fclose(FILE *);
406. FILE *Fdopen(int, const char *);
407. char *Fgets(char *, int, FILE *);
408. FILE *Fopen(const char *, const char *);
409. void  Fputs(const char *, FILE *);
410. FILE *Popen(const char *, const char *);
411. int  Pclose(FILE *);
413. #ifdef HAVE_FATTACH
414. void  Fattach(int, const char *);
415. #endif
416. #ifdef HAVE_POLL
417. int  Poll(struct pollfd *, unsigned long, int);
418. #endif
420. void  err_dump(const char *, ...);
421. void  err_msg(const char *, ...);
422. void  err_quit(const char *, ...);
423. void  err_ret(const char *, ...);
424. void  err_sys(const char *, ...);
426. /* prototypes for our pthread wrapper functions */
427. void  Pthread_attr_init(pthread_attr_t *);
428. void  Pthread_attr_destroy(pthread_attr_t *);
429. void  Pthread_attr_setdetachstate(pthread_attr_t *, int);
430. void  Pthread_attr_setscope(pthread_attr_t *, int);
431. void  Pthread_create(pthread_t *, const pthread_attr_t *,
432.     void * (*)(void *), void *);
433. void  Pthread_join(pthread_t, void **);
434. void  Pthread_detach(pthread_t);
435. void  Pthread_kill(pthread_t, int);
436. void  Pthread_setcancelstate(int, int *);
438. void  Pthread_mutexattr_init(pthread_mutexattr_t *);
439. void  Pthread_mutexattr_destroy(pthread_mutexattr_t *);
440. void  Pthread_mutexattr_setpshared(pthread_mutexattr_t *, int);
441. void  Pthread_mutex_init(pthread_mutex_t *, pthread_mutexattr_t *);
442. void  Pthread_mutex_destroy(pthread_mutex_t *);
443. void  Pthread_mutex_lock(pthread_mutex_t *);
444. void  Pthread_mutex_unlock(pthread_mutex_t *);
446. void  Pthread_condattr_init(pthread_condattr_t *);
447. void  Pthread_condattr_destroy(pthread_condattr_t *);
448. void  Pthread_condattr_setpshared(pthread_condattr_t *, int);
449. void  Pthread_cond_broadcast(pthread_cond_t *);
450. void  Pthread_cond_signal(pthread_cond_t *);
451. void  Pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
452. void  Pthread_cond_timedwait(pthread_cond_t *, pthread_mutex_t *,
453.     const struct timespec *);
455. void  Pthread_key_create(pthread_key_t *, void (*)(void *));
456. void  Pthread_setspecific(pthread_key_t, const void *);
457. void  Pthread_once(pthread_once_t *, void (*)(void));
458. long  pr_thread_id(pthread_t *);
460. #ifdef HAVE_DOOR_H
461. /* typedefs to simplify declarations */
462. typedef void  Door_server_proc(void *, char *, size_t, door_desc_t *, size_t);
463. typedef void  Door_create_proc(door_info_t *);
465. /* prototypes for our doors wrapper functions */
467. void  Door_bind(int);
468. void  Door_call(int, door_arg_t *);
469. int  Door_create(Door_server_proc *, void *, u_int);
470. void  Door_cred(door_cred_t *);
471. void  Door_info(int, door_info_t *);
472. void  Door_return(char *, size_t, door_desc_t *, size_t);
473. void  Door_revoke(int);
474. void  Door_unbind(void);
475. Door_create_proc *Door_server_create(Door_create_proc *);
476. #endif /* HAVE_DOOR_H */
478. #ifdef HAVE_RPC_RPC_H
479. CLIENT *Clnt_create(const char *, u_long, u_long, const char *);
480. void  Clnt_control(CLIENT *, u_int, char *);
481. #endif
483. #endif /* __unpipc_h */