src/support/socktools.C

   1 /**
   2  * \file socktools.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author João Luis M. Assirati
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "support/socktools.h"
  14 #include "support/filename.h"
  15
  16 #if !defined (HAVE_FCNTL)
  17 // We provide stubs because we don't (yet?) support the native OS API.
  18
  19 namespace lyx {
  20 namespace support {
  21 namespace socktools {
  22
  23 int listen(std::string const &, int)
  24 {
  25         return -1;
  26 }
  27
  28
  29 int accept(int)
  30 {
  31         return -1;
  32 }
  33
  34 } // namespace socktools
  35 } // namespace support
  36 } // namespace lyx
  37
  38 #else // defined (HAVE_FCNTL)
  39
  40 #include "support/lyxlib.h"
  41
  42 #include "debug.h"
  43
  44 #include <sys/socket.h>
  45 #include <sys/un.h>
  46 #include <fcntl.h>
  47 #ifdef HAVE_UNISTD_H
  48 # include <unistd.h>
  49 #endif
  50
  51 #include <cerrno>
  52
  53 using std::endl;
  54 using std::string;
  55
  56 #ifndef CXX_GLOBAL_CSTD
  57 using std::strerror;
  58 #endif
  59
  60 // This MACRO eppears to be defined only on Linux.
  61 #if !defined(SUN_LEN)
  62 #define SUN_LEN(su) \
  63         (sizeof (*(su)) - sizeof ((su)->sun_path) + strlen((su)->sun_path))
  64 #endif
  65
  66
  67 namespace lyx {
  68 namespace support {
  69 namespace socktools {
  70
  71 // Returns a local socket already in the "listen" state (or -1 in case
  72 // of error). The first argument is the socket address, the second
  73 // is the length of the queue for connections. If successful, a socket
  74 // special file 'name' will be created in the filesystem.
  75 int listen(string const & name, int queue)
  76 {
  77         int fd; // File descriptor for the socket
  78         sockaddr_un addr; // Structure that hold the socket address
  79
  80         // We use 'name' to fill 'addr'
  81         string::size_type len = name.size();
  82         // the field sun_path in sockaddr_un is a char[108]
  83         if (len > 107) {
  84                 lyxerr << "lyx: Socket address '" << name << "' too long."
  85                        << endl;
  86                 return -1;
  87         }
  88         // Synonims for AF_UNIX are AF_LOCAL and AF_FILE
  89         addr.sun_family = AF_UNIX;
  90         name.copy(addr.sun_path, 107);
  91         addr.sun_path[len] = '\0';
  92
  93         // This creates a file descriptor for the socket
  94         // Synonims for PF_UNIX are PF_LOCAL and PF_FILE
  95         // For local sockets, the protocol is always 0
  96         // socket() returns -1 in case of error
  97         if ((fd = ::socket(PF_UNIX, SOCK_STREAM, 0))== -1) {
  98                 lyxerr << "lyx: Could not create socket descriptor: "
  99                        << strerror(errno) << endl;
 100                 return -1;
 101         }
 102
 103         // Set NONBLOCK mode for the file descriptor
 104         if (::fcntl(fd, F_SETFL, O_NONBLOCK) == -1) {
 105                 lyxerr << "lyx: Could not set NONBLOCK mode for socket descriptor: "
 106                      << strerror(errno) << endl;
 107                 ::close(fd);
 108                 return -1;
 109         }
 110
 111         // bind() gives the local address 'name' for 'fd', also creating
 112         // the socket special file in the filesystem. bind() returns -1
 113         // in case of error
 114         if ((::bind (fd, reinterpret_cast<sockaddr *>(&addr), SUN_LEN(&addr))) == -1) {
 115                 lyxerr << "lyx: Could not bind address '" << name
 116                        << "' to socket descriptor: " << strerror(errno) << endl;
 117                 ::close(fd);
 118                 unlink(FileName(name));
 119                 return -1;
 120         }
 121
 122         // Puts the socket in listen state, that is, ready to accept
 123         // connections. The second parameter of listen() defines the
 124         // maximum length the queue of pending connections may grow to.
 125         // It is not a restriction on the number of connections the socket
 126         // can accept. Returns -1 in case of error
 127         if (::listen (fd, queue) == -1) {
 128                 lyxerr << "lyx: Could not put socket in 'listen' state: "
 129                        << strerror(errno) << endl;
 130                 ::close(fd);
 131                 unlink(FileName(name));
 132                 return -1;
 133         }
 134
 135         return fd;
 136 }
 137
 138 // Returns a file descriptor for a new connection from the socket
 139 // descriptor 'sd' (or -1 in case of error)
 140 int accept(int sd)
 141 {
 142         int fd;
 143
 144         // Returns the new file descriptor or -1 in case of error
 145         // Using null pointers for the second and third arguments
 146         // dismiss all information about the connecting client
 147         if ((fd = accept(sd, reinterpret_cast<sockaddr *>(0), reinterpret_cast<socklen_t *>(0))) == -1) {
 148                 lyxerr << "lyx: Could not accept connection: "
 149                        << strerror(errno) << endl;
 150                 return -1;
 151         }
 152
 153         // Sets NONBLOCK mode for the file descriptor
 154         if (::fcntl(fd, F_SETFL, O_NONBLOCK) == -1) {
 155                 lyxerr << "lyx: Could not set NONBLOCK mode for connection: "
 156                        << strerror(errno) << endl;
 157                 ::close(fd);
 158                 return -1;
 159         }
 160         return fd;
 161 }
 162
 163 } // namespace socktools
 164 } // namespace support
 165 } // namespace lyx
 166
 167 #endif // defined (HAVE_FCNTL)