xref: /netbsd-src/lib/librumpclient/rumpclient.h (revision a613f690f9dfb8d760a9cc070c96853792f6e739)
1 /*	$NetBSD: rumpclient.h,v 1.17 2017/05/11 18:44:50 christos 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(RUMP_REGISTER_T)
42 # define RUMP_REGISTER_T long
43 # if !defined(_KERNEL) && !defined(_KMEMUSER) &&  \
44     !defined(_KERNTYPES) && !defined(_STANDALONE)
45 typedef RUMP_REGISTER_T register_t;
46 # endif
47 #endif
48 
49 struct rumpclient_fork;
50 
51 #define rumpclient_vfork() rumpclient__dofork(vfork)
52 
53 #ifdef __BEGIN_DECLS
54 __BEGIN_DECLS
55 #elif defined(__cplusplus)
56 extern "C" {
57 #endif
58 
59 int rumpclient_syscall(int, const void *, size_t, register_t *);
60 int rumpclient_init(void);
61 
62 struct rumpclient_fork *rumpclient_prefork(void);
63 int			rumpclient_fork_init(struct rumpclient_fork *);
64 void			rumpclient_fork_cancel(struct rumpclient_fork *);
65 void			rumpclient_fork_vparent(struct rumpclient_fork *);
66 
67 pid_t rumpclient_fork(void);
68 int rumpclient_exec(const char *, char *const [], char *const[]);
69 int rumpclient_daemon(int, int);
70 
71 #define RUMPCLIENT_RETRYCONN_INFTIME ((time_t)-1)
72 #define RUMPCLIENT_RETRYCONN_ONCE ((time_t)-2)
73 #define RUMPCLIENT_RETRYCONN_DIE ((time_t)-3)
74 void rumpclient_setconnretry(time_t);
75 
76 enum rumpclient_closevariant {
77 	RUMPCLIENT_CLOSE_CLOSE,
78 	RUMPCLIENT_CLOSE_DUP2,
79 	RUMPCLIENT_CLOSE_FCLOSEM
80 };
81 int rumpclient__closenotify(int *, enum rumpclient_closevariant);
82 
83 
84 /*
85  * vfork needs to be implemented as an inline to make everything
86  * run in the caller's stackframe.
87  */
88 static __attribute__((__always_inline__)) __returns_twice inline pid_t
rumpclient__dofork(pid_t (* forkfn)(void))89 rumpclient__dofork(pid_t (*forkfn)(void))
90 {
91 	struct rumpclient_fork *rf;
92 	pid_t pid;
93 	int childran = 0;
94 
95 	if (!(rf = rumpclient_prefork()))
96 		return -1;
97 
98 	switch ((pid = forkfn())) {
99 	case -1:
100 		rumpclient_fork_cancel(rf);
101 		break;
102 	case 0:
103 		childran = 1;
104 		if (rumpclient_fork_init(rf) == -1)
105 			pid = -1;
106 		break;
107 	default:
108 		/* XXX: multithreaded vforker?  do they exist? */
109 		if (childran)
110 			rumpclient_fork_vparent(rf);
111 		break;
112 	}
113 
114 	return pid;
115 }
116 
117 #ifdef __END_DECLS
118 __END_DECLS
119 #elif defined(__cplusplus)
120 }
121 #endif
122 
123 #endif /* _RUMP_RUMPCLIENT_H_ */
124