2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2012 William Pitcock <nenolod@dereferenced.org>
5 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
6 * Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2008 Uli Schlachter <psychon@znc.in>
8 * Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
9 * Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
10 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
11 * Copyright (C) 2007 Burlex <???@???>
12 * Copyright (C) 2003 Craig McLure <craig@chatspike.net>
13 * Copyright (C) 2003 randomdan <???@???>
15 * This file is part of InspIRCd. InspIRCd is free software: you can
16 * redistribute it and/or modify it under the terms of the GNU General Public
17 * License as published by the Free Software Foundation, version 2.
19 * This program is distributed in the hope that it will be useful, but WITHOUT
20 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
35 #include <sys/resource.h>
39 /* Some systems don't define RUSAGE_SELF. This should fix them. */
44 #include <pwd.h> // setuid
45 #include <grp.h> // setgid
47 WORD g_wOriginalColors;
48 WORD g_wBackgroundColor;
56 #include "socketengine.h"
58 #include "command_parse.h"
59 #include "exitcodes.h"
61 #include "testsuite.h"
63 InspIRCd* ServerInstance = NULL;
65 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
68 * This is provided as a pointer so that modules can change it to their custom mapping tables,
69 * e.g. for national character support.
71 unsigned const char *national_case_insensitive_map = rfc_case_insensitive_map;
74 /* Moved from exitcodes.h -- due to duplicate symbols -- Burlex
75 * XXX this is a bit ugly. -- w00t
77 const char* ExitCodes[] =
81 "Config file error", // 2
83 "POSIX fork failed", // 4
84 "Bad commandline parameters", // 5
85 "Can't write PID file", // 6
86 "SocketEngine could not initialize", // 7
87 "Refusing to start up as root", // 8
88 "Couldn't load module on startup", // 9
89 "Received SIGTERM" // 10
92 #ifdef INSPIRCD_ENABLE_TESTSUITE
93 /** True if we have been told to run the testsuite from the commandline,
94 * rather than entering the mainloop.
96 static int do_testsuite = 0;
99 template<typename T> static void DeleteZero(T*&n)
106 void InspIRCd::Cleanup()
108 // Close all listening sockets
109 for (unsigned int i = 0; i < ports.size(); i++)
116 /* Close all client sockets, or the new process inherits them */
117 LocalUserList& list = Users->local_users;
118 for (LocalUserList::iterator i = list.begin(); i != list.end(); ++i)
119 Users->QuitUser(*i, "Server shutdown");
122 Modules->UnloadAll();
124 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
125 /* Must be deleted before modes as it decrements modelines */
128 delete FakeClient->server;
131 DeleteZero(this->FakeClient);
132 DeleteZero(this->Users);
133 DeleteZero(this->Modes);
134 DeleteZero(this->XLines);
135 DeleteZero(this->Parser);
136 DeleteZero(this->stats);
137 DeleteZero(this->Modules);
138 DeleteZero(this->BanCache);
139 DeleteZero(this->SNO);
140 DeleteZero(this->Config);
141 DeleteZero(this->chanlist);
142 DeleteZero(this->PI);
143 DeleteZero(this->Threads);
144 DeleteZero(this->Timers);
145 SocketEngine::Deinit();
147 DeleteZero(this->Logs);
150 void InspIRCd::SetSignals()
153 signal(SIGALRM, SIG_IGN);
154 signal(SIGHUP, InspIRCd::SetSignal);
155 signal(SIGPIPE, SIG_IGN);
156 signal(SIGCHLD, SIG_IGN);
157 /* We want E2BIG not a signal! */
158 signal(SIGXFSZ, SIG_IGN);
160 signal(SIGTERM, InspIRCd::SetSignal);
163 void InspIRCd::QuickExit(int status)
168 // Required for returning the proper value of EXIT_SUCCESS for the parent process
169 static void VoidSignalHandler(int signalreceived)
174 bool InspIRCd::DaemonSeed()
177 std::cout << "InspIRCd Process ID: " << con_green << GetCurrentProcessId() << con_reset << std::endl;
180 // Do not use QuickExit here: It will exit with status SIGTERM which would break e.g. daemon scripts
181 signal(SIGTERM, VoidSignalHandler);
183 int childpid = fork();
186 else if (childpid > 0)
188 /* We wait here for the child process to kill us,
189 * so that the shell prompt doesnt come back over
191 * Sending a kill with a signal of 0 just checks
192 * if the child pid is still around. If theyre not,
193 * they threw an error and we should give up.
195 while (kill(childpid, 0) != -1)
200 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
202 signal(SIGTERM, InspIRCd::SetSignal);
205 if (getrlimit(RLIMIT_CORE, &rl) == -1)
207 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to getrlimit()!");
210 rl.rlim_cur = rl.rlim_max;
212 if (setrlimit(RLIMIT_CORE, &rl) == -1)
213 this->Logs->Log("STARTUP", LOG_DEFAULT, "setrlimit() failed, cannot increase coredump size.");
219 void InspIRCd::WritePID(const std::string &filename)
222 std::string fname(filename);
224 fname = ServerInstance->Config->Paths.PrependData("inspircd.pid");
225 std::ofstream outfile(fname.c_str());
226 if (outfile.is_open())
233 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
234 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s', exiting.",fname.c_str());
235 Exit(EXIT_STATUS_PID);
240 InspIRCd::InspIRCd(int argc, char** argv) :
241 ConfigFileName(CONFIG_PATH "/inspircd.conf"),
243 /* Functor pointer initialisation.
245 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
246 * themselves within the class.
248 OperQuit("operquit", NULL),
249 GenRandom(&HandleGenRandom),
250 IsChannel(&HandleIsChannel),
251 IsNick(&HandleIsNick),
252 IsIdent(&HandleIsIdent),
253 OnCheckExemption(&HandleOnCheckExemption)
255 ServerInstance = this;
257 Extensions.Register(&OperQuit);
260 // Flag variables passed to getopt_long() later
261 int do_version = 0, do_nofork = 0, do_debug = 0,
262 do_nolog = 0, do_root = 0;
264 // Initialize so that if we exit before proper initialization they're not deleted
279 this->ConfigThread = NULL;
280 this->FakeClient = NULL;
283 this->startup_time = TIME.tv_sec;
285 // This must be created first, so other parts of Insp can use it while starting up
286 this->Logs = new LogManager;
288 SocketEngine::Init();
290 this->Threads = new ThreadEngine;
292 /* Default implementation does nothing */
293 this->PI = new ProtocolInterface;
295 // Create base manager classes early, so nothing breaks
296 this->Users = new UserManager;
298 this->chanlist = new chan_hash();
300 this->Config = new ServerConfig;
301 this->SNO = new SnomaskManager;
302 this->BanCache = new BanCacheManager;
303 this->Modules = new ModuleManager();
304 dynamic_reference_base::reset_all();
305 this->stats = new serverstats();
306 this->Timers = new TimerManager;
307 this->Parser = new CommandParser;
308 this->XLines = new XLineManager;
310 this->Config->cmdline.argv = argv;
311 this->Config->cmdline.argc = argc;
314 srand(TIME.tv_nsec ^ TIME.tv_sec);
316 // Initialize the console values
317 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
318 CONSOLE_SCREEN_BUFFER_INFO bufinf;
319 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
321 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
322 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
326 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
327 g_wBackgroundColor = 0;
330 srandom(TIME.tv_nsec ^ TIME.tv_sec);
333 struct option longopts[] =
335 { "nofork", no_argument, &do_nofork, 1 },
336 { "config", required_argument, NULL, 'c' },
337 { "debug", no_argument, &do_debug, 1 },
338 { "nolog", no_argument, &do_nolog, 1 },
339 { "runasroot", no_argument, &do_root, 1 },
340 { "version", no_argument, &do_version, 1 },
341 #ifdef INSPIRCD_ENABLE_TESTSUITE
342 { "testsuite", no_argument, &do_testsuite, 1 },
349 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
354 /* Config filename was set */
355 ConfigFileName = ServerInstance->Config->Paths.PrependConfig(optarg);
358 /* getopt_long_only() set an int variable, just keep going */
361 /* Unknown parameter */
363 /* Fall through to handle other weird values too */
364 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
365 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--debug] [--config <config>]" << std::endl <<
366 std::string(static_cast<int>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
367 Exit(EXIT_STATUS_ARGV);
372 #ifdef INSPIRCD_ENABLE_TESTSUITE
374 do_nofork = do_debug = true;
379 std::cout << std::endl << VERSION << " " << REVISION << std::endl;
380 Exit(EXIT_STATUS_NOERROR);
386 WSAStartup(MAKEWORD(2,2), &wsadata);
389 /* Set the finished argument values */
390 Config->cmdline.nofork = (do_nofork != 0);
391 Config->cmdline.forcedebug = (do_debug != 0);
392 Config->cmdline.writelog = (!do_nolog != 0);
396 FileWriter* fw = new FileWriter(stdout);
397 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
398 Logs->AddLogTypes("*", fls, true);
401 if (!FileSystem::FileExists(ConfigFileName))
404 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
405 std::string txtconf = this->ConfigFileName;
406 txtconf.append(".txt");
408 if (FileSystem::FileExists(txtconf))
410 ConfigFileName = txtconf;
415 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
416 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
417 Exit(EXIT_STATUS_CONFIG);
421 std::cout << con_green << "Inspire Internet Relay Chat Server" << con_reset << ", compiled on " __DATE__ " at " __TIME__ << std::endl;
422 std::cout << con_green << "(C) InspIRCd Development Team." << con_reset << std::endl << std::endl;
423 std::cout << "Developers:" << std::endl;
424 std::cout << con_green << "\tBrain, FrostyCoolSlug, w00t, Om, Special, peavey" << std::endl;
425 std::cout << "\taquanight, psychon, dz, danieldg, jackmcbarn" << std::endl;
426 std::cout << "\tAttila" << con_reset << std::endl << std::endl;
427 std::cout << "Others:\t\t\t" << con_green << "See /INFO Output" << con_reset << std::endl;
429 this->Modes = new ModeParser;
436 std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
437 << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
438 << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
439 << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
440 << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
441 << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
442 << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
443 << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
450 if (!Config->cmdline.nofork)
452 if (!this->DaemonSeed())
454 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
455 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
456 Exit(EXIT_STATUS_FORK);
460 SocketEngine::RecoverFromFork();
462 /* During startup we read the configuration now, not in
465 this->Config->Read();
466 this->Config->Apply(NULL, "");
467 Logs->OpenFileLogs();
468 ModeParser::InitBuiltinModes();
470 // If we don't have a SID, generate one based on the server name and the server description
471 if (Config->sid.empty())
472 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
474 // Initialize the UID generator with our sid
475 this->UIDGen.init(Config->sid);
477 // Create the server user for this server
478 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
480 // This is needed as all new XLines are marked pending until ApplyLines() is called
481 this->XLines->ApplyLines();
483 int bounditems = BindPorts(pl);
485 std::cout << std::endl;
487 this->Modules->LoadAll();
489 // Build ISupport as ModuleManager::LoadAll() does not do it
490 this->ISupport.Build();
491 Config->ApplyDisabledCommands(Config->DisabledCommands);
495 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
496 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
497 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
499 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
501 std::cout << j << ".\tAddress: " << (i->first.empty() ? "<all>" : i->first) << " \tReason: " << i->second << std::endl;
504 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
507 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
510 if (!Config->cmdline.nofork)
512 if (kill(getppid(), SIGTERM) == -1)
514 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
515 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
519 /* Explicitly shut down stdio's stdin/stdout/stderr.
521 * The previous logic here was to only do this if stdio was connected to a controlling
522 * terminal. However, we must do this always to avoid information leaks and other
523 * problems related to stdio.
525 * The only exception is if we are in debug mode.
529 if ((!do_nofork) && (!Config->cmdline.forcedebug))
531 int fd = open("/dev/null", O_RDWR);
537 if (dup2(fd, STDIN_FILENO) < 0)
538 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
539 if (dup2(fd, STDOUT_FILENO) < 0)
540 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
541 if (dup2(fd, STDERR_FILENO) < 0)
542 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
547 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
550 /* Set win32 service as running, if we are running as a service */
559 QueryPerformanceFrequency(&stats->QPFrequency);
562 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
565 std::string SetUser = Config->ConfValue("security")->getString("runasuser");
566 std::string SetGroup = Config->ConfValue("security")->getString("runasgroup");
567 if (!SetGroup.empty())
572 ret = setgroups(0, NULL);
576 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
584 g = getgrnam(SetGroup.c_str());
588 this->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
592 ret = setgid(g->gr_gid);
596 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgid() failed (wrong group?): %s", strerror(errno));
601 if (!SetUser.empty())
607 u = getpwnam(SetUser.c_str());
611 this->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
615 int ret = setuid(u->pw_uid);
619 this->Logs->Log("STARTUP", LOG_DEFAULT, "setuid() failed (wrong user?): %s", strerror(errno));
624 this->WritePID(Config->PID);
628 void InspIRCd::UpdateTime()
634 TIME.tv_sec = time(NULL);
635 TIME.tv_nsec = st.wMilliseconds;
637 #ifdef HAS_CLOCK_GETTIME
638 clock_gettime(CLOCK_REALTIME, &TIME);
641 gettimeofday(&tv, NULL);
642 TIME.tv_sec = tv.tv_sec;
643 TIME.tv_nsec = tv.tv_usec * 1000;
650 #ifdef INSPIRCD_ENABLE_TESTSUITE
651 /* See if we're supposed to be running the test suite rather than entering the mainloop */
654 TestSuite* ts = new TestSuite;
661 time_t OLDTIME = TIME.tv_sec;
669 /* Check if there is a config thread which has finished executing but has not yet been freed */
670 if (this->ConfigThread && this->ConfigThread->IsDone())
672 /* Rehash has completed */
673 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
675 this->ConfigThread->Finish();
677 ConfigThread->join();
684 /* Run background module timers every few seconds
685 * (the docs say modules shouldnt rely on accurate
686 * timing using this event, so we dont have to
687 * time this exactly).
689 if (TIME.tv_sec != OLDTIME)
692 getrusage(RUSAGE_SELF, &ru);
693 stats->LastSampled = TIME;
694 stats->LastCPU = ru.ru_utime;
696 if(QueryPerformanceCounter(&stats->LastSampled))
698 FILETIME CreationTime;
702 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
703 stats->LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
704 stats->LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
708 /* Allow a buffer of two seconds drift on this so that ntpdate etc dont harass admins */
709 if (TIME.tv_sec < OLDTIME - 2)
711 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)OLDTIME-TIME.tv_sec);
713 else if (TIME.tv_sec > OLDTIME + 2)
715 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is jumping FORWARDS! Clock skipped %lu secs.", (unsigned long)TIME.tv_sec - OLDTIME);
718 OLDTIME = TIME.tv_sec;
720 if ((TIME.tv_sec % 3600) == 0)
722 Users->GarbageCollect();
723 FOREACH_MOD(OnGarbageCollect, ());
726 Timers->TickTimers(TIME.tv_sec);
727 Users->DoBackgroundUserStuff();
729 if ((TIME.tv_sec % 5) == 0)
731 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
732 SNO->FlushSnotices();
736 /* Call the socket engine to wait on the active
737 * file descriptors. The socket engine has everything's
738 * descriptors in its list... dns, modules, users,
739 * servers... so its nice and easy, just one call.
740 * This will cause any read or write events to be
741 * dispatched to their handlers.
743 SocketEngine::DispatchTrialWrites();
744 SocketEngine::DispatchEvents();
746 /* if any users were quit, take them out */
752 this->SignalHandler(s_signal);
758 sig_atomic_t InspIRCd::s_signal = 0;
760 void InspIRCd::SetSignal(int signal)
765 /* On posix systems, the flow of the program starts right here, with
766 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
767 * defines smain() and the real main() is in the service code under
768 * win32service.cpp. This allows the service control manager to control
769 * the process where we are running as a windows service.
773 new InspIRCd(argc, argv);
774 ServerInstance->Run();
775 delete ServerInstance;