xref: /freebsd-12.1/contrib/ntp/lib/isc/socket_api.c (revision 2b15cb3d)
1 /*
2  * Copyright (C) 2009, 2011, 2012  Internet Systems Consortium, Inc. ("ISC")
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
10  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
11  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14  * PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 /* $Id$ */
18 
19 #include <config.h>
20 
21 #include <isc/app.h>
22 #include <isc/magic.h>
23 #include <isc/mutex.h>
24 #include <isc/once.h>
25 #include <isc/socket.h>
26 #include <isc/util.h>
27 
28 static isc_mutex_t createlock;
29 static isc_once_t once = ISC_ONCE_INIT;
30 static isc_socketmgrcreatefunc_t socketmgr_createfunc = NULL;
31 
32 static void
initialize(void)33 initialize(void) {
34 	RUNTIME_CHECK(isc_mutex_init(&createlock) == ISC_R_SUCCESS);
35 }
36 
37 isc_result_t
isc_socket_register(isc_socketmgrcreatefunc_t createfunc)38 isc_socket_register(isc_socketmgrcreatefunc_t createfunc) {
39 	isc_result_t result = ISC_R_SUCCESS;
40 
41 	RUNTIME_CHECK(isc_once_do(&once, initialize) == ISC_R_SUCCESS);
42 
43 	LOCK(&createlock);
44 	if (socketmgr_createfunc == NULL)
45 		socketmgr_createfunc = createfunc;
46 	else
47 		result = ISC_R_EXISTS;
48 	UNLOCK(&createlock);
49 
50 	return (result);
51 }
52 
53 isc_result_t
isc_socketmgr_createinctx(isc_mem_t * mctx,isc_appctx_t * actx,isc_socketmgr_t ** managerp)54 isc_socketmgr_createinctx(isc_mem_t *mctx, isc_appctx_t *actx,
55 			  isc_socketmgr_t **managerp)
56 {
57 	isc_result_t result;
58 
59 	LOCK(&createlock);
60 
61 	REQUIRE(socketmgr_createfunc != NULL);
62 	result = (*socketmgr_createfunc)(mctx, managerp);
63 
64 	UNLOCK(&createlock);
65 
66 	if (result == ISC_R_SUCCESS)
67 		isc_appctx_setsocketmgr(actx, *managerp);
68 
69 	return (result);
70 }
71 
72 isc_result_t
isc_socketmgr_create(isc_mem_t * mctx,isc_socketmgr_t ** managerp)73 isc_socketmgr_create(isc_mem_t *mctx, isc_socketmgr_t **managerp) {
74 	isc_result_t result;
75 
76 	LOCK(&createlock);
77 
78 	REQUIRE(socketmgr_createfunc != NULL);
79 	result = (*socketmgr_createfunc)(mctx, managerp);
80 
81 	UNLOCK(&createlock);
82 
83 	return (result);
84 }
85 
86 void
isc_socketmgr_destroy(isc_socketmgr_t ** managerp)87 isc_socketmgr_destroy(isc_socketmgr_t **managerp) {
88 	REQUIRE(managerp != NULL && ISCAPI_SOCKETMGR_VALID(*managerp));
89 
90 	(*managerp)->methods->destroy(managerp);
91 
92 	ENSURE(*managerp == NULL);
93 }
94 
95 isc_result_t
isc_socket_create(isc_socketmgr_t * manager,int pf,isc_sockettype_t type,isc_socket_t ** socketp)96 isc_socket_create(isc_socketmgr_t *manager, int pf, isc_sockettype_t type,
97 		  isc_socket_t **socketp)
98 {
99 	REQUIRE(ISCAPI_SOCKETMGR_VALID(manager));
100 
101 	return (manager->methods->socketcreate(manager, pf, type, socketp));
102 }
103 
104 void
isc_socket_attach(isc_socket_t * sock,isc_socket_t ** socketp)105 isc_socket_attach(isc_socket_t *sock, isc_socket_t **socketp) {
106 	REQUIRE(ISCAPI_SOCKET_VALID(sock));
107 	REQUIRE(socketp != NULL && *socketp == NULL);
108 
109 	sock->methods->attach(sock, socketp);
110 
111 	ENSURE(*socketp == sock);
112 }
113 
114 void
isc_socket_detach(isc_socket_t ** socketp)115 isc_socket_detach(isc_socket_t **socketp) {
116 	REQUIRE(socketp != NULL && ISCAPI_SOCKET_VALID(*socketp));
117 
118 	(*socketp)->methods->detach(socketp);
119 
120 	ENSURE(*socketp == NULL);
121 }
122 
123 isc_result_t
isc_socket_bind(isc_socket_t * sock,isc_sockaddr_t * sockaddr,unsigned int options)124 isc_socket_bind(isc_socket_t *sock, isc_sockaddr_t *sockaddr,
125 		unsigned int options)
126 {
127 	REQUIRE(ISCAPI_SOCKET_VALID(sock));
128 
129 	return (sock->methods->bind(sock, sockaddr, options));
130 }
131 
132 isc_result_t
isc_socket_sendto(isc_socket_t * sock,isc_region_t * region,isc_task_t * task,isc_taskaction_t action,const void * arg,isc_sockaddr_t * address,struct in6_pktinfo * pktinfo)133 isc_socket_sendto(isc_socket_t *sock, isc_region_t *region, isc_task_t *task,
134 		  isc_taskaction_t action, const void *arg,
135 		  isc_sockaddr_t *address, struct in6_pktinfo *pktinfo)
136 {
137 	REQUIRE(ISCAPI_SOCKET_VALID(sock));
138 
139 	return (sock->methods->sendto(sock, region, task, action, arg, address,
140 				      pktinfo));
141 }
142 
143 isc_result_t
isc_socket_connect(isc_socket_t * sock,isc_sockaddr_t * addr,isc_task_t * task,isc_taskaction_t action,const void * arg)144 isc_socket_connect(isc_socket_t *sock, isc_sockaddr_t *addr, isc_task_t *task,
145 		   isc_taskaction_t action, const void *arg)
146 {
147 	REQUIRE(ISCAPI_SOCKET_VALID(sock));
148 
149 	return (sock->methods->connect(sock, addr, task, action, arg));
150 }
151 
152 isc_result_t
isc_socket_recv(isc_socket_t * sock,isc_region_t * region,unsigned int minimum,isc_task_t * task,isc_taskaction_t action,const void * arg)153 isc_socket_recv(isc_socket_t *sock, isc_region_t *region, unsigned int minimum,
154 		isc_task_t *task, isc_taskaction_t action, const void *arg)
155 {
156 	REQUIRE(ISCAPI_SOCKET_VALID(sock));
157 
158 	return (sock->methods->recv(sock, region, minimum, task, action, arg));
159 }
160 
161 void
isc_socket_cancel(isc_socket_t * sock,isc_task_t * task,unsigned int how)162 isc_socket_cancel(isc_socket_t *sock, isc_task_t *task, unsigned int how) {
163 	REQUIRE(ISCAPI_SOCKET_VALID(sock));
164 
165 	sock->methods->cancel(sock, task, how);
166 }
167 
168 isc_result_t
isc_socket_getsockname(isc_socket_t * sock,isc_sockaddr_t * addressp)169 isc_socket_getsockname(isc_socket_t *sock, isc_sockaddr_t *addressp) {
170 	REQUIRE(ISCAPI_SOCKET_VALID(sock));
171 
172 	return (sock->methods->getsockname(sock, addressp));
173 }
174 
175 void
isc_socket_ipv6only(isc_socket_t * sock,isc_boolean_t yes)176 isc_socket_ipv6only(isc_socket_t *sock, isc_boolean_t yes) {
177 	REQUIRE(ISCAPI_SOCKET_VALID(sock));
178 
179 	sock->methods->ipv6only(sock, yes);
180 }
181 
182 isc_sockettype_t
isc_socket_gettype(isc_socket_t * sock)183 isc_socket_gettype(isc_socket_t *sock) {
184 	REQUIRE(ISCAPI_SOCKET_VALID(sock));
185 
186 	return (sock->methods->gettype(sock));
187 }
188 
189 void
isc_socket_setname(isc_socket_t * socket,const char * name,void * tag)190 isc_socket_setname(isc_socket_t *socket, const char *name, void *tag) {
191 	REQUIRE(ISCAPI_SOCKET_VALID(socket));
192 
193 	UNUSED(socket);		/* in case REQUIRE() is empty */
194 	UNUSED(name);
195 	UNUSED(tag);
196 }
197 
198 isc_result_t
isc_socket_fdwatchcreate(isc_socketmgr_t * manager,int fd,int flags,isc_sockfdwatch_t callback,void * cbarg,isc_task_t * task,isc_socket_t ** socketp)199 isc_socket_fdwatchcreate(isc_socketmgr_t *manager, int fd, int flags,
200 			 isc_sockfdwatch_t callback, void *cbarg,
201 			 isc_task_t *task, isc_socket_t **socketp)
202 {
203 	REQUIRE(ISCAPI_SOCKETMGR_VALID(manager));
204 
205 	return (manager->methods->fdwatchcreate(manager, fd, flags,
206 						callback, cbarg, task,
207 						socketp));
208 }
209 
210 isc_result_t
isc_socket_fdwatchpoke(isc_socket_t * sock,int flags)211 isc_socket_fdwatchpoke(isc_socket_t *sock, int flags)
212 {
213 	REQUIRE(ISCAPI_SOCKET_VALID(sock));
214 
215 	return(sock->methods->fdwatchpoke(sock, flags));
216 }
217 
218 isc_result_t
isc_socket_dup(isc_socket_t * sock,isc_socket_t ** socketp)219 isc_socket_dup(isc_socket_t *sock, isc_socket_t **socketp) {
220 	REQUIRE(ISCAPI_SOCKET_VALID(sock));
221 	REQUIRE(socketp != NULL && *socketp == NULL);
222 
223 	return(sock->methods->dup(sock, socketp));
224 }
225 
226 int
isc_socket_getfd(isc_socket_t * sock)227 isc_socket_getfd(isc_socket_t *sock) {
228 	REQUIRE(ISCAPI_SOCKET_VALID(sock));
229 
230 	return(sock->methods->getfd(sock));
231 }
232