xref: /netbsd-src/lib/librumpclient/rumpclient.h (revision 946379e7b37692fc43f68eb0d1c10daa0a7f3b6c)
1 /*	$NetBSD: rumpclient.h,v 1.15 2013/01/20 15:23:21 pooka Exp $	*/
2 
3 /*-
4  * Copyright (c) 2010 Antti Kantee.  All Rights Reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
16  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18  * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef _RUMP_RUMPCLIENT_H_
29 #define _RUMP_RUMPCLIENT_H_
30 
31 #include <sys/types.h>
32 
33 #if !defined(__returns_twice)
34 #ifdef __GNUC__
35 #define __returns_twice __attribute__((__returns_twice__))
36 #else /* __GNUC__ */
37 #define __returns_twice
38 #endif /* !__GNUC__ */
39 #endif /* !__returns_twice */
40 
41 #if defined(__sun__) && !defined(RUMP_REGISTER_T)
42 #define RUMP_REGISTER_T long
43 typedef RUMP_REGISTER_T register_t;
44 #endif
45 
46 struct rumpclient_fork;
47 
48 #define rumpclient_vfork() rumpclient__dofork(vfork)
49 
50 #ifdef __BEGIN_DECLS
51 __BEGIN_DECLS
52 #elif defined(__cplusplus)
53 extern "C" {
54 #endif
55 
56 int rumpclient_syscall(int, const void *, size_t, register_t *);
57 int rumpclient_init(void);
58 
59 struct rumpclient_fork *rumpclient_prefork(void);
60 int			rumpclient_fork_init(struct rumpclient_fork *);
61 void			rumpclient_fork_cancel(struct rumpclient_fork *);
62 void			rumpclient_fork_vparent(struct rumpclient_fork *);
63 
64 pid_t rumpclient_fork(void);
65 int rumpclient_exec(const char *, char *const [], char *const[]);
66 int rumpclient_daemon(int, int);
67 
68 #define RUMPCLIENT_RETRYCONN_INFTIME ((time_t)-1)
69 #define RUMPCLIENT_RETRYCONN_ONCE ((time_t)-2)
70 #define RUMPCLIENT_RETRYCONN_DIE ((time_t)-3)
71 void rumpclient_setconnretry(time_t);
72 
73 enum rumpclient_closevariant {
74 	RUMPCLIENT_CLOSE_CLOSE,
75 	RUMPCLIENT_CLOSE_DUP2,
76 	RUMPCLIENT_CLOSE_FCLOSEM
77 };
78 int rumpclient__closenotify(int *, enum rumpclient_closevariant);
79 
80 
81 /*
82  * vfork needs to be implemented as an inline to make everything
83  * run in the caller's stackframe.
84  */
85 static __attribute__((__always_inline__)) __returns_twice inline pid_t
86 rumpclient__dofork(pid_t (*forkfn)(void))
87 {
88 	struct rumpclient_fork *rf;
89 	pid_t pid;
90 	int childran = 0;
91 
92 	if (!(rf = rumpclient_prefork()))
93 		return -1;
94 
95 	switch ((pid = forkfn())) {
96 	case -1:
97 		rumpclient_fork_cancel(rf);
98 		break;
99 	case 0:
100 		childran = 1;
101 		if (rumpclient_fork_init(rf) == -1)
102 			pid = -1;
103 		break;
104 	default:
105 		/* XXX: multithreaded vforker?  do they exist? */
106 		if (childran)
107 			rumpclient_fork_vparent(rf);
108 		break;
109 	}
110 
111 	return pid;
112 }
113 
114 #ifdef __END_DECLS
115 __END_DECLS
116 #elif defined(__cplusplus)
117 }
118 #endif
119 
120 #endif /* _RUMP_RUMPCLIENT_H_ */
121