Ruby: ext/socket/unixsocket.c Source File

00001 /************************************************
00002 
00003   unixsocket.c -
00004 
00005   created at: Thu Mar 31 12:21:29 JST 1994
00006 
00007   Copyright (C) 1993-2007 Yukihiro Matsumoto
00008 
00009 ************************************************/
00010 
00011 #include "rubysocket.h"
00012 
00013 #ifdef HAVE_SYS_UN_H
00014 struct unixsock_arg {
00015     struct sockaddr_un *sockaddr;
00016     socklen_t sockaddrlen;
00017     int fd;
00018 };
00019 
00020 static VALUE
00021 unixsock_connect_internal(VALUE a)
00022 {
00023     struct unixsock_arg *arg = (struct unixsock_arg *)a;
00024     return (VALUE)rsock_connect(arg->fd, (struct sockaddr*)arg->sockaddr,
00025                                 arg->sockaddrlen, 0);
00026 }
00027 
00028 VALUE
00029 rsock_init_unixsock(VALUE sock, VALUE path, int server)
00030 {
00031     struct sockaddr_un sockaddr;
00032     socklen_t sockaddrlen;
00033     int fd, status;
00034     rb_io_t *fptr;
00035 
00036     SafeStringValue(path);
00037     fd = rsock_socket(AF_UNIX, SOCK_STREAM, 0);
00038     if (fd < 0) {
00039         rb_sys_fail("socket(2)");
00040     }
00041 
00042     MEMZERO(&sockaddr, struct sockaddr_un, 1);
00043     sockaddr.sun_family = AF_UNIX;
00044     if (sizeof(sockaddr.sun_path) < (size_t)RSTRING_LEN(path)) {
00045         rb_raise(rb_eArgError, "too long unix socket path (%ldbytes given but %dbytes max)",
00046             RSTRING_LEN(path), (int)sizeof(sockaddr.sun_path));
00047     }
00048     memcpy(sockaddr.sun_path, RSTRING_PTR(path), RSTRING_LEN(path));
00049     sockaddrlen = rsock_unix_sockaddr_len(path);
00050 
00051     if (server) {
00052         status = bind(fd, (struct sockaddr*)&sockaddr, sockaddrlen);
00053     }
00054     else {
00055         int prot;
00056         struct unixsock_arg arg;
00057         arg.sockaddr = &sockaddr;
00058         arg.sockaddrlen = sockaddrlen;
00059         arg.fd = fd;
00060         status = (int)rb_protect(unixsock_connect_internal, (VALUE)&arg, &prot);
00061         if (prot) {
00062             close(fd);
00063             rb_jump_tag(prot);
00064         }
00065     }
00066 
00067     if (status < 0) {
00068         close(fd);
00069         rb_sys_fail_str(rb_inspect(path));
00070     }
00071 
00072     if (server) {
00073         if (listen(fd, 5) < 0) {
00074             close(fd);
00075             rb_sys_fail("listen(2)");
00076         }
00077     }
00078 
00079     rsock_init_sock(sock, fd);
00080     if (server) {
00081         GetOpenFile(sock, fptr);
00082         fptr->pathv = rb_str_new_frozen(path);
00083     }
00084 
00085     return sock;
00086 }
00087 
00088 /*
00089  * call-seq:
00090  *   UNIXSocket.new(path) => unixsocket
00091  *
00092  * Creates a new UNIX client socket connected to _path_.
00093  *
00094  *   s = UNIXSocket.new("/tmp/sock")
00095  *   s.send "hello", 0
00096  *
00097  */
00098 static VALUE
00099 unix_init(VALUE sock, VALUE path)
00100 {
00101     return rsock_init_unixsock(sock, path, 0);
00102 }
00103 
00104 /*
00105  * call-seq:
00106  *   unixsocket.path => path
00107  *
00108  * Returns the path of the local address of unixsocket.
00109  *
00110  *   s = UNIXServer.new("/tmp/sock")
00111  *   p s.path #=> "/tmp/sock"
00112  *
00113  */
00114 static VALUE
00115 unix_path(VALUE sock)
00116 {
00117     rb_io_t *fptr;
00118 
00119     GetOpenFile(sock, fptr);
00120     if (NIL_P(fptr->pathv)) {
00121         struct sockaddr_un addr;
00122         socklen_t len = (socklen_t)sizeof(addr);
00123         socklen_t len0 = len;
00124         if (getsockname(fptr->fd, (struct sockaddr*)&addr, &len) < 0)
00125             rb_sys_fail(0);
00126         if (len0 < len) len = len0;
00127         fptr->pathv = rb_obj_freeze(rsock_unixpath_str(&addr, len));
00128     }
00129     return rb_str_dup(fptr->pathv);
00130 }
00131 
00132 /*
00133  * call-seq:
00134  *   unixsocket.recvfrom(maxlen [, flags]) => [mesg, unixaddress]
00135  *
00136  * Receives a message via _unixsocket_.
00137  *
00138  * _maxlen_ is the maximum number of bytes to receive.
00139  *
00140  * _flags_ should be a bitwise OR of Socket::MSG_* constants.
00141  *
00142  *   s1 = Socket.new(:UNIX, :DGRAM, 0)
00143  *   s1_ai = Addrinfo.unix("/tmp/sock1")
00144  *   s1.bind(s1_ai)
00145  *
00146  *   s2 = Socket.new(:UNIX, :DGRAM, 0)
00147  *   s2_ai = Addrinfo.unix("/tmp/sock2")
00148  *   s2.bind(s2_ai)
00149  *   s3 = UNIXSocket.for_fd(s2.fileno)
00150  *
00151  *   s1.send "a", 0, s2_ai
00152  *   p s3.recvfrom(10) #=> ["a", ["AF_UNIX", "/tmp/sock1"]]
00153  *
00154  */
00155 static VALUE
00156 unix_recvfrom(int argc, VALUE *argv, VALUE sock)
00157 {
00158     return rsock_s_recvfrom(sock, argc, argv, RECV_UNIX);
00159 }
00160 
00161 #if defined(HAVE_ST_MSG_CONTROL) && defined(SCM_RIGHTS)
00162 #define FD_PASSING_BY_MSG_CONTROL 1
00163 #else
00164 #define FD_PASSING_BY_MSG_CONTROL 0
00165 #endif
00166 
00167 #if defined(HAVE_ST_MSG_ACCRIGHTS)
00168 #define FD_PASSING_BY_MSG_ACCRIGHTS 1
00169 #else
00170 #define FD_PASSING_BY_MSG_ACCRIGHTS 0
00171 #endif
00172 
00173 struct iomsg_arg {
00174     int fd;
00175     struct msghdr msg;
00176 };
00177 
00178 #if defined(HAVE_SENDMSG) && (FD_PASSING_BY_MSG_CONTROL || FD_PASSING_BY_MSG_ACCRIGHTS)
00179 static VALUE
00180 sendmsg_blocking(void *data)
00181 {
00182     struct iomsg_arg *arg = data;
00183     return sendmsg(arg->fd, &arg->msg, 0);
00184 }
00185 
00186 /*
00187  * call-seq:
00188  *   unixsocket.send_io(io) => nil
00189  *
00190  * Sends _io_ as file descriptor passing.
00191  *
00192  *   s1, s2 = UNIXSocket.pair
00193  *
00194  *   s1.send_io STDOUT
00195  *   stdout = s2.recv_io
00196  *
00197  *   p STDOUT.fileno #=> 1
00198  *   p stdout.fileno #=> 6
00199  *
00200  *   stdout.puts "hello" # outputs "hello\n" to standard output.
00201  */
00202 static VALUE
00203 unix_send_io(VALUE sock, VALUE val)
00204 {
00205     int fd;
00206     rb_io_t *fptr;
00207     struct iomsg_arg arg;
00208     struct iovec vec[1];
00209     char buf[1];
00210 
00211 #if FD_PASSING_BY_MSG_CONTROL
00212     struct {
00213         struct cmsghdr hdr;
00214         char pad[8+sizeof(int)+8];
00215     } cmsg;
00216 #endif
00217 
00218     if (rb_obj_is_kind_of(val, rb_cIO)) {
00219         rb_io_t *valfptr;
00220         GetOpenFile(val, valfptr);
00221         fd = valfptr->fd;
00222     }
00223     else if (FIXNUM_P(val)) {
00224         fd = FIX2INT(val);
00225     }
00226     else {
00227         rb_raise(rb_eTypeError, "neither IO nor file descriptor");
00228     }
00229 
00230     GetOpenFile(sock, fptr);
00231 
00232     arg.msg.msg_name = NULL;
00233     arg.msg.msg_namelen = 0;
00234 
00235     /* Linux and Solaris doesn't work if msg_iov is NULL. */
00236     buf[0] = '\0';
00237     vec[0].iov_base = buf;
00238     vec[0].iov_len = 1;
00239     arg.msg.msg_iov = vec;
00240     arg.msg.msg_iovlen = 1;
00241 
00242 #if FD_PASSING_BY_MSG_CONTROL
00243     arg.msg.msg_control = (caddr_t)&cmsg;
00244     arg.msg.msg_controllen = (socklen_t)CMSG_LEN(sizeof(int));
00245     arg.msg.msg_flags = 0;
00246     MEMZERO((char*)&cmsg, char, sizeof(cmsg));
00247     cmsg.hdr.cmsg_len = (socklen_t)CMSG_LEN(sizeof(int));
00248     cmsg.hdr.cmsg_level = SOL_SOCKET;
00249     cmsg.hdr.cmsg_type = SCM_RIGHTS;
00250     memcpy(CMSG_DATA(&cmsg.hdr), &fd, sizeof(int));
00251 #else
00252     arg.msg.msg_accrights = (caddr_t)&fd;
00253     arg.msg.msg_accrightslen = sizeof(fd);
00254 #endif
00255 
00256     arg.fd = fptr->fd;
00257     while ((int)BLOCKING_REGION_FD(sendmsg_blocking, &arg) == -1) {
00258         if (!rb_io_wait_writable(arg.fd))
00259             rb_sys_fail("sendmsg(2)");
00260     }
00261 
00262     return Qnil;
00263 }
00264 #else
00265 #define unix_send_io rb_f_notimplement
00266 #endif
00267 
00268 #if defined(HAVE_RECVMSG) && (FD_PASSING_BY_MSG_CONTROL || FD_PASSING_BY_MSG_ACCRIGHTS)
00269 static VALUE
00270 recvmsg_blocking(void *data)
00271 {
00272     struct iomsg_arg *arg = data;
00273     return recvmsg(arg->fd, &arg->msg, 0);
00274 }
00275 
00276 /*
00277  * call-seq:
00278  *   unixsocket.recv_io([klass [, mode]]) => io
00279  *
00280  *   UNIXServer.open("/tmp/sock") {|serv|
00281  *     UNIXSocket.open("/tmp/sock") {|c|
00282  *       s = serv.accept
00283  *
00284  *       c.send_io STDOUT
00285  *       stdout = s.recv_io
00286  *
00287  *       p STDOUT.fileno #=> 1
00288  *       p stdout.fileno #=> 7
00289  *
00290  *       stdout.puts "hello" # outputs "hello\n" to standard output.
00291  *     }
00292  *   }
00293  *
00294  */
00295 static VALUE
00296 unix_recv_io(int argc, VALUE *argv, VALUE sock)
00297 {
00298     VALUE klass, mode;
00299     rb_io_t *fptr;
00300     struct iomsg_arg arg;
00301     struct iovec vec[2];
00302     char buf[1];
00303 
00304     int fd;
00305 #if FD_PASSING_BY_MSG_CONTROL
00306     struct {
00307         struct cmsghdr hdr;
00308         char pad[8+sizeof(int)+8];
00309     } cmsg;
00310 #endif
00311 
00312     rb_scan_args(argc, argv, "02", &klass, &mode);
00313     if (argc == 0)
00314         klass = rb_cIO;
00315     if (argc <= 1)
00316         mode = Qnil;
00317 
00318     GetOpenFile(sock, fptr);
00319 
00320     arg.msg.msg_name = NULL;
00321     arg.msg.msg_namelen = 0;
00322 
00323     vec[0].iov_base = buf;
00324     vec[0].iov_len = sizeof(buf);
00325     arg.msg.msg_iov = vec;
00326     arg.msg.msg_iovlen = 1;
00327 
00328 #if FD_PASSING_BY_MSG_CONTROL
00329     arg.msg.msg_control = (caddr_t)&cmsg;
00330     arg.msg.msg_controllen = (socklen_t)CMSG_SPACE(sizeof(int));
00331     arg.msg.msg_flags = 0;
00332     cmsg.hdr.cmsg_len = (socklen_t)CMSG_LEN(sizeof(int));
00333     cmsg.hdr.cmsg_level = SOL_SOCKET;
00334     cmsg.hdr.cmsg_type = SCM_RIGHTS;
00335     fd = -1;
00336     memcpy(CMSG_DATA(&cmsg.hdr), &fd, sizeof(int));
00337 #else
00338     arg.msg.msg_accrights = (caddr_t)&fd;
00339     arg.msg.msg_accrightslen = sizeof(fd);
00340     fd = -1;
00341 #endif
00342 
00343     arg.fd = fptr->fd;
00344     while ((int)BLOCKING_REGION_FD(recvmsg_blocking, &arg) == -1) {
00345         if (!rb_io_wait_readable(arg.fd))
00346             rb_sys_fail("recvmsg(2)");
00347     }
00348 
00349 #if FD_PASSING_BY_MSG_CONTROL
00350     if (arg.msg.msg_controllen < (socklen_t)sizeof(struct cmsghdr)) {
00351         rb_raise(rb_eSocket,
00352                  "file descriptor was not passed (msg_controllen=%d smaller than sizeof(struct cmsghdr)=%d)",
00353                  (int)arg.msg.msg_controllen, (int)sizeof(struct cmsghdr));
00354     }
00355     if (cmsg.hdr.cmsg_level != SOL_SOCKET) {
00356         rb_raise(rb_eSocket,
00357                  "file descriptor was not passed (cmsg_level=%d, %d expected)",
00358                  cmsg.hdr.cmsg_level, SOL_SOCKET);
00359     }
00360     if (cmsg.hdr.cmsg_type != SCM_RIGHTS) {
00361         rb_raise(rb_eSocket,
00362                  "file descriptor was not passed (cmsg_type=%d, %d expected)",
00363                  cmsg.hdr.cmsg_type, SCM_RIGHTS);
00364     }
00365     if (arg.msg.msg_controllen < (socklen_t)CMSG_LEN(sizeof(int))) {
00366         rb_raise(rb_eSocket,
00367                  "file descriptor was not passed (msg_controllen=%d smaller than CMSG_LEN(sizeof(int))=%d)",
00368                  (int)arg.msg.msg_controllen, (int)CMSG_LEN(sizeof(int)));
00369     }
00370     if ((socklen_t)CMSG_SPACE(sizeof(int)) < arg.msg.msg_controllen) {
00371         rb_raise(rb_eSocket,
00372                  "file descriptor was not passed (msg_controllen=%d bigger than CMSG_SPACE(sizeof(int))=%d)",
00373                  (int)arg.msg.msg_controllen, (int)CMSG_SPACE(sizeof(int)));
00374     }
00375     if (cmsg.hdr.cmsg_len != CMSG_LEN(sizeof(int))) {
00376         rsock_discard_cmsg_resource(&arg.msg, 0);
00377         rb_raise(rb_eSocket,
00378                  "file descriptor was not passed (cmsg_len=%d, %d expected)",
00379                  (int)cmsg.hdr.cmsg_len, (int)CMSG_LEN(sizeof(int)));
00380     }
00381 #else
00382     if (arg.msg.msg_accrightslen != sizeof(fd)) {
00383         rb_raise(rb_eSocket,
00384                  "file descriptor was not passed (accrightslen) : %d != %d",
00385                  arg.msg.msg_accrightslen, (int)sizeof(fd));
00386     }
00387 #endif
00388 
00389 #if FD_PASSING_BY_MSG_CONTROL
00390     memcpy(&fd, CMSG_DATA(&cmsg.hdr), sizeof(int));
00391 #endif
00392     rb_update_max_fd(fd);
00393 
00394     if (klass == Qnil)
00395         return INT2FIX(fd);
00396     else {
00397         ID for_fd;
00398         int ff_argc;
00399         VALUE ff_argv[2];
00400         CONST_ID(for_fd, "for_fd");
00401         ff_argc = mode == Qnil ? 1 : 2;
00402         ff_argv[0] = INT2FIX(fd);
00403         ff_argv[1] = mode;
00404         return rb_funcall2(klass, for_fd, ff_argc, ff_argv);
00405     }
00406 }
00407 #else
00408 #define unix_recv_io rb_f_notimplement
00409 #endif
00410 
00411 /*
00412  * call-seq:
00413  *   unixsocket.addr => [address_family, unix_path]
00414  *
00415  * Returns the local address as an array which contains
00416  * address_family and unix_path.
00417  *
00418  * Example
00419  *   serv = UNIXServer.new("/tmp/sock")
00420  *   p serv.addr #=> ["AF_UNIX", "/tmp/sock"]
00421  */
00422 static VALUE
00423 unix_addr(VALUE sock)
00424 {
00425     rb_io_t *fptr;
00426     struct sockaddr_un addr;
00427     socklen_t len = (socklen_t)sizeof addr;
00428 
00429     GetOpenFile(sock, fptr);
00430 
00431     if (getsockname(fptr->fd, (struct sockaddr*)&addr, &len) < 0)
00432         rb_sys_fail("getsockname(2)");
00433     return rsock_unixaddr(&addr, len);
00434 }
00435 
00436 /*
00437  * call-seq:
00438  *   unixsocket.peeraddr => [address_family, unix_path]
00439  *
00440  * Returns the remote address as an array which contains
00441  * address_family and unix_path.
00442  *
00443  * Example
00444  *   serv = UNIXServer.new("/tmp/sock")
00445  *   c = UNIXSocket.new("/tmp/sock")
00446  *   p c.peeraddr #=> ["AF_UNIX", "/tmp/sock"]
00447  */
00448 static VALUE
00449 unix_peeraddr(VALUE sock)
00450 {
00451     rb_io_t *fptr;
00452     struct sockaddr_un addr;
00453     socklen_t len = (socklen_t)sizeof addr;
00454     socklen_t len0 = len;
00455 
00456     GetOpenFile(sock, fptr);
00457 
00458     if (getpeername(fptr->fd, (struct sockaddr*)&addr, &len) < 0)
00459         rb_sys_fail("getpeername(2)");
00460     if (len0 < len) len = len0;
00461     return rsock_unixaddr(&addr, len);
00462 }
00463 
00464 /*
00465  * call-seq:
00466  *   UNIXSocket.pair([type [, protocol]])       => [unixsocket1, unixsocket2]
00467  *   UNIXSocket.socketpair([type [, protocol]]) => [unixsocket1, unixsocket2]
00468  *
00469  * Creates a pair of sockets connected each other.
00470  *
00471  * _socktype_ should be a socket type such as: :STREAM, :DGRAM, :RAW, etc.
00472  *
00473  * _protocol_ should be a protocol defined in the domain.
00474  * 0 is default protocol for the domain.
00475  *
00476  *   s1, s2 = UNIXSocket.pair
00477  *   s1.send "a", 0
00478  *   s1.send "b", 0
00479  *   p s2.recv(10) #=> "ab"
00480  *
00481  */
00482 static VALUE
00483 unix_s_socketpair(int argc, VALUE *argv, VALUE klass)
00484 {
00485     VALUE domain, type, protocol;
00486     VALUE args[3];
00487 
00488     domain = INT2FIX(PF_UNIX);
00489     rb_scan_args(argc, argv, "02", &type, &protocol);
00490     if (argc == 0)
00491         type = INT2FIX(SOCK_STREAM);
00492     if (argc <= 1)
00493         protocol = INT2FIX(0);
00494 
00495     args[0] = domain;
00496     args[1] = type;
00497     args[2] = protocol;
00498 
00499     return rsock_sock_s_socketpair(3, args, klass);
00500 }
00501 #endif
00502 
00503 void
00504 rsock_init_unixsocket(void)
00505 {
00506 #ifdef HAVE_SYS_UN_H
00507     /*
00508      * Document-class: UNIXSocket < BasicSocket
00509      *
00510      * UNIXSocket represents a UNIX domain stream client socket.
00511      */
00512     rb_cUNIXSocket = rb_define_class("UNIXSocket", rb_cBasicSocket);
00513     rb_define_method(rb_cUNIXSocket, "initialize", unix_init, 1);
00514     rb_define_method(rb_cUNIXSocket, "path", unix_path, 0);
00515     rb_define_method(rb_cUNIXSocket, "addr", unix_addr, 0);
00516     rb_define_method(rb_cUNIXSocket, "peeraddr", unix_peeraddr, 0);
00517     rb_define_method(rb_cUNIXSocket, "recvfrom", unix_recvfrom, -1);
00518     rb_define_method(rb_cUNIXSocket, "send_io", unix_send_io, 1);
00519     rb_define_method(rb_cUNIXSocket, "recv_io", unix_recv_io, -1);
00520     rb_define_singleton_method(rb_cUNIXSocket, "socketpair", unix_s_socketpair, -1);
00521     rb_define_singleton_method(rb_cUNIXSocket, "pair", unix_s_socketpair, -1);
00522 #endif
00523 }
00524