1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 /* $Install: src/inspircd $(BINPATH) */
21 #include <sys/resource.h>
25 /* Some systems don't define RUSAGE_SELF. This should fix them. */
30 /* CRT memory debugging */
32 #define _CRTDBG_MAP_ALLOC
41 #include "socketengine.h"
42 #include "inspircd_se_config.h"
44 #include "command_parse.h"
45 #include "exitcodes.h"
47 #include "testsuite.h"
49 using irc::sockets::insp_ntoa;
50 using irc::sockets::insp_inaddr;
51 using irc::sockets::insp_sockaddr;
57 /* Moved from exitcodes.h -- due to duplicate symbols -- Burlex
58 * XXX this is a bit ugly. -- w00t
60 const char* ExitCodes[] =
63 "DIE command", /* 1 */
64 "execv() failed", /* 2 */
65 "Internal error", /* 3 */
66 "Config file error", /* 4 */
67 "Logfile error", /* 5 */
68 "POSIX fork failed", /* 6 */
69 "Bad commandline parameters", /* 7 */
70 "No ports could be bound", /* 8 */
71 "Can't write PID file", /* 9 */
72 "SocketEngine could not initialize", /* 10 */
73 "Refusing to start up as root", /* 11 */
74 "Found a <die> tag!", /* 12 */
75 "Couldn't load module on startup", /* 13 */
76 "Could not create windows forked process", /* 14 */
77 "Received SIGTERM", /* 15 */
80 void InspIRCd::Cleanup()
84 for (unsigned int i = 0; i < Config->ports.size(); i++)
86 /* This calls the constructor and closes the listening socket */
87 delete Config->ports[i];
90 Config->ports.clear();
93 /* Close all client sockets, or the new process inherits them */
94 for (std::vector<User*>::const_iterator i = this->Users->local_users.begin(); i != this->Users->local_users.end(); i++)
96 (*i)->SetWriteError("Server shutdown");
100 /* We do this more than once, so that any service providers get a
101 * chance to be unhooked by the modules using them, but then get
102 * a chance to be removed themsleves.
104 * XXX there may be a better way to do this with 1.2
106 for (int tries = 0; tries < 3; tries++)
108 std::vector<std::string> module_names = Modules->GetAllModuleNames(0);
109 for (std::vector<std::string>::iterator k = module_names.begin(); k != module_names.end(); ++k)
111 /* Unload all modules, so they get a chance to clean up their listeners */
112 this->Modules->Unload(k->c_str());
117 this->Logs->CloseLogs();
119 /* Cleanup Server Names */
120 for(servernamelist::iterator itr = servernames.begin(); itr != servernames.end(); ++itr)
126 void InspIRCd::Restart(const std::string &reason)
128 /* SendError flushes each client's queue,
129 * regardless of writeability state
131 this->SendError(reason);
135 /* Figure out our filename (if theyve renamed it, we're boned) */
139 char module[MAX_PATH];
140 if (GetModuleFileName(NULL, module, MAX_PATH))
143 me = Config->MyDir + "/inspircd";
146 if (execv(me.c_str(), Config->argv) == -1)
148 /* Will raise a SIGABRT if not trapped */
149 throw CoreException(std::string("Failed to execv()! error: ") + strerror(errno));
153 void InspIRCd::ResetMaxBans()
155 for (chan_hash::const_iterator i = chanlist->begin(); i != chanlist->end(); i++)
156 i->second->ResetMaxBans();
159 /** Because hash_map doesnt free its buckets when we delete items (this is a 'feature')
160 * we must occasionally rehash the hash (yes really).
161 * We do this by copying the entries from the old hash to a new hash, causing all
162 * empty buckets to be weeded out of the hash. We dont do this on a timer, as its
163 * very expensive, so instead we do it when the user types /REHASH and expects a
164 * short delay anyway.
166 void InspIRCd::RehashUsersAndChans()
168 user_hash* old_users = this->Users->clientlist;
169 user_hash* old_uuid = this->Users->uuidlist;
170 chan_hash* old_chans = this->chanlist;
172 this->Users->clientlist = new user_hash();
173 this->Users->uuidlist = new user_hash();
174 this->chanlist = new chan_hash();
176 for (user_hash::const_iterator n = old_users->begin(); n != old_users->end(); n++)
177 this->Users->clientlist->insert(*n);
181 for (user_hash::const_iterator n = old_uuid->begin(); n != old_uuid->end(); n++)
182 this->Users->uuidlist->insert(*n);
186 for (chan_hash::const_iterator n = old_chans->begin(); n != old_chans->end(); n++)
187 this->chanlist->insert(*n);
192 void InspIRCd::SetSignals()
195 signal(SIGALRM, SIG_IGN);
196 signal(SIGHUP, InspIRCd::SetSignal);
197 signal(SIGPIPE, SIG_IGN);
198 signal(SIGCHLD, SIG_IGN);
200 signal(SIGTERM, InspIRCd::SetSignal);
203 void InspIRCd::QuickExit(int status)
208 bool InspIRCd::DaemonSeed()
211 printf_c("InspIRCd Process ID: \033[1;32m%lu\033[0m\n", GetCurrentProcessId());
214 signal(SIGTERM, InspIRCd::QuickExit);
217 if ((childpid = fork ()) < 0)
219 else if (childpid > 0)
221 /* We wait here for the child process to kill us,
222 * so that the shell prompt doesnt come back over
224 * Sending a kill with a signal of 0 just checks
225 * if the child pid is still around. If theyre not,
226 * they threw an error and we should give up.
228 while (kill(childpid, 0) != -1)
234 printf("InspIRCd Process ID: \033[1;32m%lu\033[0m\n",(unsigned long)getpid());
236 signal(SIGTERM, InspIRCd::SetSignal);
239 if (getrlimit(RLIMIT_CORE, &rl) == -1)
241 this->Logs->Log("STARTUP",DEFAULT,"Failed to getrlimit()!");
246 rl.rlim_cur = rl.rlim_max;
247 if (setrlimit(RLIMIT_CORE, &rl) == -1)
248 this->Logs->Log("STARTUP",DEFAULT,"setrlimit() failed, cannot increase coredump size.");
255 void InspIRCd::WritePID(const std::string &filename)
257 std::string fname = (filename.empty() ? "inspircd.pid" : filename);
258 if (*(fname.begin()) != '/')
260 std::string::size_type pos;
261 std::string confpath = this->ConfigFileName;
262 if ((pos = confpath.rfind("/")) != std::string::npos)
264 /* Leaves us with just the path */
265 fname = confpath.substr(0, pos) + std::string("/") + fname;
268 std::ofstream outfile(fname.c_str());
269 if (outfile.is_open())
276 printf("Failed to write PID-file '%s', exiting.\n",fname.c_str());
277 this->Logs->Log("STARTUP",DEFAULT,"Failed to write PID-file '%s', exiting.",fname.c_str());
278 Exit(EXIT_STATUS_PID);
282 InspIRCd::InspIRCd(int argc, char** argv)
285 /* Functor initialisation. Note that the ordering here is very important.
287 * THIS MUST MATCH ORDER OF DECLARATION OF THE HandleWhateverFunc classes
288 * within class InspIRCd.
290 HandleProcessUser(this),
293 HandleFindDescriptor(this),
294 HandleFloodQuitUser(this),
295 HandleIsChannel(this),
299 /* Functor pointer initialisation. Must match the order of the list above
301 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
302 * themselves within the class.
304 ProcessUser(&HandleProcessUser),
305 IsChannel(&HandleIsChannel),
307 Rehash(&HandleRehash),
308 IsNick(&HandleIsNick),
309 IsIdent(&HandleIsIdent),
310 FindDescriptor(&HandleFindDescriptor),
311 FloodQuitUser(&HandleFloodQuitUser)
315 _CrtSetDbgFlag ( _CRTDBG_CHECK_ALWAYS_DF | _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
319 int do_version = 0, do_nofork = 0, do_debug = 0,
320 do_nolog = 0, do_root = 0, do_testsuite = 0; /* flag variables */
323 memset(&server, 0, sizeof(server));
324 memset(&client, 0, sizeof(client));
326 // This must be created first, so other parts of Insp can use it while starting up
327 this->Logs = new LogManager(this);
329 SocketEngineFactory* SEF = new SocketEngineFactory();
330 SE = SEF->Create(this);
333 ThreadEngineFactory* tef = new ThreadEngineFactory();
334 this->Threads = tef->Create(this);
337 /* Default implementation does nothing */
338 this->PI = new ProtocolInterface(this);
342 // Create base manager classes early, so nothing breaks
343 this->Users = new UserManager(this);
345 this->Users->unregistered_count = 0;
347 this->Users->clientlist = new user_hash();
348 this->Users->uuidlist = new user_hash();
349 this->chanlist = new chan_hash();
353 this->Config = new ServerConfig(this);
354 this->SNO = new SnomaskManager(this);
355 this->BanCache = new BanCacheManager(this);
356 this->Modules = new ModuleManager(this);
357 this->stats = new serverstats();
358 this->Timers = new TimerManager(this);
359 this->Parser = new CommandParser(this);
360 this->XLines = new XLineManager(this);
362 this->Config->argv = argv;
363 this->Config->argc = argc;
365 if (chdir(Config->GetFullProgDir().c_str()))
367 printf("Unable to change to my directory: %s\nAborted.", strerror(errno));
371 this->Config->opertypes.clear();
372 this->Config->operclass.clear();
374 this->TIME = this->OLDTIME = this->startup_time = time(NULL);
377 *this->LogFileName = 0;
378 strlcpy(this->ConfigFileName, CONFIG_FILE, MAXBUF);
380 struct option longopts[] =
382 { "nofork", no_argument, &do_nofork, 1 },
383 { "logfile", required_argument, NULL, 'f' },
384 { "config", required_argument, NULL, 'c' },
385 { "debug", no_argument, &do_debug, 1 },
386 { "nolog", no_argument, &do_nolog, 1 },
387 { "runasroot", no_argument, &do_root, 1 },
388 { "version", no_argument, &do_version, 1 },
389 { "testsuite", no_argument, &do_testsuite, 1 },
393 while ((c = getopt_long_only(argc, argv, ":f:", longopts, NULL)) != -1)
398 /* Log filename was set */
399 strlcpy(LogFileName, optarg, MAXBUF);
402 /* Config filename was set */
403 strlcpy(ConfigFileName, optarg, MAXBUF);
406 /* getopt_long_only() set an int variable, just keep going */
409 /* Unknown parameter! DANGER, INTRUDER.... err.... yeah. */
410 printf("Usage: %s [--nofork] [--nolog] [--debug] [--logfile <filename>]\n\
411 [--runasroot] [--version] [--config <config>] [--testsuite]\n", argv[0]);
412 Exit(EXIT_STATUS_ARGV);
418 do_nofork = do_debug = true;
422 printf("\n%s r%s\n", VERSION, REVISION);
423 Exit(EXIT_STATUS_NOERROR);
431 DWORD ExitCode = WindowsForkStart(this);
438 WSAStartup(MAKEWORD(2,0), &wsadata);
439 ChangeWindowsSpecificPointers(this);
441 strlcpy(Config->MyExecutable,argv[0],MAXBUF);
443 /* Set the finished argument values */
444 Config->nofork = do_nofork;
445 Config->forcedebug = do_debug;
446 Config->writelog = !do_nolog;
447 Config->TestSuite = do_testsuite;
449 if (!this->OpenLog(argv, argc))
451 printf("ERROR: Could not open logfile %s: %s\n\n", Config->logpath.c_str(), strerror(errno));
452 Exit(EXIT_STATUS_LOG);
455 if (!ServerConfig::FileExists(this->ConfigFileName))
457 printf("ERROR: Cannot open config file: %s\nExiting...\n", this->ConfigFileName);
458 this->Logs->Log("STARTUP",DEFAULT,"Unable to open config file %s", this->ConfigFileName);
459 Exit(EXIT_STATUS_CONFIG);
462 printf_c("\033[1;32mInspire Internet Relay Chat Server, compiled %s at %s\n",__DATE__,__TIME__);
463 printf_c("(C) InspIRCd Development Team.\033[0m\n\n");
464 printf_c("Developers:\n");
465 printf_c("\t\033[1;32mBrain, FrostyCoolSlug, w00t, Om, Special\n");
466 printf_c("\t\033[1;32mpippijn, peavey, aquanight, fez\033[0m\n\n");
467 printf_c("Others:\t\t\t\033[1;32mSee /INFO Output\033[0m\n");
469 Config->ClearStack();
471 this->Modes = new ModeParser(this);
477 printf("* WARNING * WARNING * WARNING * WARNING * WARNING * \n\n");
478 printf("YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED\n");
479 printf("AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED\n");
480 printf("OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR\n");
481 printf("SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN\n");
482 printf("TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART\n");
483 printf("THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!\n");
484 printf("\nInspIRCd starting in 20 seconds, ctrl+c to abort...\n");
492 if (!this->DaemonSeed())
494 printf("ERROR: could not go into daemon mode. Shutting down.\n");
495 Logs->Log("STARTUP", DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
496 Exit(EXIT_STATUS_FORK);
500 SE->RecoverFromFork();
502 /* During startup we don't actually initialize this
503 * in the thread engine.
505 this->ConfigThread = new ConfigReaderThread(this, true, NULL);
508 this->ConfigThread = NULL;
510 this->Res = new DNS(this);
512 this->AddServerName(Config->ServerName);
515 * Initialise SID/UID.
516 * For an explanation as to exactly how this works, and why it works this way, see GetUID().
524 for (const char* x = Config->ServerName; *x; ++x)
526 for (const char* y = Config->ServerDesc; *y; ++y)
530 Config->sid[0] = (char)(sid / 100 + 48);
531 Config->sid[1] = (char)(((sid / 10) % 10) + 48);
532 Config->sid[2] = (char)(sid % 10 + 48);
535 /* set up fake client again this time with the correct uid */
536 this->FakeClient = new User(this, "#INVALID");
537 this->FakeClient->SetFd(FD_MAGIC_NUMBER);
539 // Get XLine to do it's thing.
540 this->XLines->CheckELines();
541 this->XLines->ApplyLines();
544 int bounditems = BindPorts(true, found_ports, pl);
548 this->Modules->LoadAll();
550 /* Just in case no modules were loaded - fix for bug #101 */
551 this->BuildISupport();
552 InitializeDisabledCommands(Config->DisabledCommands, this);
554 /*if ((Config->ports.size() == 0) && (found_ports > 0))
556 printf("\nERROR: I couldn't bind any ports! Are you sure you didn't start InspIRCd twice?\n");
557 Logs->Log("STARTUP", DEFAULT,"ERROR: I couldn't bind any ports! Something else is bound to those ports!");
558 Exit(EXIT_STATUS_BIND);
561 if (Config->ports.size() != (unsigned int)found_ports)
563 printf("\nWARNING: Not all your client ports could be bound --\nstarting anyway with %d of %d client ports bound.\n\n", bounditems, found_ports);
564 printf("The following port(s) failed to bind:\n");
565 printf("Hint: Try using an IP instead of blank or *\n\n");
567 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
569 printf("%d.\tIP: %s\tPort: %lu\n", j, i->first.empty() ? "<all>" : i->first.c_str(), (unsigned long)i->second);
573 printf("\nInspIRCd is now running as '%s'[%s] with %d max open sockets\n", Config->ServerName,Config->GetSID().c_str(), SE->GetMaxFds());
578 if (kill(getppid(), SIGTERM) == -1)
580 printf("Error killing parent process: %s\n",strerror(errno));
581 Logs->Log("STARTUP", DEFAULT, "Error killing parent process: %s",strerror(errno));
585 if (isatty(0) && isatty(1) && isatty(2))
587 /* We didn't start from a TTY, we must have started from a background process -
588 * e.g. we are restarting, or being launched by cron. Dont kill parent, and dont
599 Logs->Log("STARTUP", DEFAULT,"Keeping pseudo-tty open as we are running in the foreground.");
603 WindowsIPC = new IPC(this);
606 WindowsForkKillOwner(this);
611 Logs->Log("STARTUP", DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName,Config->GetSID().c_str(), SE->GetMaxFds());
613 this->WritePID(Config->PID);
618 /* See if we're supposed to be running the test suite rather than entering the mainloop */
619 if (Config->TestSuite)
621 TestSuite* ts = new TestSuite(this);
631 static time_t uptime;
632 static struct tm * stime;
633 static char window_title[100];
636 /* Check if there is a config thread which has finished executing but has not yet been freed */
637 if (this->ConfigThread && this->ConfigThread->GetExitFlag())
639 /* Rehash has completed */
640 this->Logs->Log("CONFIG",DEBUG,"Detected ConfigThread exiting, tidying up...");
642 /* IMPORTANT: This delete may hang if you fuck up your thread syncronization.
643 * It will hang waiting for the ConfigThread to 'join' to avoid race conditons,
644 * until the other thread is completed.
649 /* These are currently not known to be threadsafe, so they are executed outside
650 * of the thread. It would be pretty simple to move them to the thread Run method
651 * once they are known threadsafe with all the correct mutexes in place.
653 * XXX: The order of these is IMPORTANT, do not reorder them without testing
656 this->XLines->CheckELines();
657 this->XLines->ApplyLines();
659 this->ResetMaxBans();
660 InitializeDisabledCommands(Config->DisabledCommands, this);
661 FOREACH_MOD_I(this, I_OnRehash, OnRehash(Config->RehashUser, Config->RehashParameter));
662 this->BuildISupport();
665 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
666 * Once per loop iteration is pleanty.
671 /* Run background module timers every few seconds
672 * (the docs say modules shouldnt rely on accurate
673 * timing using this event, so we dont have to
674 * time this exactly).
680 SNO->WriteToSnoMask('A', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)OLDTIME-TIME);
683 if ((TIME % 3600) == 0)
685 this->RehashUsersAndChans();
686 FOREACH_MOD_I(this, I_OnGarbageCollect, OnGarbageCollect());
689 Timers->TickTimers(TIME);
690 this->DoBackgroundUserStuff();
694 FOREACH_MOD_I(this,I_OnBackgroundTimer,OnBackgroundTimer(TIME));
695 SNO->FlushSnotices();
698 /* Same change as in cmd_stats.cpp, use RUSAGE_SELF rather than '0' -- Om */
699 if (!getrusage(RUSAGE_SELF, &ru))
701 gettimeofday(&this->stats->LastSampled, NULL);
702 this->stats->LastCPU = ru.ru_utime;
709 /* Call the socket engine to wait on the active
710 * file descriptors. The socket engine has everything's
711 * descriptors in its list... dns, modules, users,
712 * servers... so its nice and easy, just one call.
713 * This will cause any read or write events to be
714 * dispatched to their handlers.
716 this->SE->DispatchEvents();
718 /* if any users were quit, take them out */
719 this->GlobalCulls.Apply();
721 /* If any inspsockets closed, remove them */
722 this->BufferedSocketCull();
726 this->SignalHandler(s_signal);
734 void InspIRCd::BufferedSocketCull()
736 for (std::map<BufferedSocket*,BufferedSocket*>::iterator x = SocketCull.begin(); x != SocketCull.end(); ++x)
738 this->Logs->Log("MISC",DEBUG,"Cull socket");
739 SE->DelFd(x->second);
746 /**********************************************************************************/
749 * An ircd in five lines! bwahahaha. ahahahahaha. ahahah *cough*.
752 int main(int argc, char ** argv)
754 SI = new InspIRCd(argc, argv);
755 mysig = &SI->s_signal;
761 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
762 * (until this returns true, a user will block in the waiting state, waiting to connect up to the
763 * registration timeout maximum seconds)
765 bool InspIRCd::AllModulesReportReady(User* user)
767 for (EventHandlerIter i = Modules->EventHandlers[I_OnCheckReady].begin(); i != Modules->EventHandlers[I_OnCheckReady].end(); ++i)
769 if (!(*i)->OnCheckReady(user))
775 time_t InspIRCd::Time()
780 void InspIRCd::SetSignal(int signal)