2 * IRC - Internet Relay Chat, ircd/ircd.c
3 * Copyright (C) 1990 Jarkko Oikarinen and
4 * University of Oulu, Computing Center
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 1, or (at your option)
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * @brief Entry point and other initialization functions for the daemon.
31 #include "destruct_event.h"
33 #include "ircd_alloc.h"
34 #include "ircd_events.h"
35 #include "ircd_features.h"
37 #include "ircd_reply.h"
38 #include "ircd_signal.h"
39 #include "ircd_string.h"
40 #include "ircd_crypt.h"
64 /* #include <assert.h> -- Now using assert in ircd_log.h */
73 #ifdef HAVE_SYS_RESOURCE_H
74 #include <sys/resource.h>
76 #include <sys/socket.h>
78 #include <sys/types.h>
83 /*----------------------------------------------------------------------------
85 *--------------------------------------------------------------------------*/
86 extern void init_counters(void);
87 extern void mem_dbg_initialise(void);
89 /*----------------------------------------------------------------------------
91 *--------------------------------------------------------------------------*/
93 BOOT_DEBUG = 1, /**< Enable debug output. */
94 BOOT_TTY = 2, /**< Stay connected to TTY. */
95 BOOT_CHKCONF = 4 /**< Exit after reading configuration file. */
99 /*----------------------------------------------------------------------------
100 * Global data (YUCK!)
101 *--------------------------------------------------------------------------*/
102 struct Client me; /**< That's me */
103 struct Connection me_con; /**< That's me too */
104 struct Client *GlobalClientList = &me; /**< Pointer to beginning of
106 time_t TSoffset = 0; /**< Offset of timestamps to system clock */
107 int GlobalRehashFlag = 0; /**< do a rehash if set */
108 int GlobalRestartFlag = 0; /**< do a restart if set */
109 time_t CurrentTime; /**< Updated every time we leave select() */
111 char *configfile = CPATH; /**< Server configuration file */
112 int debuglevel = -1; /**< Server debug level */
113 char *debugmode = ""; /**< Server debug level */
114 static char *dpath = DPATH; /**< Working directory for daemon */
115 static char *dbg_client; /**< Client specifier for chkconf */
117 static struct Timer connect_timer; /**< timer structure for try_connections() */
118 static struct Timer ping_timer; /**< timer structure for check_pings() */
119 static struct Timer destruct_event_timer; /**< timer structure for exec_expired_destruct_events() */
121 /** Daemon information. */
122 static struct Daemon thisServer = { 0, 0, 0, 0, 0, 0, -1 };
124 /** Non-zero until we want to exit. */
128 /*----------------------------------------------------------------------------
130 *--------------------------------------------------------------------------*/
131 /** Terminate the server with a message.
132 * @param[in] message Message to log and send to operators.
134 void server_die(const char *message)
136 /* log_write will send out message to both log file and as server notice */
137 log_write(LS_SYSTEM, L_CRIT, 0, "Server terminating: %s", message);
138 flush_connections(0);
139 close_connections(1);
143 /*----------------------------------------------------------------------------
145 *--------------------------------------------------------------------------*/
146 /** Immediately terminate the server with a message.
147 * @param[in] message Message to log, but not send to operators.
149 void server_panic(const char *message)
151 /* inhibit sending server notice--we may be panicking due to low memory */
152 log_write(LS_SYSTEM, L_CRIT, LOG_NOSNOTICE, "Server panic: %s", message);
153 flush_connections(0);
155 close_connections(1);
159 /*----------------------------------------------------------------------------
160 * API: server_restart
161 *--------------------------------------------------------------------------*/
162 /** Restart the server with a message.
163 * @param[in] message Message to log and send to operators.
165 void server_restart(const char *message)
167 static int restarting = 0;
169 /* inhibit sending any server notices; we may be in a loop */
170 log_write(LS_SYSTEM, L_WARNING, LOG_NOSNOTICE, "Restarting Server: %s",
172 if (restarting++) /* increment restarting to prevent looping */
175 sendto_opmask_butone(0, SNO_OLDSNO, "Restarting server: %s", message);
176 Debug((DEBUG_NOTICE, "Restarting server..."));
177 flush_connections(0);
181 close_connections(!(thisServer.bootopt & (BOOT_TTY | BOOT_DEBUG | BOOT_CHKCONF)));
185 execv(SPATH, thisServer.argv);
187 /* Have to reopen since it has been closed above */
190 log_write(LS_SYSTEM, L_CRIT, 0, "execv(%s,%s) failed: %m", SPATH,
193 Debug((DEBUG_FATAL, "Couldn't restart server \"%s\": %s",
194 SPATH, (strerror(errno)) ? strerror(errno) : ""));
199 /*----------------------------------------------------------------------------
200 * outofmemory: Handler for out of memory conditions...
201 *--------------------------------------------------------------------------*/
202 /** Handle out-of-memory condition. */
203 static void outofmemory(void) {
204 Debug((DEBUG_FATAL, "Out of memory: restarting server..."));
205 server_restart("Out of Memory");
209 /*----------------------------------------------------------------------------
211 *--------------------------------------------------------------------------*/
212 /** Write process ID to PID file. */
213 static void write_pidfile(void) {
216 if (thisServer.pid_fd >= 0) {
217 memset(buff, 0, sizeof(buff));
218 sprintf(buff, "%5d\n", (int)getpid());
219 if (write(thisServer.pid_fd, buff, strlen(buff)) == -1)
220 Debug((DEBUG_NOTICE, "Error writing to pid file %s: %m",
221 feature_str(FEAT_PPATH)));
224 Debug((DEBUG_NOTICE, "Error opening pid file %s: %m",
225 feature_str(FEAT_PPATH)));
228 /** Try to create the PID file.
229 * @return Zero on success; non-zero on any error.
231 static int check_pid(void)
235 lock.l_type = F_WRLCK;
237 lock.l_whence = SEEK_SET;
240 if ((thisServer.pid_fd = open(feature_str(FEAT_PPATH), O_CREAT | O_RDWR,
242 return fcntl(thisServer.pid_fd, F_SETLK, &lock) == -1;
248 /** Look for any connections that we should try to initiate.
249 * Reschedules itself to run again at the appropriate time.
250 * @param[in] ev Timer event (ignored).
252 static void try_connections(struct Event* ev) {
253 struct ConfItem* aconf;
254 struct ConfItem** pconf;
260 assert(ET_EXPIRE == ev_type(ev));
261 assert(0 != ev_timer(ev));
263 Debug((DEBUG_NOTICE, "Connection check at : %s", myctime(CurrentTime)));
264 next = CurrentTime + feature_int(FEAT_CONNECTFREQUENCY);
267 for (aconf = GlobalConfList; aconf; aconf = aconf->next) {
268 /* Only consider server items with non-zero port and non-zero
269 * connect times that are not actively juped.
271 if (!(aconf->status & CONF_SERVER)
272 || aconf->address.port == 0
273 || !(aconf->flags & CONF_AUTOCONNECT)
274 || ((ajupe = jupe_find(aconf->name)) && JupeIsActive(ajupe)))
277 /* Do we need to postpone this connection further? */
278 hold = aconf->hold > CurrentTime;
280 /* Update next possible connection check time. */
281 if (hold && next > aconf->hold)
284 /* Do not try to connect if its use is still on hold until future,
285 * we have already initiated a connection this try_connections(),
286 * too many links in its connection class, it is already linked,
287 * or if connect rules forbid a link now.
290 || (ConfLinks(aconf) > ConfMaxLinks(aconf))
291 || FindServer(aconf->name)
292 || conf_eval_crule(aconf->name, CRULE_MASK))
295 /* Ensure it is at the end of the list for future checks. */
297 /* Find aconf's location in the list and splice it out. */
298 for (pconf = &GlobalConfList; *pconf; pconf = &(*pconf)->next)
300 *pconf = aconf->next;
301 /* Reinsert it at the end of the list (where pconf is now). */
306 /* Activate the connection itself. */
307 if (connect_server(aconf, 0))
308 sendto_opmask_butone(0, SNO_OLDSNO, "Connection to %s activated.",
311 /* And stop looking for further candidates. */
315 Debug((DEBUG_NOTICE, "Next connection check : %s", myctime(next)));
316 timer_add(&connect_timer, try_connections, 0, TT_ABSOLUTE, next);
320 /** Check for clients that have not sent a ping response recently.
321 * Reschedules itself to run again at the appropriate time.
322 * @param[in] ev Timer event (ignored).
324 static void check_pings(struct Event* ev) {
326 int next_check = CurrentTime;
330 assert(ET_EXPIRE == ev_type(ev));
331 assert(0 != ev_timer(ev));
333 next_check += feature_int(FEAT_PINGFREQUENCY);
335 /* Scan through the client table */
336 for (i=0; i <= HighestFd; i++) {
337 struct Client *cptr = LocalClientArray[i];
342 assert(&me != cptr); /* I should never be in the local client array! */
345 /* Remove dead clients. */
347 exit_client(cptr, cptr, &me, cli_info(cptr));
351 max_ping = IsRegistered(cptr) ? client_get_ping(cptr) :
352 feature_int(FEAT_CONNECTTIMEOUT);
354 Debug((DEBUG_DEBUG, "check_pings(%s)=status:%s limit: %d current: %d",
356 IsPingSent(cptr) ? "[Ping Sent]" : "[]",
357 max_ping, (int)(CurrentTime - cli_lasttime(cptr))));
359 /* If it's a server and we have not sent an AsLL lately, do so. */
360 if (IsServer(cptr)) {
361 if (CurrentTime - cli_serv(cptr)->asll_last >= max_ping) {
365 cli_serv(cptr)->asll_last = CurrentTime;
366 expire = cli_serv(cptr)->asll_last + max_ping;
367 asll_ts = militime_float(NULL);
368 sendcmdto_prio_one(&me, CMD_PING, cptr, "!%s %s %s", asll_ts,
369 cli_name(cptr), asll_ts);
372 expire = cli_serv(cptr)->asll_last + max_ping;
373 if (expire < next_check)
377 /* Ok, the thing that will happen most frequently, is that someone will
378 * have sent something recently. Cover this first for speed.
380 * If it's an unregistered client and hasn't managed to register within
381 * max_ping then it's obviously having problems (broken client) or it's
382 * just up to no good, so we won't skip it, even if its been sending
386 if ((CurrentTime-cli_lasttime(cptr) < max_ping) && IsRegistered(cptr)) {
387 expire = cli_lasttime(cptr) + max_ping;
388 if (expire < next_check)
393 /* Unregistered clients pingout after max_ping seconds, they don't
394 * get given a second chance - if they were then people could not quite
395 * finish registration and hold resources without being subject to k/g
398 if (!IsRegistered(cptr)) {
399 assert(!IsServer(cptr));
400 /* If client authorization time has expired, ask auth whether they
401 * should be checked again later. */
402 if ((CurrentTime-cli_firsttime(cptr) >= max_ping)
403 && auth_ping_timeout(cptr))
405 /* OK, they still have enough time left, so we'll just skip to the
406 * next client. Set the next check to be when their time is up, if
407 * that's before the currently scheduled next check -- hikari */
408 expire = cli_firsttime(cptr) + max_ping;
409 if (expire < next_check)
414 /* Quit the client after max_ping*2 - they should have answered by now */
415 if (CurrentTime-cli_lasttime(cptr) >= (max_ping*2) )
417 /* If it was a server, then tell ops about it. */
418 if (IsServer(cptr) || IsConnecting(cptr) || IsHandshake(cptr))
419 sendto_opmask_butone(0, SNO_OLDSNO,
420 "No response from %s, closing link",
422 exit_client_msg(cptr, cptr, &me, "Ping timeout");
426 if (!IsPingSent(cptr))
428 /* If we haven't PINGed the connection and we haven't heard from it in a
429 * while, PING it to make sure it is still alive.
433 /* If we're late in noticing don't hold it against them :) */
434 cli_lasttime(cptr) = CurrentTime - max_ping;
437 sendrawto_one(cptr, MSG_PING " :%s", cli_name(&me));
439 sendcmdto_prio_one(&me, CMD_PING, cptr, ":%s", cli_name(&me));
442 expire = cli_lasttime(cptr) + max_ping * 2;
443 if (expire < next_check)
447 assert(next_check >= CurrentTime);
449 Debug((DEBUG_DEBUG, "[%i] check_pings() again in %is",
450 CurrentTime, next_check-CurrentTime));
452 timer_add(&ping_timer, check_pings, 0, TT_ABSOLUTE, next_check);
456 /** Parse command line arguments.
457 * Global variables are updated to reflect the arguments.
458 * As a side effect, makes sure the process's effective user id is the
459 * same as the real user id.
460 * @param[in] argc Number of arguments on command line.
461 * @param[in,out] argv Command-lne arguments.
463 static void parse_command_line(int argc, char** argv) {
464 const char *options = "d:f:h:nktvx:c:";
467 if (thisServer.euid != thisServer.uid)
468 setuid(thisServer.uid);
470 /* Do we really need to sanity check the non-NULLness of optarg? That's
471 * getopt()'s job... Removing those... -zs
473 while ((opt = getopt(argc, argv, options)) != EOF)
475 case 'k': thisServer.bootopt |= BOOT_CHKCONF | BOOT_TTY; break;
476 case 'c': dbg_client = optarg; break;
478 case 't': thisServer.bootopt |= BOOT_TTY; break;
479 case 'd': dpath = optarg; break;
480 case 'f': configfile = optarg; break;
481 case 'h': ircd_strncpy(cli_name(&me), optarg, HOSTLEN); break;
483 printf("ircd %s\n", version);
484 printf("Event engines: ");
489 printf("/dev/poll ");
492 printf("epoll_*() ");
499 printf("\nCompiled for a maximum of %d connections.\n", MAXCONNECTIONS);
506 debuglevel = atoi(optarg);
510 thisServer.bootopt |= BOOT_DEBUG;
512 printf("WARNING: DEBUGMODE disabled; -x has no effect.\n");
517 printf("Usage: ircd [-f config] [-h servername] [-x loglevel] [-ntv] [-k [-c clispec]]\n"
518 "\n -f config\t specify explicit configuration file"
519 "\n -x loglevel\t set debug logging verbosity"
520 "\n -n or -t\t don't detach"
521 "\n -v\t\t display version"
522 "\n -k\t\t exit after checking config"
523 "\n -c clispec\t search for client/kill blocks matching client"
524 "\n\t\t clispec is comma-separated list of user@host,"
525 "\n\t\t user@ip, $Rrealname, and port number"
526 "\n\nServer not started.\n");
533 * @param[in] no_fork If non-zero, do not fork into the background.
535 static void daemon_init(int no_fork) {
545 if ((fd = open("/dev/tty", O_RDWR)) > -1) {
546 ioctl(fd, TIOCNOTTY, 0);
555 /** Check that we have access to a particular file.
556 * If we do not have access to the file, complain on stderr.
557 * @param[in] path File name to check for access.
558 * @param[in] which Configuration character associated with file.
559 * @param[in] mode Bitwise combination of R_OK, W_OK, X_OK and/or F_OK.
560 * @return Non-zero if we have the necessary access, zero if not.
562 static char check_file_access(const char *path, char which, int mode) {
563 if (!access(path, mode))
567 "Check on %cPATH (%s) failed: %s\n"
568 "Please create this file and/or rerun `configure' "
569 "using --with-%cpath and recompile to correct this.\n",
570 which, path, strerror(errno), which);
576 /*----------------------------------------------------------------------------
578 *--------------------------------------------------------------------------*/
579 #if defined(HAVE_SETRLIMIT) && defined(RLIMIT_CORE)
580 /** Set the core size soft limit to the same as the hard limit. */
581 static void set_core_limit(void) {
582 struct rlimit corelim;
584 if (getrlimit(RLIMIT_CORE, &corelim)) {
585 fprintf(stderr, "Read of rlimit core size failed: %s\n", strerror(errno));
586 corelim.rlim_max = RLIM_INFINITY; /* Try to recover */
589 corelim.rlim_cur = corelim.rlim_max;
590 if (setrlimit(RLIMIT_CORE, &corelim))
591 fprintf(stderr, "Setting rlimit core size failed: %s\n", strerror(errno));
597 /** Complain to stderr if any user or group ID belongs to the superuser.
598 * @return Non-zero if all IDs are okay, zero if some are 0.
600 static int set_userid_if_needed(void) {
601 if (getuid() == 0 || geteuid() == 0 ||
602 getgid() == 0 || getegid() == 0) {
603 fprintf(stderr, "ERROR: This server will not run as superuser.\n");
611 /*----------------------------------------------------------------------------
614 * TODO: This should set the basic environment up and start the main loop.
615 * we're doing waaaaaaaaay too much server initialization here. I hate
616 * long and ugly control paths... -smd
617 *--------------------------------------------------------------------------*/
619 * @param[in] argc Number of arguments in \a argv.
620 * @param[in] argv Arguments to program execution.
622 int main(int argc, char **argv) {
623 CurrentTime = time(NULL);
625 thisServer.argc = argc;
626 thisServer.argv = argv;
627 thisServer.uid = getuid();
628 thisServer.euid = geteuid();
631 mem_dbg_initialise();
634 #if defined(HAVE_SETRLIMIT) && defined(RLIMIT_CORE)
638 umask(077); /* better safe than sorry --SRB */
639 memset(&me, 0, sizeof(me));
640 memset(&me_con, 0, sizeof(me_con));
641 cli_connect(&me) = &me_con;
644 parse_command_line(argc, argv);
647 fprintf(stderr, "Fail: Cannot chdir(%s): %s, check DPATH\n", dpath, strerror(errno));
651 if (!set_userid_if_needed())
654 /* Check paths for accessibility */
655 if (!check_file_access(SPATH, 'S', X_OK) ||
656 !check_file_access(configfile, 'C', R_OK))
659 if (!init_connection_limits())
662 close_connections(!(thisServer.bootopt & (BOOT_DEBUG | BOOT_TTY | BOOT_CHKCONF)));
664 /* daemon_init() must be before event_init() because kqueue() FDs
665 * are, perversely, not inherited across fork().
667 daemon_init(thisServer.bootopt & BOOT_TTY);
670 /* Must reserve fd 2... */
671 if (debuglevel >= 0 && !(thisServer.bootopt & BOOT_TTY)) {
673 if ((fd = open("/dev/null", O_WRONLY)) < 0) {
674 fprintf(stderr, "Unable to open /dev/null (to reserve fd 2): %s\n",
678 if (fd != 2 && dup2(fd, 2) < 0) {
679 fprintf(stderr, "Unable to reserve fd 2; dup2 said: %s\n",
686 event_init(MAXCONNECTIONS);
689 feature_init(); /* initialize features... */
691 set_nomem_handler(outofmemory);
701 /* we need this for now, when we're modular this
702 should be removed -- hikari */
708 log_write(LS_SYSTEM, L_CRIT, 0, "Failed to read configuration file %s",
713 if (thisServer.bootopt & BOOT_CHKCONF) {
715 conf_debug_iline(dbg_client);
716 fprintf(stderr, "Configuration file %s checked okay.\n", configfile);
720 debug_init(thisServer.bootopt & BOOT_TTY);
722 Debug((DEBUG_FATAL, "Failed to acquire PID file lock after fork"));
726 init_server_identity();
733 timer_add(timer_init(&connect_timer), try_connections, 0, TT_RELATIVE, 1);
734 timer_add(timer_init(&ping_timer), check_pings, 0, TT_RELATIVE, 1);
735 timer_add(timer_init(&destruct_event_timer), exec_expired_destruct_events, 0, TT_PERIODIC, 60);
737 CurrentTime = time(NULL);
740 cli_magic(&me) = CLIENT_MAGIC;
744 cli_serv(&me)->timestamp = TStime(); /* Abuse own link timestamp as start TS */
745 cli_serv(&me)->prot = atoi(MAJOR_PROTOCOL);
746 cli_serv(&me)->up = &me;
747 cli_serv(&me)->down = NULL;
748 cli_handler(&me) = SERVER_HANDLER;
750 SetYXXCapacity(&me, MAXCLIENTS);
752 cli_lasttime(&me) = cli_since(&me) = cli_firsttime(&me) = CurrentTime;
760 Debug((DEBUG_NOTICE, "Server ready..."));
761 log_write(LS_SYSTEM, L_NOTICE, 0, "Server Ready");