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 /* w00t was here. ;p */
16 /* $Install: src/inspircd $(BINPATH) */
23 #include <sys/resource.h>
27 /* Some systems don't define RUSAGE_SELF. This should fix them. */
32 /* CRT memory debugging */
34 #define _CRTDBG_MAP_ALLOC
39 #include <pwd.h> // setuid
40 #include <grp.h> // setgid
46 #include "socketengine.h"
47 #include "inspircd_se_config.h"
49 #include "command_parse.h"
50 #include "exitcodes.h"
52 #include "testsuite.h"
58 /* Moved from exitcodes.h -- due to duplicate symbols -- Burlex
59 * XXX this is a bit ugly. -- w00t
61 const char* ExitCodes[] =
64 "DIE command", /* 1 */
65 "execv() failed", /* 2 */
66 "Internal error", /* 3 */
67 "Config file error", /* 4 */
68 "Logfile error", /* 5 */
69 "POSIX fork failed", /* 6 */
70 "Bad commandline parameters", /* 7 */
71 "No ports could be bound", /* 8 */
72 "Can't write PID file", /* 9 */
73 "SocketEngine could not initialize", /* 10 */
74 "Refusing to start up as root", /* 11 */
75 "Found a <die> tag!", /* 12 */
76 "Couldn't load module on startup", /* 13 */
77 "Could not create windows forked process", /* 14 */
78 "Received SIGTERM", /* 15 */
79 "Bad command handler loaded", /* 16 */
80 "RegisterServiceCtrlHandler failed", /* 17 */
81 "UpdateSCMStatus failed", /* 18 */
82 "CreateEvent failed" /* 19 */
85 void InspIRCd::Cleanup()
89 for (unsigned int i = 0; i < Config->ports.size(); i++)
91 /* This calls the constructor and closes the listening socket */
92 delete Config->ports[i];
95 Config->ports.clear();
98 /* Close all client sockets, or the new process inherits them */
99 for (std::vector<User*>::const_iterator i = this->Users->local_users.begin(); i != this->Users->local_users.end(); i++)
101 this->Users->QuitUser((*i), "Server shutdown");
105 /* We do this more than once, so that any service providers get a
106 * chance to be unhooked by the modules using them, but then get
107 * a chance to be removed themsleves.
109 * XXX there may be a better way to do this with 1.2
111 for (int tries = 0; tries < 3; tries++)
113 std::vector<std::string> module_names = Modules->GetAllModuleNames(0);
114 for (std::vector<std::string>::iterator k = module_names.begin(); k != module_names.end(); ++k)
116 /* Unload all modules, so they get a chance to clean up their listeners */
117 this->Modules->Unload(k->c_str());
120 /* Remove core commands */
121 Parser->RemoveCommands("<core>");
123 /* Cleanup Server Names */
124 for(servernamelist::iterator itr = servernames.begin(); itr != servernames.end(); ++itr)
127 /* Delete objects dynamically allocated in constructor
128 * (destructor would be more appropriate, but we're likely exiting)
131 // Must be deleted before modes as it decrements modelines
163 delete this->Modules;
168 delete this->BanCache;
204 delete this->Threads;
208 /* Needs to be deleted after Res, DNS has a timer */
216 this->Logs->CloseLogs();
224 delete RehashFinishMutex;
227 void InspIRCd::Restart(const std::string &reason)
229 /* SendError flushes each client's queue,
230 * regardless of writeability state
232 this->SendError(reason);
234 /* Figure out our filename (if theyve renamed it, we're boned) */
238 char module[MAX_PATH];
239 if (GetModuleFileName(NULL, module, MAX_PATH))
242 me = Config->MyDir + "/inspircd";
245 char** argv = Config->argv;
249 if (execv(me.c_str(), argv) == -1)
251 /* Will raise a SIGABRT if not trapped */
252 throw CoreException(std::string("Failed to execv()! error: ") + strerror(errno));
256 void InspIRCd::ResetMaxBans()
258 for (chan_hash::const_iterator i = chanlist->begin(); i != chanlist->end(); i++)
259 i->second->ResetMaxBans();
262 /** Because hash_map doesnt free its buckets when we delete items (this is a 'feature')
263 * we must occasionally rehash the hash (yes really).
264 * We do this by copying the entries from the old hash to a new hash, causing all
265 * empty buckets to be weeded out of the hash. We dont do this on a timer, as its
266 * very expensive, so instead we do it when the user types /REHASH and expects a
267 * short delay anyway.
269 void InspIRCd::RehashUsersAndChans()
271 user_hash* old_users = this->Users->clientlist;
272 user_hash* old_uuid = this->Users->uuidlist;
273 chan_hash* old_chans = this->chanlist;
275 this->Users->clientlist = new user_hash();
276 this->Users->uuidlist = new user_hash();
277 this->chanlist = new chan_hash();
279 for (user_hash::const_iterator n = old_users->begin(); n != old_users->end(); n++)
280 this->Users->clientlist->insert(*n);
284 for (user_hash::const_iterator n = old_uuid->begin(); n != old_uuid->end(); n++)
285 this->Users->uuidlist->insert(*n);
289 for (chan_hash::const_iterator n = old_chans->begin(); n != old_chans->end(); n++)
290 this->chanlist->insert(*n);
295 void InspIRCd::SetSignals()
298 signal(SIGALRM, SIG_IGN);
299 signal(SIGHUP, InspIRCd::SetSignal);
300 signal(SIGPIPE, SIG_IGN);
301 signal(SIGCHLD, SIG_IGN);
303 signal(SIGTERM, InspIRCd::SetSignal);
306 void InspIRCd::QuickExit(int status)
311 bool InspIRCd::DaemonSeed()
314 printf_c("InspIRCd Process ID: \033[1;32m%lu\033[0m\n", GetCurrentProcessId());
317 signal(SIGTERM, InspIRCd::QuickExit);
320 if ((childpid = fork ()) < 0)
322 else if (childpid > 0)
324 /* We wait here for the child process to kill us,
325 * so that the shell prompt doesnt come back over
327 * Sending a kill with a signal of 0 just checks
328 * if the child pid is still around. If theyre not,
329 * they threw an error and we should give up.
331 while (kill(childpid, 0) != -1)
337 printf("InspIRCd Process ID: \033[1;32m%lu\033[0m\n",(unsigned long)getpid());
339 signal(SIGTERM, InspIRCd::SetSignal);
342 if (getrlimit(RLIMIT_CORE, &rl) == -1)
344 this->Logs->Log("STARTUP",DEFAULT,"Failed to getrlimit()!");
349 rl.rlim_cur = rl.rlim_max;
350 if (setrlimit(RLIMIT_CORE, &rl) == -1)
351 this->Logs->Log("STARTUP",DEFAULT,"setrlimit() failed, cannot increase coredump size.");
358 void InspIRCd::WritePID(const std::string &filename)
360 std::string fname = (filename.empty() ? "inspircd.pid" : filename);
361 std::replace(fname.begin(), fname.end(), '\\', '/');
362 if ((fname[0] != '/') && (!Config->StartsWithWindowsDriveLetter(filename)))
364 std::string::size_type pos;
365 std::string confpath = this->ConfigFileName;
366 if ((pos = confpath.rfind("/")) != std::string::npos)
368 /* Leaves us with just the path */
369 fname = confpath.substr(0, pos) + std::string("/") + fname;
372 std::ofstream outfile(fname.c_str());
373 if (outfile.is_open())
380 printf("Failed to write PID-file '%s', exiting.\n",fname.c_str());
381 this->Logs->Log("STARTUP",DEFAULT,"Failed to write PID-file '%s', exiting.",fname.c_str());
382 Exit(EXIT_STATUS_PID);
386 InspIRCd::InspIRCd(int argc, char** argv)
389 /* Functor initialisation. Note that the ordering here is very important.
391 * THIS MUST MATCH ORDER OF DECLARATION OF THE HandleWhateverFunc classes
392 * within class InspIRCd.
394 HandleProcessUser(this),
397 HandleFindDescriptor(this),
398 HandleFloodQuitUser(this),
399 HandleIsChannel(this),
403 /* Functor pointer initialisation. Must match the order of the list above
405 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
406 * themselves within the class.
408 ProcessUser(&HandleProcessUser),
409 IsChannel(&HandleIsChannel),
411 Rehash(&HandleRehash),
412 IsNick(&HandleIsNick),
413 IsIdent(&HandleIsIdent),
414 FindDescriptor(&HandleFindDescriptor),
415 FloodQuitUser(&HandleFloodQuitUser)
419 // Strict, frequent checking of memory on debug builds
420 _CrtSetDbgFlag ( _CRTDBG_CHECK_ALWAYS_DF | _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
422 // Avoid erroneous frees on early exit
427 int do_version = 0, do_nofork = 0, do_debug = 0,
428 do_nolog = 0, do_root = 0, do_testsuite = 0; /* flag variables */
431 // Initialize so that if we exit before proper initialization they're not deleted
449 this->TIME = time(NULL);
451 memset(&server, 0, sizeof(server));
452 memset(&client, 0, sizeof(client));
454 // This must be created first, so other parts of Insp can use it while starting up
455 this->Logs = new LogManager(this);
457 SocketEngineFactory* SEF = new SocketEngineFactory();
458 SE = SEF->Create(this);
461 ThreadEngineFactory* tef = new ThreadEngineFactory();
462 this->Threads = tef->Create(this);
464 this->Mutexes = new MutexFactory(this);
466 /* Default implementation does nothing */
467 this->PI = new ProtocolInterface(this);
471 // Create base manager classes early, so nothing breaks
472 this->Users = new UserManager(this);
474 this->Users->unregistered_count = 0;
476 this->Users->clientlist = new user_hash();
477 this->Users->uuidlist = new user_hash();
478 this->chanlist = new chan_hash();
480 this->Config = new ServerConfig(this);
481 this->SNO = new SnomaskManager(this);
482 this->BanCache = new BanCacheManager(this);
483 this->Modules = new ModuleManager(this);
484 this->stats = new serverstats();
485 this->Timers = new TimerManager(this);
486 this->Parser = new CommandParser(this);
487 this->XLines = new XLineManager(this);
489 this->Config->argv = argv;
490 this->Config->argc = argc;
492 if (chdir(Config->GetFullProgDir().c_str()))
494 printf("Unable to change to my directory: %s\nAborted.", strerror(errno));
498 this->Config->opertypes.clear();
499 this->Config->operclass.clear();
501 this->TIME = this->OLDTIME = this->startup_time = time(NULL);
504 *this->LogFileName = 0;
505 strlcpy(this->ConfigFileName, CONFIG_FILE, MAXBUF);
507 struct option longopts[] =
509 { "nofork", no_argument, &do_nofork, 1 },
510 { "logfile", required_argument, NULL, 'f' },
511 { "config", required_argument, NULL, 'c' },
512 { "debug", no_argument, &do_debug, 1 },
513 { "nolog", no_argument, &do_nolog, 1 },
514 { "runasroot", no_argument, &do_root, 1 },
515 { "version", no_argument, &do_version, 1 },
516 { "testsuite", no_argument, &do_testsuite, 1 },
520 while ((c = getopt_long_only(argc, argv, ":f:", longopts, NULL)) != -1)
525 /* Log filename was set */
526 strlcpy(LogFileName, optarg, MAXBUF);
529 /* Config filename was set */
530 strlcpy(ConfigFileName, optarg, MAXBUF);
533 /* getopt_long_only() set an int variable, just keep going */
536 /* Unknown parameter! DANGER, INTRUDER.... err.... yeah. */
537 printf("Usage: %s [--nofork] [--nolog] [--debug] [--logfile <filename>]\n\
538 [--runasroot] [--version] [--config <config>] [--testsuite]\n", argv[0]);
539 Exit(EXIT_STATUS_ARGV);
545 do_nofork = do_debug = true;
549 printf("\n%s r%s\n", VERSION, REVISION);
550 Exit(EXIT_STATUS_NOERROR);
558 DWORD ExitCode = WindowsForkStart(this);
565 WSAStartup(MAKEWORD(2,0), &wsadata);
566 ChangeWindowsSpecificPointers(this);
568 strlcpy(Config->MyExecutable,argv[0],MAXBUF);
570 /* Set the finished argument values */
571 Config->nofork = do_nofork;
572 Config->forcedebug = do_debug;
573 Config->writelog = !do_nolog;
574 Config->TestSuite = do_testsuite;
576 if (!this->OpenLog(argv, argc))
578 printf("ERROR: Could not open logfile %s: %s\n\n", Config->logpath.c_str(), strerror(errno));
579 Exit(EXIT_STATUS_LOG);
582 if (!ServerConfig::FileExists(this->ConfigFileName))
584 printf("ERROR: Cannot open config file: %s\nExiting...\n", this->ConfigFileName);
585 this->Logs->Log("STARTUP",DEFAULT,"Unable to open config file %s", this->ConfigFileName);
586 Exit(EXIT_STATUS_CONFIG);
589 printf_c("\033[1;32mInspire Internet Relay Chat Server, compiled %s at %s\n",__DATE__,__TIME__);
590 printf_c("(C) InspIRCd Development Team.\033[0m\n\n");
591 printf_c("Developers:\n");
592 printf_c("\t\033[1;32mBrain, FrostyCoolSlug, w00t, Om, Special\n");
593 printf_c("\t\033[1;32mpippijn, peavey, aquanight, fez, psychon, dz\033[0m\n\n");
594 printf_c("Others:\t\t\t\033[1;32mSee /INFO Output\033[0m\n");
596 Config->ClearStack();
598 this->Modes = new ModeParser(this);
604 printf("* WARNING * WARNING * WARNING * WARNING * WARNING * \n\n");
605 printf("YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED\n");
606 printf("AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED\n");
607 printf("OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR\n");
608 printf("SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN\n");
609 printf("TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART\n");
610 printf("THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!\n");
611 printf("\nInspIRCd starting in 20 seconds, ctrl+c to abort...\n");
619 if (!this->DaemonSeed())
621 printf("ERROR: could not go into daemon mode. Shutting down.\n");
622 Logs->Log("STARTUP", DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
623 Exit(EXIT_STATUS_FORK);
627 SE->RecoverFromFork();
629 /* During startup we don't actually initialize this
630 * in the thread engine.
632 this->ConfigThread = new ConfigReaderThread(this, true, "");
635 this->ConfigThread = NULL;
636 /* Switch over logfiles */
637 Logs->OpenFileLogs();
639 /** Note: This is safe, the method checks for user == NULL */
640 this->Parser->SetupCommandTable();
642 this->Res = new DNS(this);
644 this->AddServerName(Config->ServerName);
647 * Initialise SID/UID.
648 * For an explanation as to exactly how this works, and why it works this way, see GetUID().
656 for (const char* x = Config->ServerName; *x; ++x)
658 for (const char* y = Config->ServerDesc; *y; ++y)
662 Config->sid[0] = (char)(sid / 100 + 48);
663 Config->sid[1] = (char)(((sid / 10) % 10) + 48);
664 Config->sid[2] = (char)(sid % 10 + 48);
665 Config->sid[3] = '\0';
668 /* set up fake client again this time with the correct uid */
669 this->FakeClient = new User(this, "#INVALID");
670 this->FakeClient->SetFd(FD_MAGIC_NUMBER);
672 // Get XLine to do it's thing.
673 this->XLines->CheckELines();
674 this->XLines->ApplyLines();
677 int bounditems = BindPorts(true, found_ports, pl);
681 this->Modules->LoadAll();
683 /* Just in case no modules were loaded - fix for bug #101 */
684 this->BuildISupport();
685 InitializeDisabledCommands(Config->DisabledCommands, this);
687 if (Config->ports.size() != (unsigned int)found_ports)
689 printf("\nWARNING: Not all your client ports could be bound --\nstarting anyway with %d of %d client ports bound.\n\n", bounditems, found_ports);
690 printf("The following port(s) failed to bind:\n");
691 printf("Hint: Try using a public IP instead of blank or *\n\n");
693 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
695 printf("%d.\tAddress: %s\tReason: %s\n", j, i->first.empty() ? "<all>" : i->first.c_str(), i->second.c_str());
699 printf("\nInspIRCd is now running as '%s'[%s] with %d max open sockets\n", Config->ServerName,Config->GetSID().c_str(), SE->GetMaxFds());
704 if (kill(getppid(), SIGTERM) == -1)
706 printf("Error killing parent process: %s\n",strerror(errno));
707 Logs->Log("STARTUP", DEFAULT, "Error killing parent process: %s",strerror(errno));
711 if (isatty(0) && isatty(1) && isatty(2))
713 /* We didn't start from a TTY, we must have started from a background process -
714 * e.g. we are restarting, or being launched by cron. Dont kill parent, and dont
717 if ((!do_nofork) && (!do_testsuite))
725 Logs->Log("STARTUP", DEFAULT,"Keeping pseudo-tty open as we are running in the foreground.");
729 WindowsIPC = new IPC(this);
732 WindowsForkKillOwner(this);
735 /* Set win32 service as running, if we are running as a service */
739 Logs->Log("STARTUP", DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName,Config->GetSID().c_str(), SE->GetMaxFds());
742 if (*(this->Config->SetGroup))
747 ret = setgroups(0, NULL);
751 this->Logs->Log("SETGROUPS", DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
759 g = getgrnam(this->Config->SetGroup);
763 this->Logs->Log("SETGUID", DEFAULT, "getgrnam() failed (bad user?): %s", strerror(errno));
767 ret = setgid(g->gr_gid);
771 this->Logs->Log("SETGUID", DEFAULT, "setgid() failed (bad user?): %s", strerror(errno));
776 if (*(this->Config->SetUser))
782 u = getpwnam(this->Config->SetUser);
786 this->Logs->Log("SETGUID", DEFAULT, "getpwnam() failed (bad user?): %s", strerror(errno));
790 int ret = setuid(u->pw_uid);
794 this->Logs->Log("SETGUID", DEFAULT, "setuid() failed (bad user?): %s", strerror(errno));
800 this->WritePID(Config->PID);
805 /* See if we're supposed to be running the test suite rather than entering the mainloop */
806 if (Config->TestSuite)
808 TestSuite* ts = new TestSuite(this);
813 RehashFinishMutex = Mutexes->CreateMutex();
820 static time_t uptime;
821 static struct tm * stime;
822 static char window_title[100];
825 /* Check if there is a config thread which has finished executing but has not yet been freed */
826 RehashFinishMutex->Lock();
827 if (this->ConfigThread && this->ConfigThread->GetExitFlag())
829 /* Rehash has completed */
831 /* Switch over logfiles */
833 Logs->OpenFileLogs();
835 this->Logs->Log("CONFIG",DEBUG,"Detected ConfigThread exiting, tidying up...");
837 /* These are currently not known to be threadsafe, so they are executed outside
838 * of the thread. It would be pretty simple to move them to the thread Run method
839 * once they are known threadsafe with all the correct mutexes in place. This might
840 * not be worth the effort however as these functions execute relatively quickly
841 * and would not benefit from being within the config read thread.
843 * XXX: The order of these is IMPORTANT, do not reorder them without testing
846 this->XLines->CheckELines();
847 this->XLines->ApplyLines();
849 this->ResetMaxBans();
850 InitializeDisabledCommands(Config->DisabledCommands, this);
851 User* user = !Config->RehashUserUID.empty() ? FindNick(Config->RehashUserUID) : NULL;
852 FOREACH_MOD_I(this, I_OnRehash, OnRehash(user, Config->RehashParameter));
853 this->BuildISupport();
855 /* IMPORTANT: This delete may hang if you fuck up your thread syncronization.
856 * It will hang waiting for the ConfigThread to 'join' to avoid race conditons,
857 * until the other thread is completed.
862 RehashFinishMutex->Unlock();
864 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
865 * Once per loop iteration is pleanty.
870 /* Run background module timers every few seconds
871 * (the docs say modules shouldnt rely on accurate
872 * timing using this event, so we dont have to
873 * time this exactly).
877 /* Allow a buffer of two seconds drift on this so that ntpdate etc dont harass admins */
878 if (TIME < OLDTIME - 2)
880 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)OLDTIME-TIME);
882 else if (TIME > OLDTIME + 2)
884 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is jumping FORWARDS! Clock skipped %lu secs.", (unsigned long)TIME - OLDTIME);
887 if ((TIME % 3600) == 0)
889 this->RehashUsersAndChans();
890 FOREACH_MOD_I(this, I_OnGarbageCollect, OnGarbageCollect());
893 Timers->TickTimers(TIME);
894 this->DoBackgroundUserStuff();
898 FOREACH_MOD_I(this,I_OnBackgroundTimer,OnBackgroundTimer(TIME));
899 SNO->FlushSnotices();
902 /* Same change as in cmd_stats.cpp, use RUSAGE_SELF rather than '0' -- Om */
903 if (!getrusage(RUSAGE_SELF, &ru))
905 gettimeofday(&this->stats->LastSampled, NULL);
906 this->stats->LastCPU = ru.ru_utime;
913 /* Call the socket engine to wait on the active
914 * file descriptors. The socket engine has everything's
915 * descriptors in its list... dns, modules, users,
916 * servers... so its nice and easy, just one call.
917 * This will cause any read or write events to be
918 * dispatched to their handlers.
920 this->SE->DispatchEvents();
922 /* if any users were quit, take them out */
923 this->GlobalCulls.Apply();
925 /* If any inspsockets closed, remove them */
926 this->BufferedSocketCull();
930 this->SignalHandler(s_signal);
938 void InspIRCd::BufferedSocketCull()
940 for (std::map<BufferedSocket*,BufferedSocket*>::iterator x = SocketCull.begin(); x != SocketCull.end(); ++x)
942 this->Logs->Log("MISC",DEBUG,"Cull socket");
943 SE->DelFd(x->second);
950 /**********************************************************************************/
953 * An ircd in five lines! bwahahaha. ahahahahaha. ahahah *cough*.
956 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
957 * (until this returns true, a user will block in the waiting state, waiting to connect up to the
958 * registration timeout maximum seconds)
960 bool InspIRCd::AllModulesReportReady(User* user)
962 for (EventHandlerIter i = Modules->EventHandlers[I_OnCheckReady].begin(); i != Modules->EventHandlers[I_OnCheckReady].end(); ++i)
964 if (!(*i)->OnCheckReady(user))
970 time_t InspIRCd::Time()
975 void InspIRCd::SetSignal(int signal)
980 /* On posix systems, the flow of the program starts right here, with
981 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
982 * defines smain() and the real main() is in the service code under
983 * win32service.cpp. This allows the service control manager to control
984 * the process where we are running as a windows service.
988 SI = new InspIRCd(argc, argv);
989 mysig = &SI->s_signal;