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 */
72 #include <sys/socket.h>
74 #include <sys/types.h>
79 /*----------------------------------------------------------------------------
81 *--------------------------------------------------------------------------*/
82 extern void init_counters(void);
83 extern void mem_dbg_initialise(void);
85 /*----------------------------------------------------------------------------
87 *--------------------------------------------------------------------------*/
89 BOOT_DEBUG = 1, /**< Enable debug output. */
90 BOOT_TTY = 2, /**< Stay connected to TTY. */
91 BOOT_CHKCONF = 4 /**< Exit after reading configuration file. */
95 /*----------------------------------------------------------------------------
97 *--------------------------------------------------------------------------*/
98 struct Client me; /**< That's me */
99 struct Connection me_con; /**< That's me too */
100 struct Client *GlobalClientList = &me; /**< Pointer to beginning of
102 time_t TSoffset = 0; /**< Offset of timestamps to system clock */
103 int GlobalRehashFlag = 0; /**< do a rehash if set */
104 int GlobalRestartFlag = 0; /**< do a restart if set */
105 time_t CurrentTime; /**< Updated every time we leave select() */
107 char *configfile = CPATH; /**< Server configuration file */
108 int debuglevel = -1; /**< Server debug level */
109 char *debugmode = ""; /**< Server debug level */
110 static char *dpath = DPATH; /**< Working directory for daemon */
112 static struct Timer connect_timer; /**< timer structure for try_connections() */
113 static struct Timer ping_timer; /**< timer structure for check_pings() */
114 static struct Timer destruct_event_timer; /**< timer structure for exec_expired_destruct_events() */
116 /** Daemon information. */
117 static struct Daemon thisServer = { 0, 0, 0, 0, 0, 0, -1 };
119 /** Non-zero until we want to exit. */
123 /*----------------------------------------------------------------------------
125 *--------------------------------------------------------------------------*/
126 /** Terminate the server with a message.
127 * @param[in] message Message to log and send to operators.
129 void server_die(const char *message)
131 /* log_write will send out message to both log file and as server notice */
132 log_write(LS_SYSTEM, L_CRIT, 0, "Server terminating: %s", message);
133 flush_connections(0);
134 close_connections(1);
138 /*----------------------------------------------------------------------------
140 *--------------------------------------------------------------------------*/
141 /** Immediately terminate the server with a message.
142 * @param[in] message Message to log, but not send to operators.
144 void server_panic(const char *message)
146 /* inhibit sending server notice--we may be panicing due to low memory */
147 log_write(LS_SYSTEM, L_CRIT, LOG_NOSNOTICE, "Server panic: %s", message);
148 flush_connections(0);
150 close_connections(1);
154 /*----------------------------------------------------------------------------
155 * API: server_restart
156 *--------------------------------------------------------------------------*/
157 /** Restart the server with a message.
158 * @param[in] message Message to log and send to operators.
160 void server_restart(const char *message)
162 static int restarting = 0;
164 /* inhibit sending any server notices; we may be in a loop */
165 log_write(LS_SYSTEM, L_WARNING, LOG_NOSNOTICE, "Restarting Server: %s",
167 if (restarting++) /* increment restarting to prevent looping */
170 sendto_opmask_butone(0, SNO_OLDSNO, "Restarting server: %s", message);
171 Debug((DEBUG_NOTICE, "Restarting server..."));
172 flush_connections(0);
176 close_connections(!(thisServer.bootopt & (BOOT_TTY | BOOT_DEBUG | BOOT_CHKCONF)));
178 execv(SPATH, thisServer.argv);
180 /* Have to reopen since it has been closed above */
183 log_write(LS_SYSTEM, L_CRIT, 0, "execv(%s,%s) failed: %m", SPATH,
186 Debug((DEBUG_FATAL, "Couldn't restart server \"%s\": %s",
187 SPATH, (strerror(errno)) ? strerror(errno) : ""));
192 /*----------------------------------------------------------------------------
193 * outofmemory: Handler for out of memory conditions...
194 *--------------------------------------------------------------------------*/
195 /** Handle out-of-memory condition. */
196 static void outofmemory(void) {
197 Debug((DEBUG_FATAL, "Out of memory: restarting server..."));
198 server_restart("Out of Memory");
202 /*----------------------------------------------------------------------------
204 *--------------------------------------------------------------------------*/
205 /** Write process ID to PID file. */
206 static void write_pidfile(void) {
209 if (thisServer.pid_fd >= 0) {
210 memset(buff, 0, sizeof(buff));
211 sprintf(buff, "%5d\n", (int)getpid());
212 if (write(thisServer.pid_fd, buff, strlen(buff)) == -1)
213 Debug((DEBUG_NOTICE, "Error writing to pid file %s: %m",
214 feature_str(FEAT_PPATH)));
217 Debug((DEBUG_NOTICE, "Error opening pid file %s: %m",
218 feature_str(FEAT_PPATH)));
221 /** Try to create the PID file.
222 * @return Zero on success; non-zero on any error.
224 static int check_pid(void)
228 lock.l_type = F_WRLCK;
230 lock.l_whence = SEEK_SET;
233 if ((thisServer.pid_fd = open(feature_str(FEAT_PPATH), O_CREAT | O_RDWR,
235 return fcntl(thisServer.pid_fd, F_SETLK, &lock) == -1;
241 /** Look for any connections that we should try to initiate.
242 * Reschedules itself to run again at the appropriate time.
243 * @param[in] ev Timer event (ignored).
245 static void try_connections(struct Event* ev) {
246 struct ConfItem* aconf;
247 struct ConfItem** pconf;
249 struct ConnectionClass* cltmp;
253 assert(ET_EXPIRE == ev_type(ev));
254 assert(0 != ev_timer(ev));
256 Debug((DEBUG_NOTICE, "Connection check at : %s", myctime(CurrentTime)));
257 for (aconf = GlobalConfList; aconf; aconf = aconf->next) {
258 /* Only consider server items with non-zero port and non-zero
259 * connect times that are not actively juped.
261 if (!(aconf->status & CONF_SERVER)
262 || aconf->address.port == 0
263 || ((ajupe = jupe_find(aconf->name)) && JupeIsActive(ajupe)))
266 /* Update next possible connection check time. */
267 if (next > aconf->hold || next == 0)
270 /* Update the next time we can consider this entry. */
271 cltmp = aconf->conn_class;
272 hold = aconf->hold > CurrentTime; /* before we update aconf->hold */
273 aconf->hold = ConFreq(cltmp) ? CurrentTime + ConFreq(cltmp) : 0;
275 /* Do not try to connect if its use is still on hold until future,
276 * too many links in its connection class, it is already linked,
277 * or if connect rules forbid a link now.
280 || (Links(cltmp) > MaxLinks(cltmp))
281 || FindServer(aconf->name)
282 || conf_eval_crule(aconf->name, CRULE_MASK))
285 /* Ensure it is at the end of the list for future checks. */
287 /* Find aconf's location in the list and splice it out. */
288 for (pconf = &GlobalConfList; *pconf; pconf = &(*pconf)->next)
290 *pconf = aconf->next;
291 /* Reinsert it at the end of the list (where pconf is now). */
296 /* Activate the connection itself. */
297 if (connect_server(aconf, 0))
298 sendto_opmask_butone(0, SNO_OLDSNO, "Connection to %s activated.",
301 /* And stop looking for further candidates. */
306 next = CurrentTime + feature_int(FEAT_CONNECTFREQUENCY);
308 Debug((DEBUG_NOTICE, "Next connection check : %s", myctime(next)));
310 timer_add(&connect_timer, try_connections, 0, TT_ABSOLUTE, next);
314 /** Check for clients that have not sent a ping response recently.
315 * Reschedules itself to run again at the appropriate time.
316 * @param[in] ev Timer event (ignored).
318 static void check_pings(struct Event* ev) {
320 int next_check = CurrentTime;
324 assert(ET_EXPIRE == ev_type(ev));
325 assert(0 != ev_timer(ev));
327 next_check += feature_int(FEAT_PINGFREQUENCY);
329 /* Scan through the client table */
330 for (i=0; i <= HighestFd; i++) {
331 struct Client *cptr = LocalClientArray[i];
336 assert(&me != cptr); /* I should never be in the local client array! */
339 /* Remove dead clients. */
341 exit_client(cptr, cptr, &me, cli_info(cptr));
345 max_ping = IsRegistered(cptr) ? client_get_ping(cptr) :
346 feature_int(FEAT_CONNECTTIMEOUT);
348 Debug((DEBUG_DEBUG, "check_pings(%s)=status:%s limit: %d current: %d",
350 IsPingSent(cptr) ? "[Ping Sent]" : "[]",
351 max_ping, (int)(CurrentTime - cli_lasttime(cptr))));
353 /* Ok, the thing that will happen most frequently, is that someone will
354 * have sent something recently. Cover this first for speed.
356 * If it's an unregisterd client and hasn't managed to register within
357 * max_ping then it's obviously having problems (broken client) or it's
358 * just up to no good, so we won't skip it, even if its been sending
362 if ((CurrentTime-cli_lasttime(cptr) < max_ping) && IsRegistered(cptr)) {
363 expire = cli_lasttime(cptr) + max_ping;
364 if (expire < next_check)
369 /* Unregistered clients pingout after max_ping seconds, they don't
370 * get given a second chance - if they were then people could not quite
371 * finish registration and hold resources without being subject to k/g
374 if (!IsRegistered(cptr)) {
375 assert(!IsServer(cptr));
376 if ((CurrentTime-cli_firsttime(cptr) >= max_ping)) {
377 /* Display message if they have sent a NICK and a USER but no
380 if (*(cli_name(cptr)) && cli_user(cptr) && *(cli_user(cptr))->username) {
381 send_reply(cptr, SND_EXPLICIT | ERR_BADPING,
382 ":Your client may not be compatible with this server.");
383 send_reply(cptr, SND_EXPLICIT | ERR_BADPING,
384 ":Compatible clients are available at %s",
385 feature_str(FEAT_URL_CLIENTS));
387 exit_client_msg(cptr,cptr,&me, "Registration Timeout");
390 /* OK, they still have enough time left, so we'll just skip to the
391 * next client. Set the next check to be when their time is up, if
392 * that's before the currently scheduled next check -- hikari */
393 expire = cli_firsttime(cptr) + max_ping;
394 if (expire < next_check)
400 /* Quit the client after max_ping*2 - they should have answered by now */
401 if (CurrentTime-cli_lasttime(cptr) >= (max_ping*2) )
403 /* If it was a server, then tell ops about it. */
404 if (IsServer(cptr) || IsConnecting(cptr) || IsHandshake(cptr))
405 sendto_opmask_butone(0, SNO_OLDSNO,
406 "No response from %s, closing link",
408 exit_client_msg(cptr, cptr, &me, "Ping timeout");
412 if (!IsPingSent(cptr))
414 /* If we havent PINGed the connection and we havent heard from it in a
415 * while, PING it to make sure it is still alive.
419 /* If we're late in noticing don't hold it against them :) */
420 cli_lasttime(cptr) = CurrentTime - max_ping;
423 sendrawto_one(cptr, MSG_PING " :%s", cli_name(&me));
426 char *asll_ts = militime_float(NULL);
427 sendcmdto_one(&me, CMD_PING, cptr, "!%s %s %s", asll_ts,
428 cli_name(cptr), asll_ts);
432 expire = cli_lasttime(cptr) + max_ping * 2;
433 if (expire < next_check)
437 assert(next_check >= CurrentTime);
439 Debug((DEBUG_DEBUG, "[%i] check_pings() again in %is",
440 CurrentTime, next_check-CurrentTime));
442 timer_add(&ping_timer, check_pings, 0, TT_ABSOLUTE, next_check);
446 /** Parse command line arguments.
447 * Global variables are updated to reflect the arguments.
448 * As a side effect, makes sure the process's effective user id is the
449 * same as the real user id.
450 * @param[in] argc Number of arguments on command line.
451 * @param[in,out] argv Command-lne arguments.
453 static void parse_command_line(int argc, char** argv) {
454 const char *options = "d:f:h:nktvx:";
457 if (thisServer.euid != thisServer.uid)
458 setuid(thisServer.uid);
460 /* Do we really need to santiy check the non-NULLness of optarg? That's
461 * getopt()'s job... Removing those... -zs
463 while ((opt = getopt(argc, argv, options)) != EOF)
465 case 'k': thisServer.bootopt |= BOOT_CHKCONF | BOOT_TTY; break;
467 case 't': thisServer.bootopt |= BOOT_TTY; break;
468 case 'd': dpath = optarg; break;
469 case 'f': configfile = optarg; break;
470 case 'h': ircd_strncpy(cli_name(&me), optarg, HOSTLEN); break;
472 printf("ircd %s\n", version);
473 printf("Event engines: ");
478 printf("/dev/poll ");
485 printf("\nCompiled for a maximum of %d connections.\n", MAXCONNECTIONS);
492 debuglevel = atoi(optarg);
496 thisServer.bootopt |= BOOT_DEBUG;
500 printf("Usage: ircd [-f config] [-h servername] [-x loglevel] [-ntvk]\n");
501 printf("\n -n -t\t Don't detach\n -v\t display version\n -k\t exit after checking config\n\n");
502 printf("Server not started.\n");
509 * @param[in] no_fork If non-zero, do not fork into the background.
511 static void daemon_init(int no_fork) {
521 if ((fd = open("/dev/tty", O_RDWR)) > -1) {
522 ioctl(fd, TIOCNOTTY, 0);
531 /** Check that we have access to a particular file.
532 * If we do not have access to the file, complain on stderr.
533 * @param[in] path File name to check for access.
534 * @param[in] which Configuration character associated with file.
535 * @param[in] mode Bitwise combination of R_OK, W_OK, X_OK and/or F_OK.
536 * @return Non-zero if we have the necessary access, zero if not.
538 static char check_file_access(const char *path, char which, int mode) {
539 if (!access(path, mode))
543 "Check on %cPATH (%s) failed: %s\n"
544 "Please create this file and/or rerun `configure' "
545 "using --with-%cpath and recompile to correct this.\n",
546 which, path, strerror(errno), which);
552 /*----------------------------------------------------------------------------
554 *--------------------------------------------------------------------------*/
555 #if defined(HAVE_SETRLIMIT) && defined(RLIMIT_CORE)
556 /** Set the core size soft limit to the same as the hard limit. */
557 static void set_core_limit(void) {
558 struct rlimit corelim;
560 if (getrlimit(RLIMIT_CORE, &corelim)) {
561 fprintf(stderr, "Read of rlimit core size failed: %s\n", strerror(errno));
562 corelim.rlim_max = RLIM_INFINITY; /* Try to recover */
565 corelim.rlim_cur = corelim.rlim_max;
566 if (setrlimit(RLIMIT_CORE, &corelim))
567 fprintf(stderr, "Setting rlimit core size failed: %s\n", strerror(errno));
573 /** Complain to stderr if any user or group ID belongs to the superuser.
574 * @return Non-zero if all IDs are okay, zero if some are 0.
576 static int set_userid_if_needed(void) {
577 if (getuid() == 0 || geteuid() == 0 ||
578 getgid() == 0 || getegid() == 0) {
579 fprintf(stderr, "ERROR: This server will not run as superuser.\n");
587 /*----------------------------------------------------------------------------
590 * TODO: This should set the basic environment up and start the main loop.
591 * we're doing waaaaaaaaay too much server initialization here. I hate
592 * long and ugly control paths... -smd
593 *--------------------------------------------------------------------------*/
595 * @param[in] argc Number of arguments in \a argv.
596 * @param[in] argv Arguments to program execution.
598 int main(int argc, char **argv) {
599 CurrentTime = time(NULL);
601 thisServer.argc = argc;
602 thisServer.argv = argv;
603 thisServer.uid = getuid();
604 thisServer.euid = geteuid();
607 mem_dbg_initialise();
610 #if defined(HAVE_SETRLIMIT) && defined(RLIMIT_CORE)
614 umask(077); /* better safe than sorry --SRB */
615 memset(&me, 0, sizeof(me));
616 memset(&me_con, 0, sizeof(me_con));
617 cli_connect(&me) = &me_con;
620 parse_command_line(argc, argv);
623 fprintf(stderr, "Fail: Cannot chdir(%s): %s, check DPATH\n", dpath, strerror(errno));
627 if (!set_userid_if_needed())
630 /* Check paths for accessibility */
631 if (!check_file_access(SPATH, 'S', X_OK) ||
632 !check_file_access(configfile, 'C', R_OK))
635 if (!init_connection_limits())
638 close_connections(!(thisServer.bootopt & (BOOT_DEBUG | BOOT_TTY | BOOT_CHKCONF)));
640 /* daemon_init() must be before event_init() because kqueue() FDs
641 * are, perversely, not inherited across fork().
643 daemon_init(thisServer.bootopt & BOOT_TTY);
645 event_init(MAXCONNECTIONS);
648 feature_init(); /* initialize features... */
650 set_nomem_handler(outofmemory);
652 if (!init_string()) {
653 log_write(LS_SYSTEM, L_CRIT, 0, "Failed to initialize string module");
665 /* we need this for now, when we're modular this
666 should be removed -- hikari */
672 log_write(LS_SYSTEM, L_CRIT, 0, "Failed to read configuration file %s",
677 if (thisServer.bootopt & BOOT_CHKCONF) {
678 fprintf(stderr, "Configuration file %s checked okay.\n", configfile);
682 debug_init(thisServer.bootopt & BOOT_TTY);
684 Debug((DEBUG_FATAL, "Failed to acquire PID file lock after fork"));
688 init_server_identity();
695 timer_add(timer_init(&connect_timer), try_connections, 0, TT_RELATIVE, 1);
696 timer_add(timer_init(&ping_timer), check_pings, 0, TT_RELATIVE, 1);
697 timer_add(timer_init(&destruct_event_timer), exec_expired_destruct_events, 0, TT_PERIODIC, 60);
699 CurrentTime = time(NULL);
702 cli_magic(&me) = CLIENT_MAGIC;
706 cli_serv(&me)->timestamp = TStime(); /* Abuse own link timestamp as start TS */
707 cli_serv(&me)->prot = atoi(MAJOR_PROTOCOL);
708 cli_serv(&me)->up = &me;
709 cli_serv(&me)->down = NULL;
710 cli_handler(&me) = SERVER_HANDLER;
712 SetYXXCapacity(&me, MAXCLIENTS);
714 cli_lasttime(&me) = cli_since(&me) = cli_firsttime(&me) = CurrentTime;
721 Debug((DEBUG_NOTICE, "Server ready..."));
722 log_write(LS_SYSTEM, L_NOTICE, 0, "Server Ready");