ircd/listener.c

   1 /************************************************************************
   2  *   IRC - Internet Relay Chat, src/listener.c
   3  *   Copyright (C) 1999 Thomas Helvey <tomh@inxpress.net>
   4  *
   5  *   This program is free software; you can redistribute it and/or modify
   6  *   it under the terms of the GNU General Public License as published by
   7  *   the Free Software Foundation; either version 1, or (at your option)
   8  *   any later version.
   9  *
  10  *   This program is distributed in the hope that it will be useful,
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *   GNU General Public License for more details.
  14  *
  15  *   You should have received a copy of the GNU General Public License
  16  *   along with this program; if not, write to the Free Software
  17  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18  *
  19  *  $Id$
  20  */
  21 #include "config.h"
  22
  23 #include "listener.h"
  24 #include "client.h"
  25 #include "ircd.h"
  26 #include "ircd_alloc.h"
  27 #include "ircd_events.h"
  28 #include "ircd_features.h"
  29 #include "ircd_osdep.h"
  30 #include "ircd_reply.h"
  31 #include "ircd_snprintf.h"
  32 #include "ircd_string.h"
  33 #include "numeric.h"
  34 #include "s_bsd.h"
  35 #include "s_conf.h"
  36 #include "s_misc.h"
  37 #include "send.h"
  38 #include "sys.h"         /* MAXCLIENTS */
  39
  40 #include <assert.h>
  41 #include <stdio.h>
  42 #include <string.h>
  43 #include <errno.h>
  44 #include <stdlib.h>
  45 #include <unistd.h>
  46 #include <netdb.h>
  47 #include <sys/socket.h>
  48 #include <arpa/inet.h>
  49
  50 #ifndef INADDR_NONE
  51 #define INADDR_NONE ((unsigned int) 0xffffffff)
  52 #endif
  53
  54 struct Listener* ListenerPollList = 0;
  55
  56 static void accept_connection(struct Event* ev);
  57
  58 static struct Listener* make_listener(int port, struct in_addr addr)
  59 {
  60   struct Listener* listener =
  61     (struct Listener*) MyMalloc(sizeof(struct Listener));
  62   assert(0 != listener);
  63
  64   memset(listener, 0, sizeof(struct Listener));
  65
  66   listener->fd          = -1;
  67   listener->port        = port;
  68   listener->addr.s_addr = addr.s_addr;
  69
  70 #ifdef NULL_POINTER_NOT_ZERO
  71   listener->next = NULL;
  72   listener->conf = NULL;
  73 #endif
  74   return listener;
  75 }
  76
  77 static void free_listener(struct Listener* listener)
  78 {
  79   assert(0 != listener);
  80   MyFree(listener);
  81 }
  82
  83 #define PORTNAMELEN 10  /* ":31337" */
  84
  85 /*
  86  * get_listener_name - return displayable listener name and port
  87  * returns "host.foo.org:6667" for a given listener
  88  */
  89 const char* get_listener_name(const struct Listener* listener)
  90 {
  91   static char buf[HOSTLEN + PORTNAMELEN + 4];
  92   assert(0 != listener);
  93   ircd_snprintf(0, buf, sizeof(buf), "%s:%u", cli_name(&me), listener->port);
  94   return buf;
  95 }
  96
  97 /*
  98  * count_listener_memory - count memory and listeners
  99  */
 100 void count_listener_memory(int* count_out, size_t* size_out)
 101 {
 102   struct Listener* l;
 103   int              count = 0;
 104   assert(0 != count_out);
 105   assert(0 != size_out);
 106   for (l = ListenerPollList; l; l = l->next)
 107     ++count;
 108   *count_out = count;
 109   *size_out  = count * sizeof(struct Listener);
 110 }
 111
 112 /*
 113  * show_ports - send port listing to a client
 114  * inputs       - pointer to client to show ports to
 115  * output       - none
 116  * side effects - show ports
 117  * author       - Dianora
 118  */
 119 void show_ports(struct Client* sptr, int show_hidden, int port, int count)
 120 {
 121   struct Listener* listener = 0;
 122   char             flags[8];
 123   assert(0 != sptr);
 124
 125   for (listener = ListenerPollList; listener; listener = listener->next) {
 126     if (port && port != listener->port)
 127       continue;
 128     flags[0] = (listener->server) ? 'S' : 'C';
 129     if (listener->hidden) {
 130       if (!show_hidden)
 131         continue;
 132       flags[1] = 'H';
 133       flags[2] = '\0';
 134     }
 135     else
 136       flags[1] = '\0';
 137
 138     send_reply(sptr, RPL_STATSPLINE, listener->port, listener->ref_count,
 139                flags, (listener->active) ? "active" : "disabled");
 140     if (--count == 0)
 141       break;
 142   }
 143 }
 144
 145 /*
 146  * inetport - create a listener socket in the AF_INET domain,
 147  * bind it to the port given in 'port' and listen to it
 148  * returns true (1) if successful false (0) on error.
 149  *
 150  * If the operating system has a define for SOMAXCONN, use it, otherwise
 151  * use HYBRID_SOMAXCONN -Dianora
 152  * NOTE: Do this in os_xxxx.c files
 153  */
 154 #ifdef SOMAXCONN
 155 #define HYBRID_SOMAXCONN SOMAXCONN
 156 #else
 157 #define HYBRID_SOMAXCONN 64
 158 #endif
 159
 160 static int inetport(struct Listener* listener)
 161 {
 162   struct sockaddr_in sin;
 163   int                fd;
 164
 165   /*
 166    * At first, open a new socket
 167    */
 168   if (-1 == (fd = socket(AF_INET, SOCK_STREAM, 0))) {
 169     report_error(SOCKET_ERROR_MSG, get_listener_name(listener), errno);
 170     return 0;
 171   }
 172   else if (fd > MAXCLIENTS - 1) {
 173     report_error(CONNLIMIT_ERROR_MSG, get_listener_name(listener), 0);
 174     close(fd);
 175     return 0;
 176   }
 177
 178   if (!os_set_reuseaddr(fd)) {
 179     report_error(REUSEADDR_ERROR_MSG, get_listener_name(listener), errno);
 180     close(fd);
 181     return 0;
 182   }
 183   /*
 184    * Bind a port to listen for new connections if port is non-null,
 185    * else assume it is already open and try get something from it.
 186    */
 187   memset(&sin, 0, sizeof(sin));
 188   sin.sin_family = AF_INET;
 189   sin.sin_addr   = listener->addr;
 190   sin.sin_port   = htons(listener->port);
 191
 192   if (bind(fd, (struct sockaddr*) &sin, sizeof(sin))) {
 193     report_error(BIND_ERROR_MSG, get_listener_name(listener), errno);
 194     close(fd);
 195     return 0;
 196   }
 197   /*
 198    * Set the buffer sizes for the listener. Accepted connections
 199    * inherit the accepting sockets settings for SO_RCVBUF S_SNDBUF
 200    * The window size is set during the SYN ACK so setting it anywhere
 201    * else has no effect whatsoever on the connection.
 202    * NOTE: this must be set before listen is called
 203    */
 204   if (!os_set_sockbufs(fd, (listener->server) ? SERVER_TCP_WINDOW : CLIENT_TCP_WINDOW)) {
 205     report_error(SETBUFS_ERROR_MSG, get_listener_name(listener), errno);
 206     close(fd);
 207     return 0;
 208   }
 209   if (!os_set_listen(fd, HYBRID_SOMAXCONN)) {
 210     report_error(LISTEN_ERROR_MSG, get_listener_name(listener), errno);
 211     close(fd);
 212     return 0;
 213   }
 214   /*
 215    * XXX - this should always work, performance will suck if it doesn't
 216    */
 217   if (!os_set_nonblocking(fd)) {
 218     report_error(NONB_ERROR_MSG, get_listener_name(listener), errno);
 219     close(fd);
 220     return 0;
 221   }
 222   /*
 223    * Set the TOS bits - this is nonfatal if it doesn't stick.
 224    */
 225   if (!os_set_tos(fd,feature_int((listener->server)?FEAT_TOS_SERVER : FEAT_TOS_CLIENT))) {
 226     report_error(TOS_ERROR_MSG, get_listener_name(listener), errno);
 227   }
 228
 229   if (!socket_add(&listener->socket, accept_connection, (void*) listener,
 230                   SS_LISTENING, 0, fd)) {
 231     /* Error should already have been reported to the logs */
 232     close(fd);
 233     return 0;
 234   }
 235
 236   listener->fd = fd;
 237
 238   return 1;
 239 }
 240
 241 /*
 242  * find_listener - find a listener in the list
 243  *
 244  * XXX - this function does N comparisons so if the list is huge
 245  * we may want to do something else for this. (rehash and init use this)
 246  */
 247 static struct Listener* find_listener(int port, struct in_addr addr)
 248 {
 249   struct Listener* listener;
 250   for (listener = ListenerPollList; listener; listener = listener->next) {
 251     if (port == listener->port && addr.s_addr == listener->addr.s_addr)
 252       return listener;
 253   }
 254   return 0;
 255 }
 256
 257 /*
 258  * set_listener_mask - set the connection mask for this listener
 259  */
 260 static void set_listener_mask(struct Listener* listener, const char* mask)
 261 {
 262   int  ad[4];
 263   char ipname[20];
 264
 265   assert(0 != listener);
 266
 267   if (EmptyString(mask) || 0 == strcmp(mask, "*")) {
 268     listener->mask.s_addr = 0;
 269     return;
 270   }
 271   ad[0] = ad[1] = ad[2] = ad[3] = 0;
 272   /*
 273    * do it this way because building ip# from separate values for each
 274    * byte requires endian knowledge or some nasty messing. Also means
 275    * easy conversion of "*" 0.0.0.0 or 134.* to 134.0.0.0 :-)
 276    */
 277   sscanf(mask, "%d.%d.%d.%d", &ad[0], &ad[1], &ad[2], &ad[3]);
 278   ircd_snprintf(0, ipname, sizeof(ipname), "%d.%d.%d.%d", ad[0], ad[1], ad[2],
 279                 ad[3]);
 280   listener->mask.s_addr = inet_addr(ipname);
 281 }
 282
 283 /*
 284  * connection_allowed - spin through mask and addr passed to see if connect
 285  * allowed on a listener, uses mask generated by set_listener_mask
 286  */
 287 static int connection_allowed(const char* addr, const char* mask)
 288 {
 289   int i = 4;
 290   for ( ; i > 0; --i) {
 291     if (*mask && *addr != *mask)
 292       break;
 293     ++addr;
 294     ++mask;
 295   }
 296   return (0 == i);
 297 }
 298
 299
 300 /*
 301  * add_listener- create a new listener
 302  * port - the port number to listen on
 303  * vhost_ip - if non-null must contain a valid IP address string in
 304  * the format "255.255.255.255"
 305  */
 306 void add_listener(int port, const char* vhost_ip, const char* mask,
 307                   int is_server, int is_hidden)
 308 {
 309   struct Listener* listener;
 310   struct in_addr   vaddr;
 311
 312   /*
 313    * if no port in conf line, don't bother
 314    */
 315   if (0 == port)
 316     return;
 317
 318   vaddr.s_addr = INADDR_ANY;
 319
 320   if (!EmptyString(vhost_ip) && strcmp(vhost_ip,"*") != 0) {
 321     vaddr.s_addr = inet_addr(vhost_ip);
 322     if (INADDR_NONE == vaddr.s_addr)
 323       return;
 324   }
 325
 326   if ((listener = find_listener(port, vaddr))) {
 327     /*
 328      * set active flag and change connect mask here, it's the only thing
 329      * that can change on a rehash
 330      */
 331     listener->active = 1;
 332     set_listener_mask(listener, mask);
 333     listener->hidden = is_hidden;
 334     listener->server = is_server;
 335     return;
 336   }
 337
 338   listener = make_listener(port, vaddr);
 339
 340   if (inetport(listener)) {
 341     listener->active = 1;
 342     set_listener_mask(listener, mask);
 343     listener->hidden = is_hidden;
 344     listener->server = is_server;
 345     listener->next   = ListenerPollList;
 346     ListenerPollList = listener;
 347   }
 348   else
 349     free_listener(listener);
 350 }
 351
 352 /*
 353  * mark_listeners_closing - iterate through listeners and mark them as
 354  * inactive
 355  */
 356 void mark_listeners_closing(void)
 357 {
 358   struct Listener* listener;
 359   for (listener = ListenerPollList; listener; listener = listener->next)
 360     listener->active = 0;
 361 }
 362
 363 /*
 364  * close_listener - close a single listener
 365  */
 366 void close_listener(struct Listener* listener)
 367 {
 368   assert(0 != listener);
 369   /*
 370    * remove from listener list
 371    */
 372   if (listener == ListenerPollList)
 373     ListenerPollList = listener->next;
 374   else {
 375     struct Listener* prev = ListenerPollList;
 376     for ( ; prev; prev = prev->next) {
 377       if (listener == prev->next) {
 378         prev->next = listener->next;
 379         break;
 380       }
 381     }
 382   }
 383   if (-1 < listener->fd)
 384     close(listener->fd);
 385   socket_del(&listener->socket);
 386 }
 387
 388 /*
 389  * close_listeners - close and free all listeners that are not being used
 390  */
 391 void close_listeners()
 392 {
 393   struct Listener* listener;
 394   struct Listener* listener_next = 0;
 395   /*
 396    * close all 'extra' listening ports we have
 397    */
 398   for (listener = ListenerPollList; listener; listener = listener_next) {
 399     listener_next = listener->next;
 400     if (0 == listener->active && 0 == listener->ref_count)
 401       close_listener(listener);
 402   }
 403 }
 404
 405 void release_listener(struct Listener* listener)
 406 {
 407   assert(0 != listener);
 408   assert(0 < listener->ref_count);
 409   if (0 == --listener->ref_count && !listener->active)
 410     close_listener(listener);
 411 }
 412
 413 /*
 414  * accept_connection - accept a connection on a listener
 415  */
 416 static void accept_connection(struct Event* ev)
 417 {
 418   struct Listener* listener;
 419   struct sockaddr_in addr = { 0 };
 420   unsigned int       addrlen = sizeof(struct sockaddr_in);
 421   int                fd;
 422
 423   assert(0 != ev_socket(ev));
 424   assert(0 != s_data(ev_socket(ev)));
 425
 426   listener = s_data(ev_socket(ev));
 427
 428   if (ev_type(ev) == ET_DESTROY) /* being destroyed */
 429     free_listener(listener);
 430   else {
 431     assert(ev_type(ev) == ET_ACCEPT);
 432
 433     listener->last_accept = CurrentTime;
 434     /*
 435      * There may be many reasons for error return, but
 436      * in otherwise correctly working environment the
 437      * probable cause is running out of file descriptors
 438      * (EMFILE, ENFILE or others?). The man pages for
 439      * accept don't seem to list these as possible,
 440      * although it's obvious that it may happen here.
 441      * Thus no specific errors are tested at this
 442      * point, just assume that connections cannot
 443      * be accepted until some old is closed first.
 444      */
 445     if (-1 == (fd = accept(listener->fd, (struct sockaddr*) &addr,
 446                            &addrlen))) {
 447       /* Lotsa admins seem to have problems with not giving enough file
 448        * descriptors to their server so we'll add a generic warning mechanism
 449        * here.  If it turns out too many messages are generated for
 450        * meaningless reasons we can filter them back.
 451        */
 452       sendto_opmask_butone(0, SNO_TCPCOMMON,
 453                            "Unable to accept connection: %m");
 454       return;
 455     }
 456     /*
 457      * check for connection limit
 458      */
 459     if (fd > MAXCLIENTS - 1) {
 460       ++ServerStats->is_ref;
 461       send(fd, "ERROR :All connections in use\r\n", 32, 0);
 462       close(fd);
 463       return;
 464     }
 465     /*
 466      * check to see if listener is shutting down
 467      */
 468     if (!listener->active) {
 469       ++ServerStats->is_ref;
 470       send(fd, "ERROR :Use another port\r\n", 25, 0);
 471       close(fd);
 472       return;
 473     }
 474     /*
 475      * check to see if connection is allowed for this address mask
 476      */
 477     if (!connection_allowed((const char*) &addr,
 478                             (const char*) &listener->mask)) {
 479       ++ServerStats->is_ref;
 480       send(fd, "ERROR :Use another port\r\n", 25, 0);
 481       close(fd);
 482       return;
 483     }
 484     ++ServerStats->is_ac;
 485 /*      nextping = CurrentTime; */
 486
 487     add_connection(listener, fd);
 488   }
 489 }