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;
55 #include "exitcodes.h"
56 #include "testsuite.h"
58 InspIRCd* ServerInstance = NULL;
60 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
63 * This is provided as a pointer so that modules can change it to their custom mapping tables,
64 * e.g. for national character support.
66 unsigned const char *national_case_insensitive_map = rfc_case_insensitive_map;
69 /* Moved from exitcodes.h -- due to duplicate symbols -- Burlex
70 * XXX this is a bit ugly. -- w00t
72 const char* ExitCodes[] =
76 "Config file error", // 2
78 "POSIX fork failed", // 4
79 "Bad commandline parameters", // 5
80 "Can't write PID file", // 6
81 "SocketEngine could not initialize", // 7
82 "Refusing to start up as root", // 8
83 "Couldn't load module on startup", // 9
84 "Received SIGTERM" // 10
87 #ifdef INSPIRCD_ENABLE_TESTSUITE
88 /** True if we have been told to run the testsuite from the commandline,
89 * rather than entering the mainloop.
91 static int do_testsuite = 0;
94 template<typename T> static void DeleteZero(T*&n)
101 void InspIRCd::Cleanup()
103 // Close all listening sockets
104 for (unsigned int i = 0; i < ports.size(); i++)
112 Modules->UnloadAll();
114 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
115 /* Must be deleted before modes as it decrements modelines */
118 delete FakeClient->server;
121 DeleteZero(this->FakeClient);
122 DeleteZero(this->XLines);
123 DeleteZero(this->Config);
124 SocketEngine::Deinit();
128 void InspIRCd::SetSignals()
131 signal(SIGALRM, SIG_IGN);
132 signal(SIGHUP, InspIRCd::SetSignal);
133 signal(SIGPIPE, SIG_IGN);
134 signal(SIGCHLD, SIG_IGN);
135 /* We want E2BIG not a signal! */
136 signal(SIGXFSZ, SIG_IGN);
138 signal(SIGTERM, InspIRCd::SetSignal);
141 void InspIRCd::QuickExit(int status)
146 // Required for returning the proper value of EXIT_SUCCESS for the parent process
147 static void VoidSignalHandler(int signalreceived)
152 bool InspIRCd::DaemonSeed()
155 std::cout << "InspIRCd Process ID: " << con_green << GetCurrentProcessId() << con_reset << std::endl;
158 // Do not use QuickExit here: It will exit with status SIGTERM which would break e.g. daemon scripts
159 signal(SIGTERM, VoidSignalHandler);
161 int childpid = fork();
164 else if (childpid > 0)
166 /* We wait here for the child process to kill us,
167 * so that the shell prompt doesnt come back over
169 * Sending a kill with a signal of 0 just checks
170 * if the child pid is still around. If theyre not,
171 * they threw an error and we should give up.
173 while (kill(childpid, 0) != -1)
178 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
180 signal(SIGTERM, InspIRCd::SetSignal);
183 if (getrlimit(RLIMIT_CORE, &rl) == -1)
185 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to getrlimit()!");
188 rl.rlim_cur = rl.rlim_max;
190 if (setrlimit(RLIMIT_CORE, &rl) == -1)
191 this->Logs->Log("STARTUP", LOG_DEFAULT, "setrlimit() failed, cannot increase coredump size.");
197 void InspIRCd::WritePID(const std::string& filename, bool exitonfail)
200 std::string fname(filename);
202 fname = ServerInstance->Config->Paths.PrependData("inspircd.pid");
203 std::ofstream outfile(fname.c_str());
204 if (outfile.is_open())
212 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
213 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s'%s", fname.c_str(), (exitonfail ? ", exiting." : ""));
215 Exit(EXIT_STATUS_PID);
220 InspIRCd::InspIRCd(int argc, char** argv) :
221 ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf"),
222 PI(&DefaultProtocolInterface),
224 /* Functor pointer initialisation.
226 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
227 * themselves within the class.
229 OperQuit("operquit", ExtensionItem::EXT_USER, NULL),
230 GenRandom(&HandleGenRandom),
231 IsChannel(&HandleIsChannel),
232 IsNick(&HandleIsNick),
233 IsIdent(&HandleIsIdent),
234 OnCheckExemption(&HandleOnCheckExemption)
236 ServerInstance = this;
238 Extensions.Register(&OperQuit);
241 // Flag variables passed to getopt_long() later
242 int do_version = 0, do_nofork = 0, do_debug = 0,
243 do_nolog = 0, do_root = 0;
245 // Initialize so that if we exit before proper initialization they're not deleted
248 this->ConfigThread = NULL;
249 this->FakeClient = NULL;
252 this->startup_time = TIME.tv_sec;
254 SocketEngine::Init();
256 this->Config = new ServerConfig;
257 dynamic_reference_base::reset_all();
258 this->XLines = new XLineManager;
260 this->Config->cmdline.argv = argv;
261 this->Config->cmdline.argc = argc;
264 srand(TIME.tv_nsec ^ TIME.tv_sec);
266 // Initialize the console values
267 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
268 CONSOLE_SCREEN_BUFFER_INFO bufinf;
269 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
271 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
272 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
276 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
277 g_wBackgroundColor = 0;
280 srandom(TIME.tv_nsec ^ TIME.tv_sec);
283 struct option longopts[] =
285 { "nofork", no_argument, &do_nofork, 1 },
286 { "config", required_argument, NULL, 'c' },
287 { "debug", no_argument, &do_debug, 1 },
288 { "nolog", no_argument, &do_nolog, 1 },
289 { "runasroot", no_argument, &do_root, 1 },
290 { "version", no_argument, &do_version, 1 },
291 #ifdef INSPIRCD_ENABLE_TESTSUITE
292 { "testsuite", no_argument, &do_testsuite, 1 },
299 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
304 /* Config filename was set */
305 ConfigFileName = ServerInstance->Config->Paths.PrependConfig(optarg);
308 /* getopt_long_only() set an int variable, just keep going */
311 /* Unknown parameter */
313 /* Fall through to handle other weird values too */
314 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
315 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--debug] [--config <config>]" << std::endl <<
316 std::string(static_cast<int>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
317 Exit(EXIT_STATUS_ARGV);
322 #ifdef INSPIRCD_ENABLE_TESTSUITE
324 do_nofork = do_debug = true;
329 std::cout << std::endl << INSPIRCD_VERSION << std::endl;
330 Exit(EXIT_STATUS_NOERROR);
336 WSAStartup(MAKEWORD(2,2), &wsadata);
339 /* Set the finished argument values */
340 Config->cmdline.nofork = (do_nofork != 0);
341 Config->cmdline.forcedebug = (do_debug != 0);
342 Config->cmdline.writelog = !do_nolog;
346 FileWriter* fw = new FileWriter(stdout, 1);
347 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
348 Logs->AddLogTypes("*", fls, true);
351 if (!FileSystem::FileExists(ConfigFileName))
354 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
355 std::string txtconf = this->ConfigFileName;
356 txtconf.append(".txt");
358 if (FileSystem::FileExists(txtconf))
360 ConfigFileName = txtconf;
365 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
366 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
367 Exit(EXIT_STATUS_CONFIG);
371 std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << ", compiled on " __DATE__ " at " __TIME__ << std::endl;
372 std::cout << "For contributors & authors: " << con_green << "See /INFO Output" << con_reset << std::endl;
379 std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
380 << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
381 << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
382 << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
383 << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
384 << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
385 << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
386 << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
393 if (!Config->cmdline.nofork)
395 if (!this->DaemonSeed())
397 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
398 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
399 Exit(EXIT_STATUS_FORK);
403 SocketEngine::RecoverFromFork();
405 /* During startup we read the configuration now, not in
408 this->Config->Read();
409 this->Config->Apply(NULL, "");
410 Logs->OpenFileLogs();
411 ModeParser::InitBuiltinModes();
413 // If we don't have a SID, generate one based on the server name and the server description
414 if (Config->sid.empty())
415 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
417 // Initialize the UID generator with our sid
418 this->UIDGen.init(Config->sid);
420 // Create the server user for this server
421 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
423 // This is needed as all new XLines are marked pending until ApplyLines() is called
424 this->XLines->ApplyLines();
426 int bounditems = BindPorts(pl);
428 std::cout << std::endl;
430 this->Modules->LoadAll();
432 // Build ISupport as ModuleManager::LoadAll() does not do it
433 this->ISupport.Build();
434 Config->ApplyDisabledCommands(Config->DisabledCommands);
438 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
439 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
440 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
442 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
444 std::cout << j << ".\tAddress: " << (i->first.empty() ? "<all>" : i->first) << " \tReason: " << i->second << std::endl;
447 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
450 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
453 if (!Config->cmdline.nofork)
455 if (kill(getppid(), SIGTERM) == -1)
457 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
458 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
462 /* Explicitly shut down stdio's stdin/stdout/stderr.
464 * The previous logic here was to only do this if stdio was connected to a controlling
465 * terminal. However, we must do this always to avoid information leaks and other
466 * problems related to stdio.
468 * The only exception is if we are in debug mode.
472 if ((!do_nofork) && (!Config->cmdline.forcedebug))
474 int fd = open("/dev/null", O_RDWR);
480 if (dup2(fd, STDIN_FILENO) < 0)
481 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
482 if (dup2(fd, STDOUT_FILENO) < 0)
483 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
484 if (dup2(fd, STDERR_FILENO) < 0)
485 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
490 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
493 /* Set win32 service as running, if we are running as a service */
502 QueryPerformanceFrequency(&stats.QPFrequency);
505 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
508 std::string SetUser = Config->ConfValue("security")->getString("runasuser");
509 std::string SetGroup = Config->ConfValue("security")->getString("runasgroup");
510 if (!SetGroup.empty())
515 ret = setgroups(0, NULL);
519 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
527 g = getgrnam(SetGroup.c_str());
531 this->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
535 ret = setgid(g->gr_gid);
539 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgid() failed (wrong group?): %s", strerror(errno));
544 if (!SetUser.empty())
550 u = getpwnam(SetUser.c_str());
554 this->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
558 int ret = setuid(u->pw_uid);
562 this->Logs->Log("STARTUP", LOG_DEFAULT, "setuid() failed (wrong user?): %s", strerror(errno));
567 this->WritePID(Config->PID);
571 void InspIRCd::UpdateTime()
577 TIME.tv_sec = time(NULL);
578 TIME.tv_nsec = st.wMilliseconds;
580 #ifdef HAS_CLOCK_GETTIME
581 clock_gettime(CLOCK_REALTIME, &TIME);
584 gettimeofday(&tv, NULL);
585 TIME.tv_sec = tv.tv_sec;
586 TIME.tv_nsec = tv.tv_usec * 1000;
593 #ifdef INSPIRCD_ENABLE_TESTSUITE
594 /* See if we're supposed to be running the test suite rather than entering the mainloop */
597 TestSuite* ts = new TestSuite;
604 time_t OLDTIME = TIME.tv_sec;
612 /* Check if there is a config thread which has finished executing but has not yet been freed */
613 if (this->ConfigThread && this->ConfigThread->IsDone())
615 /* Rehash has completed */
616 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
618 this->ConfigThread->Finish();
620 ConfigThread->join();
627 /* Run background module timers every few seconds
628 * (the docs say modules shouldnt rely on accurate
629 * timing using this event, so we dont have to
630 * time this exactly).
632 if (TIME.tv_sec != OLDTIME)
635 getrusage(RUSAGE_SELF, &ru);
636 stats.LastSampled = TIME;
637 stats.LastCPU = ru.ru_utime;
639 if(QueryPerformanceCounter(&stats.LastSampled))
641 FILETIME CreationTime;
645 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
646 stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
647 stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
651 /* Allow a buffer of two seconds drift on this so that ntpdate etc dont harass admins */
652 if (TIME.tv_sec < OLDTIME - 2)
654 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)(OLDTIME-TIME.tv_sec));
656 else if (TIME.tv_sec > OLDTIME + 2)
658 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is jumping FORWARDS! Clock skipped %lu secs.", (unsigned long)(TIME.tv_sec - OLDTIME));
661 OLDTIME = TIME.tv_sec;
663 if ((TIME.tv_sec % 3600) == 0)
664 FOREACH_MOD(OnGarbageCollect, ());
666 Timers.TickTimers(TIME.tv_sec);
667 Users->DoBackgroundUserStuff();
669 if ((TIME.tv_sec % 5) == 0)
671 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
672 SNO->FlushSnotices();
676 /* Call the socket engine to wait on the active
677 * file descriptors. The socket engine has everything's
678 * descriptors in its list... dns, modules, users,
679 * servers... so its nice and easy, just one call.
680 * This will cause any read or write events to be
681 * dispatched to their handlers.
683 SocketEngine::DispatchTrialWrites();
684 SocketEngine::DispatchEvents();
686 /* if any users were quit, take them out */
692 this->SignalHandler(s_signal);
698 sig_atomic_t InspIRCd::s_signal = 0;
700 void InspIRCd::SetSignal(int signal)
705 /* On posix systems, the flow of the program starts right here, with
706 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
707 * defines smain() and the real main() is in the service code under
708 * win32service.cpp. This allows the service control manager to control
709 * the process where we are running as a windows service.
713 new InspIRCd(argc, argv);
714 ServerInstance->Run();
715 delete ServerInstance;