tools/purge/socket.cc

   1 #include "squid.h"
   2 // Author:  Jens-S. V?ckler <voeckler@rvs.uni-hannover.de>
   3 //
   4 // File:    socket.hh
   5 //          Sun May  3 1998
   6 //
   7 // (c) 1998 Lehrgebiet Rechnernetze und Verteilte Systeme
   8 //          Universit?t Hannover, Germany
   9 //
  10 // Books:   W. Richard Steven, "Advanced Programming in the UNIX Environment",
  11 //          Addison-Wesley, 1992.
  12 //
  13 // Permission to use, copy, modify, distribute, and sell this software
  14 // and its documentation for any purpose is hereby granted without fee,
  15 // provided that (i) the above copyright notices and this permission
  16 // notice appear in all copies of the software and related documentation,
  17 // and (ii) the names of the Lehrgebiet Rechnernetze und Verteilte
  18 // Systeme and the University of Hannover may not be used in any
  19 // advertising or publicity relating to the software without the
  20 // specific, prior written permission of Lehrgebiet Rechnernetze und
  21 // Verteilte Systeme and the University of Hannover.
  22 //
  23 // THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  24 // EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  25 // WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  26 //
  27 // IN NO EVENT SHALL THE LEHRGEBIET RECHNERNETZE UND VERTEILTE SYSTEME OR
  28 // THE UNIVERSITY OF HANNOVER BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  29 // INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  30 // WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT
  31 // ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY,
  32 // ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  33 // SOFTWARE.
  34 //
  35 // Revision 1.3  1999/01/19 11:00:50  voeckler
  36 // Linux glibc2 fixes for socket size parameters.
  37 //
  38 // Revision 1.2  1998/08/27 15:23:39  voeckler
  39 // added TCP_NODELAY options at several places.
  40 //
  41 // Revision 1.1  1998/08/13 21:52:55  voeckler
  42 // Initial revision
  43 //
  44 //
  45 #include "socket.hh"
  46
  47 #include <cerrno>
  48 #include <cstring>
  49 #include <netinet/tcp.h>
  50 #include <arpa/inet.h>
  51 #include <netdb.h>
  52
  53 #include <unistd.h>
  54
  55 #include "convert.hh"
  56
  57 int
  58 setSocketBuffers( int sockfd, int size )
  59 // purpose: set socket buffers for both directions to the specified size
  60 // paramtr: sockfd (IN): socket file descriptor
  61 //          size (IN): new socket buffer size
  62 // returns: -1 on setsockopt() errors, 0 otherwise
  63 // warning: prints error message on stderr, errno will be changed
  64 {
  65     if ( setsockopt( sockfd, SOL_SOCKET, SO_RCVBUF,
  66                      (char*) &size, sizeof(size) ) == -1 ) {
  67         perror( "setsockopt( SO_RCVBUF )" );
  68         return -1;
  69     }
  70
  71     if ( setsockopt( sockfd, SOL_SOCKET, SO_SNDBUF,
  72                      (char*) &size, sizeof(size) ) == -1 ) {
  73         perror( "setsockopt( SO_SNDBUF )" );
  74         return -1;
  75     }
  76
  77     return 0;
  78 }
  79
  80 int
  81 getSocketNoDelay( int sockfd )
  82 // purpose: get state of the TCP_NODELAY of the socket
  83 // paramtr: sockfd (IN): socket descriptor
  84 // returns: 1, if TCP_NODELAY is set,
  85 //          0, if TCP_NODELAY is not set,
  86 //         -1, if an error occurred (e.g. datagram socket)
  87 {
  88     int delay = 0;
  89     socklen_t len = sizeof(delay);
  90     if ( getsockopt( sockfd, IPPROTO_TCP, TCP_NODELAY,
  91                      (char*) &delay, &len ) == -1 ) {
  92         perror( "# getsockopt( TCP_NODELAY ) failed" );
  93         return -1;
  94     } else
  95         return ( delay ? 1 : 0 );
  96 }
  97
  98 int
  99 setSocketNoDelay( int sockfd, bool nodelay )
 100 // purpose: get state of the TCP_NODELAY of the socket
 101 // paramtr: sockfd (IN): socket descriptor
 102 //          nodelay (IN): true, if TCP_NODELAY is to be set, false otherwise.
 103 // returns: 0, if everything worked out o.k.
 104 //         -1, if an error occurred (e.g. datagram socket)
 105 {
 106     const int delay = 1;
 107     if ( setsockopt( sockfd, IPPROTO_TCP, TCP_NODELAY,
 108                      (const char*) &delay, sizeof(delay) ) == -1 ) {
 109         perror( "setsockopt( TCP_NODELAY ) failed" );
 110         return -1;
 111     } else
 112         return 0;
 113 }
 114
 115 int
 116 commonCode( int& sockfd, bool nodelay, int sendBufferSize, int recvBufferSize )
 117 // purpose: common code in server sockets and client sockets
 118 // paramtr: sockfd (IO): socket filedescriptor
 119 //          nodelay (IN): true=set TCP_NODELAY option.
 120 //          sendBufferSize (IN): don't set (use sys defaults) if < 0
 121 //          recvBufferSize (IN): don't set (use sys defaults) if < 0
 122 // returns: 0 == if everthing went ok, -1 otherwise
 123 // warning: sockfd will be closed, if -1 is returned!
 124 {
 125     // set TCP_NODELAY option, if that is wanted.
 126     // The socket API default is unset.
 127     if ( nodelay ) {
 128         const int delay = 1;
 129         if ( setsockopt( sockfd, IPPROTO_TCP, TCP_NODELAY,
 130                          (const char*) &delay, sizeof(delay) ) == -1 ) {
 131             perror( "setsockopt( TCP_NODELAY ) failed" );
 132             close(sockfd);
 133             return -1;
 134         }
 135     }
 136
 137     // set the socket send buffer size explicitly, or use the system default
 138     if ( sendBufferSize >= 0 ) {
 139         if ( setsockopt( sockfd, SOL_SOCKET, SO_SNDBUF, (char*) &sendBufferSize,
 140                          sizeof(sendBufferSize) ) == -1 ) {
 141             perror( "setsockopt( SO_SNDBUF )" );
 142             close(sockfd);
 143             return -1;
 144         }
 145     }
 146
 147     // set the socket recv buffer size explicitly, or use the system default
 148     if ( recvBufferSize >= 0 ) {
 149         if ( setsockopt( sockfd, SOL_SOCKET, SO_RCVBUF, (char*) &recvBufferSize,
 150                          sizeof(recvBufferSize) ) == -1 ) {
 151             perror( "setsockopt( SO_RCVBUF )" );
 152             close(sockfd);
 153             return -1;
 154         }
 155     }
 156     return 0;
 157 }
 158
 159 int
 160 connectTo( struct in_addr host, unsigned short port, bool nodelay,
 161            int sendBufferSize, int recvBufferSize )
 162 // purpose: connect to a server as a client
 163 // paramtr: host (IN): address describing the server
 164 //          port (IN): port to connect at the server
 165 //          nodelay (IN): true=set TCP_NODELAY option.
 166 //          sendBufferSize (IN): don't set (use sys defaults) if < 0
 167 //          recvBufferSize (IN): don't set (use sys defaults) if < 0
 168 // returns: >=0 is the descriptor of the opened, connected socket,
 169 //          -1  is an indication of an error (errno may have been reset).
 170 {
 171     int sockfd = socket( PF_INET, SOCK_STREAM, IPPROTO_TCP );
 172     if ( sockfd == -1 ) {
 173         perror( "socket() failed" );
 174         return -1;
 175     }
 176
 177     if ( commonCode( sockfd, nodelay, sendBufferSize, recvBufferSize ) == -1 )
 178         return -1;
 179
 180     struct sockaddr_in server;
 181     memset( &server, 0, sizeof(server) );
 182     server.sin_family = AF_INET;
 183     server.sin_addr   = host;
 184     server.sin_port   = port;
 185     if ( connect( sockfd, (struct sockaddr*) &server, sizeof(server) ) == -1 ) {
 186         perror( "connect() failure" );
 187         close(sockfd);
 188         return -1;
 189     }
 190
 191     return sockfd;
 192 }
 193
 194 int
 195 serverSocket( struct in_addr host, unsigned short port,
 196               int backlog, bool reuse, bool nodelay,
 197               int sendBufferSize, int recvBufferSize )
 198 // purpose: open a server socket for listening
 199 // paramtr: host (IN): host to bind locally to, use INADDRY_ANY for *
 200 //          port (IN): port to bind to, use 0 for system assigned
 201 //          backlog (IN): listen backlog queue length
 202 //          reuse (IN): set SO_REUSEADDR option - default usefully
 203 //          nodelay (IN): true=set TCP_NODELAY option.
 204 //            SETTING TCP_NODELAY ON A SERVER SOCKET DOES NOT MAKE SENSE!
 205 //          sendBufferSize (IN): don't set (use sys defaults) if < 0
 206 //          recvBufferSize (IN): don't set (use sys defaults) if < 0
 207 // returns: opened listening fd, or -1 on error.
 208 // warning: error message will be printed on stderr and errno reset.
 209 {
 210     int sockfd = socket( AF_INET, SOCK_STREAM, 0 );
 211     if ( sockfd == -1 ) {
 212         perror( "socket" );
 213         return -1;
 214     }
 215
 216     if ( reuse ) {
 217         int opt = 1;
 218         if ( setsockopt( sockfd, SOL_SOCKET, SO_REUSEADDR,
 219                          (char*) &opt, sizeof(int) ) == -1) {
 220             perror( "setsockopt( SO_REUSEADDR )" );
 221             close( sockfd );
 222             return -1;
 223         }
 224     }
 225
 226     if ( commonCode( sockfd, nodelay, sendBufferSize, recvBufferSize ) == -1 )
 227         return -1;
 228
 229     struct sockaddr_in server;
 230     memset( &server, 0, sizeof(server) );
 231     server.sin_family = AF_INET;
 232     server.sin_port   = port;
 233     server.sin_addr   = host;
 234     if ( bind( sockfd, (SA*) &server, sizeof(server) ) == -1 ) {
 235         SockAddress socket;
 236         fprintf( stderr, "bind(%s): %s\n",
 237                  my_sock_ntoa(server,socket), strerror(errno) );
 238         close(sockfd);
 239         return -1;
 240     }
 241
 242     if ( listen( sockfd, backlog ) == -1 ) {
 243         perror( "listen" );
 244         close(sockfd);
 245         return -1;
 246     }
 247
 248     return sockfd;
 249 }