contrib/bind9/lib/isc/socket_api.c

   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
  33 initialize(void) {
  34         RUNTIME_CHECK(isc_mutex_init(&createlock) == ISC_R_SUCCESS);
  35 }
  36
  37 isc_result_t
  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
  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
  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
  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
  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
 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
 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
 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
 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
 144 isc_socket_sendto2(isc_socket_t *sock, isc_region_t *region,
 145                    isc_task_t *task, isc_sockaddr_t *address,
 146                    struct in6_pktinfo *pktinfo, isc_socketevent_t *event,
 147                    unsigned int flags)
 148 {
 149         REQUIRE(ISCAPI_SOCKET_VALID(sock));
 150
 151         return (sock->methods->sendto2(sock, region, task, address,
 152                                        pktinfo, event, flags));
 153 }
 154
 155 isc_result_t
 156 isc_socket_connect(isc_socket_t *sock, isc_sockaddr_t *addr, isc_task_t *task,
 157                    isc_taskaction_t action, const void *arg)
 158 {
 159         REQUIRE(ISCAPI_SOCKET_VALID(sock));
 160
 161         return (sock->methods->connect(sock, addr, task, action, arg));
 162 }
 163
 164 isc_result_t
 165 isc_socket_recv(isc_socket_t *sock, isc_region_t *region, unsigned int minimum,
 166                 isc_task_t *task, isc_taskaction_t action, const void *arg)
 167 {
 168         REQUIRE(ISCAPI_SOCKET_VALID(sock));
 169
 170         return (sock->methods->recv(sock, region, minimum, task, action, arg));
 171 }
 172
 173 isc_result_t
 174 isc_socket_recv2(isc_socket_t *sock, isc_region_t *region,
 175                  unsigned int minimum, isc_task_t *task,
 176                  isc_socketevent_t *event, unsigned int flags)
 177 {
 178         REQUIRE(ISCAPI_SOCKET_VALID(sock));
 179
 180         return (sock->methods->recv2(sock, region, minimum, task,
 181                                      event, flags));
 182 }
 183
 184 void
 185 isc_socket_cancel(isc_socket_t *sock, isc_task_t *task, unsigned int how) {
 186         REQUIRE(ISCAPI_SOCKET_VALID(sock));
 187
 188         sock->methods->cancel(sock, task, how);
 189 }
 190
 191 isc_result_t
 192 isc_socket_getsockname(isc_socket_t *sock, isc_sockaddr_t *addressp) {
 193         REQUIRE(ISCAPI_SOCKET_VALID(sock));
 194
 195         return (sock->methods->getsockname(sock, addressp));
 196 }
 197
 198 void
 199 isc_socket_ipv6only(isc_socket_t *sock, isc_boolean_t yes) {
 200         REQUIRE(ISCAPI_SOCKET_VALID(sock));
 201
 202         sock->methods->ipv6only(sock, yes);
 203 }
 204
 205 isc_sockettype_t
 206 isc_socket_gettype(isc_socket_t *sock) {
 207         REQUIRE(ISCAPI_SOCKET_VALID(sock));
 208
 209         return (sock->methods->gettype(sock));
 210 }
 211
 212 void
 213 isc_socket_setname(isc_socket_t *socket, const char *name, void *tag) {
 214         REQUIRE(ISCAPI_SOCKET_VALID(socket));
 215
 216         UNUSED(socket);         /* in case REQUIRE() is empty */
 217         UNUSED(name);
 218         UNUSED(tag);
 219 }
 220
 221 isc_result_t
 222 isc_socket_fdwatchcreate(isc_socketmgr_t *manager, int fd, int flags,
 223                          isc_sockfdwatch_t callback, void *cbarg,
 224                          isc_task_t *task, isc_socket_t **socketp)
 225 {
 226         REQUIRE(ISCAPI_SOCKETMGR_VALID(manager));
 227
 228         return (manager->methods->fdwatchcreate(manager, fd, flags,
 229                                                 callback, cbarg, task,
 230                                                 socketp));
 231 }
 232
 233 isc_result_t
 234 isc_socket_fdwatchpoke(isc_socket_t *sock, int flags)
 235 {
 236         REQUIRE(ISCAPI_SOCKET_VALID(sock));
 237
 238         return(sock->methods->fdwatchpoke(sock, flags));
 239 }
 240
 241 isc_result_t
 242 isc_socket_dup(isc_socket_t *sock, isc_socket_t **socketp) {
 243         REQUIRE(ISCAPI_SOCKET_VALID(sock));
 244         REQUIRE(socketp != NULL && *socketp == NULL);
 245
 246         return(sock->methods->dup(sock, socketp));
 247 }
 248
 249 int
 250 isc_socket_getfd(isc_socket_t *sock) {
 251         REQUIRE(ISCAPI_SOCKET_VALID(sock));
 252
 253         return(sock->methods->getfd(sock));
 254 }