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++)
111 /* Close all client sockets, or the new process inherits them */
112 const UserManager::LocalList& list = Users.GetLocalUsers();
113 for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
114 Users->QuitUser(*i, "Server shutdown");
117 Modules->UnloadAll();
119 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
120 /* Must be deleted before modes as it decrements modelines */
123 delete FakeClient->server;
126 DeleteZero(this->FakeClient);
127 DeleteZero(this->XLines);
128 DeleteZero(this->Config);
129 SocketEngine::Deinit();
133 void InspIRCd::SetSignals()
136 signal(SIGALRM, SIG_IGN);
137 signal(SIGHUP, InspIRCd::SetSignal);
138 signal(SIGPIPE, SIG_IGN);
139 signal(SIGCHLD, SIG_IGN);
140 /* We want E2BIG not a signal! */
141 signal(SIGXFSZ, SIG_IGN);
143 signal(SIGTERM, InspIRCd::SetSignal);
146 void InspIRCd::QuickExit(int status)
151 // Required for returning the proper value of EXIT_SUCCESS for the parent process
152 static void VoidSignalHandler(int signalreceived)
157 bool InspIRCd::DaemonSeed()
160 std::cout << "InspIRCd Process ID: " << con_green << GetCurrentProcessId() << con_reset << std::endl;
163 // Do not use QuickExit here: It will exit with status SIGTERM which would break e.g. daemon scripts
164 signal(SIGTERM, VoidSignalHandler);
166 int childpid = fork();
169 else if (childpid > 0)
171 /* We wait here for the child process to kill us,
172 * so that the shell prompt doesnt come back over
174 * Sending a kill with a signal of 0 just checks
175 * if the child pid is still around. If theyre not,
176 * they threw an error and we should give up.
178 while (kill(childpid, 0) != -1)
183 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
185 signal(SIGTERM, InspIRCd::SetSignal);
188 if (getrlimit(RLIMIT_CORE, &rl) == -1)
190 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to getrlimit()!");
193 rl.rlim_cur = rl.rlim_max;
195 if (setrlimit(RLIMIT_CORE, &rl) == -1)
196 this->Logs->Log("STARTUP", LOG_DEFAULT, "setrlimit() failed, cannot increase coredump size.");
202 void InspIRCd::WritePID(const std::string &filename)
205 std::string fname(filename);
207 fname = ServerInstance->Config->Paths.PrependData("inspircd.pid");
208 std::ofstream outfile(fname.c_str());
209 if (outfile.is_open())
216 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
217 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s', exiting.",fname.c_str());
218 Exit(EXIT_STATUS_PID);
223 InspIRCd::InspIRCd(int argc, char** argv) :
224 ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf"),
225 PI(&DefaultProtocolInterface),
227 /* Functor pointer initialisation.
229 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
230 * themselves within the class.
232 OperQuit("operquit", NULL),
233 GenRandom(&HandleGenRandom),
234 IsChannel(&HandleIsChannel),
235 IsNick(&HandleIsNick),
236 IsIdent(&HandleIsIdent),
237 OnCheckExemption(&HandleOnCheckExemption)
239 ServerInstance = this;
241 Extensions.Register(&OperQuit);
244 // Flag variables passed to getopt_long() later
245 int do_version = 0, do_nofork = 0, do_debug = 0,
246 do_nolog = 0, do_root = 0;
248 // Initialize so that if we exit before proper initialization they're not deleted
251 this->ConfigThread = NULL;
252 this->FakeClient = NULL;
255 this->startup_time = TIME.tv_sec;
257 SocketEngine::Init();
259 this->Config = new ServerConfig;
260 dynamic_reference_base::reset_all();
261 this->XLines = new XLineManager;
263 this->Config->cmdline.argv = argv;
264 this->Config->cmdline.argc = argc;
267 srand(TIME.tv_nsec ^ TIME.tv_sec);
269 // Initialize the console values
270 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
271 CONSOLE_SCREEN_BUFFER_INFO bufinf;
272 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
274 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
275 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
279 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
280 g_wBackgroundColor = 0;
283 srandom(TIME.tv_nsec ^ TIME.tv_sec);
286 struct option longopts[] =
288 { "nofork", no_argument, &do_nofork, 1 },
289 { "config", required_argument, NULL, 'c' },
290 { "debug", no_argument, &do_debug, 1 },
291 { "nolog", no_argument, &do_nolog, 1 },
292 { "runasroot", no_argument, &do_root, 1 },
293 { "version", no_argument, &do_version, 1 },
294 #ifdef INSPIRCD_ENABLE_TESTSUITE
295 { "testsuite", no_argument, &do_testsuite, 1 },
302 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
307 /* Config filename was set */
308 ConfigFileName = ServerInstance->Config->Paths.PrependConfig(optarg);
311 /* getopt_long_only() set an int variable, just keep going */
314 /* Unknown parameter */
316 /* Fall through to handle other weird values too */
317 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
318 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--debug] [--config <config>]" << std::endl <<
319 std::string(static_cast<int>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
320 Exit(EXIT_STATUS_ARGV);
325 #ifdef INSPIRCD_ENABLE_TESTSUITE
327 do_nofork = do_debug = true;
332 std::cout << std::endl << INSPIRCD_VERSION << " " << INSPIRCD_REVISION << std::endl;
333 Exit(EXIT_STATUS_NOERROR);
339 WSAStartup(MAKEWORD(2,2), &wsadata);
342 /* Set the finished argument values */
343 Config->cmdline.nofork = (do_nofork != 0);
344 Config->cmdline.forcedebug = (do_debug != 0);
345 Config->cmdline.writelog = !do_nolog;
349 FileWriter* fw = new FileWriter(stdout);
350 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
351 Logs->AddLogTypes("*", fls, true);
354 if (!FileSystem::FileExists(ConfigFileName))
357 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
358 std::string txtconf = this->ConfigFileName;
359 txtconf.append(".txt");
361 if (FileSystem::FileExists(txtconf))
363 ConfigFileName = txtconf;
368 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
369 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
370 Exit(EXIT_STATUS_CONFIG);
374 std::cout << con_green << "Inspire Internet Relay Chat Server" << con_reset << ", compiled on " __DATE__ " at " __TIME__ << std::endl;
375 std::cout << con_green << "(C) InspIRCd Development Team." << con_reset << std::endl << std::endl;
376 std::cout << "Developers:" << std::endl;
377 std::cout << con_green << "\tBrain, FrostyCoolSlug, w00t, Om, Special, peavey" << std::endl;
378 std::cout << "\taquanight, psychon, dz, danieldg, jackmcbarn" << std::endl;
379 std::cout << "\tAttila" << con_reset << std::endl << std::endl;
380 std::cout << "Others:\t\t\t" << con_green << "See /INFO Output" << con_reset << std::endl;
387 std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
388 << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
389 << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
390 << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
391 << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
392 << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
393 << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
394 << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
401 if (!Config->cmdline.nofork)
403 if (!this->DaemonSeed())
405 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
406 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
407 Exit(EXIT_STATUS_FORK);
411 SocketEngine::RecoverFromFork();
413 /* During startup we read the configuration now, not in
416 this->Config->Read();
417 this->Config->Apply(NULL, "");
418 Logs->OpenFileLogs();
419 ModeParser::InitBuiltinModes();
421 // If we don't have a SID, generate one based on the server name and the server description
422 if (Config->sid.empty())
423 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
425 // Initialize the UID generator with our sid
426 this->UIDGen.init(Config->sid);
428 // Create the server user for this server
429 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
431 // This is needed as all new XLines are marked pending until ApplyLines() is called
432 this->XLines->ApplyLines();
434 int bounditems = BindPorts(pl);
436 std::cout << std::endl;
438 this->Modules->LoadAll();
440 // Build ISupport as ModuleManager::LoadAll() does not do it
441 this->ISupport.Build();
442 Config->ApplyDisabledCommands(Config->DisabledCommands);
446 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
447 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
448 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
450 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
452 std::cout << j << ".\tAddress: " << (i->first.empty() ? "<all>" : i->first) << " \tReason: " << i->second << std::endl;
455 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
458 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
461 if (!Config->cmdline.nofork)
463 if (kill(getppid(), SIGTERM) == -1)
465 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
466 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
470 /* Explicitly shut down stdio's stdin/stdout/stderr.
472 * The previous logic here was to only do this if stdio was connected to a controlling
473 * terminal. However, we must do this always to avoid information leaks and other
474 * problems related to stdio.
476 * The only exception is if we are in debug mode.
480 if ((!do_nofork) && (!Config->cmdline.forcedebug))
482 int fd = open("/dev/null", O_RDWR);
488 if (dup2(fd, STDIN_FILENO) < 0)
489 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
490 if (dup2(fd, STDOUT_FILENO) < 0)
491 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
492 if (dup2(fd, STDERR_FILENO) < 0)
493 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
498 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
501 /* Set win32 service as running, if we are running as a service */
510 QueryPerformanceFrequency(&stats.QPFrequency);
513 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %d max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
516 std::string SetUser = Config->ConfValue("security")->getString("runasuser");
517 std::string SetGroup = Config->ConfValue("security")->getString("runasgroup");
518 if (!SetGroup.empty())
523 ret = setgroups(0, NULL);
527 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
535 g = getgrnam(SetGroup.c_str());
539 this->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
543 ret = setgid(g->gr_gid);
547 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgid() failed (wrong group?): %s", strerror(errno));
552 if (!SetUser.empty())
558 u = getpwnam(SetUser.c_str());
562 this->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
566 int ret = setuid(u->pw_uid);
570 this->Logs->Log("STARTUP", LOG_DEFAULT, "setuid() failed (wrong user?): %s", strerror(errno));
575 this->WritePID(Config->PID);
579 void InspIRCd::UpdateTime()
585 TIME.tv_sec = time(NULL);
586 TIME.tv_nsec = st.wMilliseconds;
588 #ifdef HAS_CLOCK_GETTIME
589 clock_gettime(CLOCK_REALTIME, &TIME);
592 gettimeofday(&tv, NULL);
593 TIME.tv_sec = tv.tv_sec;
594 TIME.tv_nsec = tv.tv_usec * 1000;
601 #ifdef INSPIRCD_ENABLE_TESTSUITE
602 /* See if we're supposed to be running the test suite rather than entering the mainloop */
605 TestSuite* ts = new TestSuite;
612 time_t OLDTIME = TIME.tv_sec;
620 /* Check if there is a config thread which has finished executing but has not yet been freed */
621 if (this->ConfigThread && this->ConfigThread->IsDone())
623 /* Rehash has completed */
624 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
626 this->ConfigThread->Finish();
628 ConfigThread->join();
635 /* Run background module timers every few seconds
636 * (the docs say modules shouldnt rely on accurate
637 * timing using this event, so we dont have to
638 * time this exactly).
640 if (TIME.tv_sec != OLDTIME)
643 getrusage(RUSAGE_SELF, &ru);
644 stats.LastSampled = TIME;
645 stats.LastCPU = ru.ru_utime;
647 if(QueryPerformanceCounter(&stats.LastSampled))
649 FILETIME CreationTime;
653 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
654 stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
655 stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
659 /* Allow a buffer of two seconds drift on this so that ntpdate etc dont harass admins */
660 if (TIME.tv_sec < OLDTIME - 2)
662 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)OLDTIME-TIME.tv_sec);
664 else if (TIME.tv_sec > OLDTIME + 2)
666 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is jumping FORWARDS! Clock skipped %lu secs.", (unsigned long)TIME.tv_sec - OLDTIME);
669 OLDTIME = TIME.tv_sec;
671 if ((TIME.tv_sec % 3600) == 0)
673 Users->GarbageCollect();
674 FOREACH_MOD(OnGarbageCollect, ());
677 Timers.TickTimers(TIME.tv_sec);
678 Users->DoBackgroundUserStuff();
680 if ((TIME.tv_sec % 5) == 0)
682 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
683 SNO->FlushSnotices();
687 /* Call the socket engine to wait on the active
688 * file descriptors. The socket engine has everything's
689 * descriptors in its list... dns, modules, users,
690 * servers... so its nice and easy, just one call.
691 * This will cause any read or write events to be
692 * dispatched to their handlers.
694 SocketEngine::DispatchTrialWrites();
695 SocketEngine::DispatchEvents();
697 /* if any users were quit, take them out */
703 this->SignalHandler(s_signal);
709 sig_atomic_t InspIRCd::s_signal = 0;
711 void InspIRCd::SetSignal(int signal)
716 /* On posix systems, the flow of the program starts right here, with
717 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
718 * defines smain() and the real main() is in the service code under
719 * win32service.cpp. This allows the service control manager to control
720 * the process where we are running as a windows service.
724 new InspIRCd(argc, argv);
725 ServerInstance->Run();
726 delete ServerInstance;