lib/vconn-unix.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #include <config.h>
  35 #include "vconn.h"
  36 #include <assert.h>
  37 #include <errno.h>
  38 #include <inttypes.h>
  39 #include <netdb.h>
  40 #include <poll.h>
  41 #include <sys/types.h>
  42 #include <sys/un.h>
  43 #include <stdlib.h>
  44 #include <string.h>
  45 #include <unistd.h>
  46 #include "ofpbuf.h"
  47 #include "openflow.h"
  48 #include "packets.h"
  49 #include "poll-loop.h"
  50 #include "socket-util.h"
  51 #include "util.h"
  52 #include "vconn-provider.h"
  53 #include "vconn-stream.h"
  54
  55 #include "vlog.h"
  56 #define THIS_MODULE VLM_vconn_unix
  57
  58 /* Active UNIX socket. */
  59
  60 /* Number of unix sockets created so far, to ensure binding path uniqueness. */
  61 static int n_unix_sockets;
  62
  63 static int
  64 unix_open(const char *name, char *suffix, struct vconn **vconnp)
  65 {
  66     const char *connect_path = suffix;
  67     char bind_path[128];
  68     int fd;
  69
  70     sprintf(bind_path, "/tmp/vconn-unix.%ld.%d",
  71             (long int) getpid(), n_unix_sockets++);
  72     fd = make_unix_socket(SOCK_STREAM, true, false, bind_path, connect_path);
  73     if (fd < 0) {
  74         VLOG_ERR("%s: connection to %s failed: %s",
  75                  bind_path, connect_path, strerror(-fd));
  76         return -fd;
  77     }
  78
  79     return new_stream_vconn(name, fd, check_connection_completion(fd),
  80                             0, vconnp);
  81 }
  82
  83 struct vconn_class unix_vconn_class = {
  84     "unix",                     /* name */
  85     unix_open,                  /* open */
  86     NULL,                       /* close */
  87     NULL,                       /* connect */
  88     NULL,                       /* accept */
  89     NULL,                       /* recv */
  90     NULL,                       /* send */
  91     NULL,                       /* wait */
  92 };
  93 \f
  94 /* Passive UNIX socket. */
  95
  96 static int punix_accept(int fd, const struct sockaddr *sa, size_t sa_len,
  97                         struct vconn **vconnp);
  98
  99 static int
 100 punix_open(const char *name, char *suffix, struct vconn **vconnp)
 101 {
 102     int fd;
 103
 104     fd = make_unix_socket(SOCK_STREAM, true, true, suffix, NULL);
 105     if (fd < 0) {
 106         VLOG_ERR("%s: binding failed: %s", suffix, strerror(errno));
 107         return errno;
 108     }
 109
 110     return new_pstream_vconn("punix", fd, punix_accept, vconnp);
 111 }
 112
 113 static int
 114 punix_accept(int fd, const struct sockaddr *sa, size_t sa_len,
 115              struct vconn **vconnp)
 116 {
 117     const struct sockaddr_un *sun = (const struct sockaddr_un *) sa;
 118     char name[128];
 119
 120     if (sa_len >= offsetof(struct sockaddr_un, sun_path)) {
 121         snprintf(name, sizeof name, "unix:%.*s",
 122                 (int) (sa_len - offsetof(struct sockaddr_un, sun_path)),
 123                 sun->sun_path);
 124     } else {
 125         strcpy(name, "unix");
 126     }
 127     return new_stream_vconn(name, fd, 0, 0, vconnp);
 128 }
 129
 130 struct vconn_class punix_vconn_class = {
 131     "punix",                    /* name */
 132     punix_open,                 /* open */
 133     NULL,                       /* close */
 134     NULL,                       /* connect */
 135     NULL,                       /* accept */
 136     NULL,                       /* recv */
 137     NULL,                       /* send */
 138     NULL,                       /* wait */
 139 };
 140