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>
38 #include <pwd.h> // setuid
39 #include <grp.h> // setgid
41 WORD g_wOriginalColors;
42 WORD g_wBackgroundColor;
49 #include "exitcodes.h"
50 #include "testsuite.h"
52 InspIRCd* ServerInstance = NULL;
54 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
57 * This is provided as a pointer so that modules can change it to their custom mapping tables,
58 * e.g. for national character support.
60 unsigned const char *national_case_insensitive_map = rfc_case_insensitive_map;
63 /* Moved from exitcodes.h -- due to duplicate symbols -- Burlex
64 * XXX this is a bit ugly. -- w00t
66 const char* ExitCodes[] =
70 "Config file error", // 2
72 "POSIX fork failed", // 4
73 "Bad commandline parameters", // 5
74 "Can't write PID file", // 6
75 "SocketEngine could not initialize", // 7
76 "Refusing to start up as root", // 8
77 "Couldn't load module on startup", // 9
78 "Received SIGTERM" // 10
81 #ifdef INSPIRCD_ENABLE_TESTSUITE
82 /** True if we have been told to run the testsuite from the commandline,
83 * rather than entering the mainloop.
85 static int do_testsuite = 0;
88 template<typename T> static void DeleteZero(T*&n)
95 void InspIRCd::Cleanup()
97 // Close all listening sockets
98 for (unsigned int i = 0; i < ports.size(); i++)
106 Modules->UnloadAll();
108 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
109 /* Must be deleted before modes as it decrements modelines */
112 delete FakeClient->server;
115 DeleteZero(this->FakeClient);
116 DeleteZero(this->XLines);
117 DeleteZero(this->Config);
118 SocketEngine::Deinit();
122 void InspIRCd::SetSignals()
125 signal(SIGALRM, SIG_IGN);
126 signal(SIGHUP, InspIRCd::SetSignal);
127 signal(SIGPIPE, SIG_IGN);
128 signal(SIGCHLD, SIG_IGN);
129 /* We want E2BIG not a signal! */
130 signal(SIGXFSZ, SIG_IGN);
132 signal(SIGTERM, InspIRCd::SetSignal);
135 // Required for returning the proper value of EXIT_SUCCESS for the parent process
136 static void VoidSignalHandler(int signalreceived)
138 exit(EXIT_STATUS_NOERROR);
141 bool InspIRCd::DaemonSeed()
144 std::cout << "InspIRCd Process ID: " << con_green << GetCurrentProcessId() << con_reset << std::endl;
147 // Do not use exit() here: It will exit with status SIGTERM which would break e.g. daemon scripts
148 signal(SIGTERM, VoidSignalHandler);
150 int childpid = fork();
153 else if (childpid > 0)
155 /* We wait here for the child process to kill us,
156 * so that the shell prompt doesnt come back over
158 * Sending a kill with a signal of 0 just checks
159 * if the child pid is still around. If theyre not,
160 * they threw an error and we should give up.
162 while (kill(childpid, 0) != -1)
164 exit(EXIT_STATUS_NOERROR);
167 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
169 signal(SIGTERM, InspIRCd::SetSignal);
172 if (getrlimit(RLIMIT_CORE, &rl) == -1)
174 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to getrlimit()!");
177 rl.rlim_cur = rl.rlim_max;
179 if (setrlimit(RLIMIT_CORE, &rl) == -1)
180 this->Logs->Log("STARTUP", LOG_DEFAULT, "setrlimit() failed, cannot increase coredump size.");
186 void InspIRCd::WritePID(const std::string& filename, bool exitonfail)
189 if (!ServerInstance->Config->cmdline.writepid)
191 this->Logs->Log("STARTUP", LOG_DEFAULT, "--nopid specified on command line; PID file not written.");
195 std::string fname(filename);
197 fname = ServerInstance->Config->Paths.PrependData("inspircd.pid");
198 std::ofstream outfile(fname.c_str());
199 if (outfile.is_open())
207 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
208 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s'%s", fname.c_str(), (exitonfail ? ", exiting." : ""));
210 Exit(EXIT_STATUS_PID);
215 InspIRCd::InspIRCd(int argc, char** argv) :
216 ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf"),
217 PI(&DefaultProtocolInterface),
219 /* Functor pointer initialisation.
221 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
222 * themselves within the class.
224 GenRandom(&DefaultGenRandom),
225 IsChannel(&DefaultIsChannel),
226 IsNick(&DefaultIsNick),
227 IsIdent(&DefaultIsIdent)
229 ServerInstance = this;
232 // Flag variables passed to getopt_long() later
233 int do_version = 0, do_nofork = 0, do_debug = 0,
234 do_nolog = 0, do_nopid = 0, do_root = 0;
236 // Initialize so that if we exit before proper initialization they're not deleted
239 this->ConfigThread = NULL;
240 this->FakeClient = NULL;
243 this->startup_time = TIME.tv_sec;
245 SocketEngine::Init();
247 this->Config = new ServerConfig;
248 dynamic_reference_base::reset_all();
249 this->XLines = new XLineManager;
251 this->Config->cmdline.argv = argv;
252 this->Config->cmdline.argc = argc;
255 srand(TIME.tv_nsec ^ TIME.tv_sec);
257 // Initialize the console values
258 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
259 CONSOLE_SCREEN_BUFFER_INFO bufinf;
260 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
262 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
263 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
267 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
268 g_wBackgroundColor = 0;
271 srandom(TIME.tv_nsec ^ TIME.tv_sec);
275 ServiceProvider* provs[] =
277 &rfcevents.numeric, &rfcevents.join, &rfcevents.part, &rfcevents.kick, &rfcevents.quit, &rfcevents.nick,
278 &rfcevents.mode, &rfcevents.topic, &rfcevents.privmsg, &rfcevents.invite, &rfcevents.ping, &rfcevents.pong,
281 Modules.AddServices(provs, sizeof(provs)/sizeof(provs[0]));
284 struct option longopts[] =
286 { "nofork", no_argument, &do_nofork, 1 },
287 { "config", required_argument, NULL, 'c' },
288 { "debug", no_argument, &do_debug, 1 },
289 { "nolog", no_argument, &do_nolog, 1 },
290 { "nopid", no_argument, &do_nopid, 1 },
291 { "runasroot", no_argument, &do_root, 1 },
292 { "version", no_argument, &do_version, 1 },
293 #ifdef INSPIRCD_ENABLE_TESTSUITE
294 { "testsuite", no_argument, &do_testsuite, 1 },
301 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
306 /* Config filename was set */
307 ConfigFileName = optarg;
309 TCHAR configPath[MAX_PATH + 1];
310 if (GetFullPathName(optarg, MAX_PATH, configPath, NULL) > 0)
311 ConfigFileName = configPath;
313 char configPath[PATH_MAX + 1];
314 if (realpath(optarg, configPath))
315 ConfigFileName = configPath;
319 /* getopt_long_only() set an int variable, just keep going */
322 /* Unknown parameter */
324 /* Fall through to handle other weird values too */
325 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
326 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--nopid] [--debug] [--config <config>]" << std::endl <<
327 std::string(static_cast<size_t>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
328 Exit(EXIT_STATUS_ARGV);
333 #ifdef INSPIRCD_ENABLE_TESTSUITE
335 do_nofork = do_debug = true;
340 std::cout << std::endl << INSPIRCD_VERSION << std::endl;
341 Exit(EXIT_STATUS_NOERROR);
347 WSAStartup(MAKEWORD(2,2), &wsadata);
350 /* Set the finished argument values */
351 Config->cmdline.nofork = (do_nofork != 0);
352 Config->cmdline.forcedebug = (do_debug != 0);
353 Config->cmdline.writelog = !do_nolog;
354 Config->cmdline.writepid = !do_nopid;
358 FileWriter* fw = new FileWriter(stdout, 1);
359 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
360 Logs->AddLogTypes("*", fls, true);
363 if (!FileSystem::FileExists(ConfigFileName))
366 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
367 std::string txtconf = this->ConfigFileName;
368 txtconf.append(".txt");
370 if (FileSystem::FileExists(txtconf))
372 ConfigFileName = txtconf;
377 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
378 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
379 Exit(EXIT_STATUS_CONFIG);
383 std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl;
384 std::cout << "For contributors & authors: " << con_green << "See /INFO Output" << con_reset << std::endl;
391 std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
392 << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
393 << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
394 << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
395 << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
396 << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
397 << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
398 << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
405 if (!Config->cmdline.nofork)
407 if (!this->DaemonSeed())
409 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
410 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
411 Exit(EXIT_STATUS_FORK);
415 SocketEngine::RecoverFromFork();
417 /* During startup we read the configuration now, not in
420 this->Config->Read();
421 this->Config->Apply(NULL, "");
422 Logs->OpenFileLogs();
424 // If we don't have a SID, generate one based on the server name and the server description
425 if (Config->sid.empty())
426 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
428 // Initialize the UID generator with our sid
429 this->UIDGen.init(Config->sid);
431 // Create the server user for this server
432 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
434 // This is needed as all new XLines are marked pending until ApplyLines() is called
435 this->XLines->ApplyLines();
437 int bounditems = BindPorts(pl);
439 std::cout << std::endl;
441 this->Modules->LoadAll();
443 // Build ISupport as ModuleManager::LoadAll() does not do it
444 this->ISupport.Build();
445 Config->ApplyDisabledCommands();
449 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
450 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
451 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
453 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
455 std::cout << j << ".\tAddress: " << i->first.str() << " \tReason: " << strerror(i->second) << std::endl;
458 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
461 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
464 if (!Config->cmdline.nofork)
466 if (kill(getppid(), SIGTERM) == -1)
468 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
469 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
473 /* Explicitly shut down stdio's stdin/stdout/stderr.
475 * The previous logic here was to only do this if stdio was connected to a controlling
476 * terminal. However, we must do this always to avoid information leaks and other
477 * problems related to stdio.
479 * The only exception is if we are in debug mode.
483 if ((!do_nofork) && (!Config->cmdline.forcedebug))
485 int fd = open("/dev/null", O_RDWR);
491 if (dup2(fd, STDIN_FILENO) < 0)
492 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
493 if (dup2(fd, STDOUT_FILENO) < 0)
494 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
495 if (dup2(fd, STDERR_FILENO) < 0)
496 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
501 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
504 /* Set win32 service as running, if we are running as a service */
513 QueryPerformanceFrequency(&stats.QPFrequency);
516 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %lu max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
519 ConfigTag* security = Config->ConfValue("security");
521 const std::string SetGroup = security->getString("runasgroup");
522 if (!SetGroup.empty())
525 if (setgroups(0, NULL) == -1)
527 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
528 exit(EXIT_STATUS_CONFIG);
531 struct group* g = getgrnam(SetGroup.c_str());
534 this->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
535 exit(EXIT_STATUS_CONFIG);
538 if (setgid(g->gr_gid) == -1)
540 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgid(%d) failed (wrong group?): %s", g->gr_gid, strerror(errno));
541 exit(EXIT_STATUS_CONFIG);
545 const std::string SetUser = security->getString("runasuser");
546 if (!SetUser.empty())
549 struct passwd* u = getpwnam(SetUser.c_str());
552 this->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
553 exit(EXIT_STATUS_CONFIG);
556 if (setuid(u->pw_uid) == -1)
558 this->Logs->Log("STARTUP", LOG_DEFAULT, "setuid(%d) failed (wrong user?): %s", u->pw_uid, strerror(errno));
559 exit(EXIT_STATUS_CONFIG);
563 this->WritePID(Config->PID);
567 void InspIRCd::UpdateTime()
573 TIME.tv_sec = time(NULL);
574 TIME.tv_nsec = st.wMilliseconds;
576 #ifdef HAS_CLOCK_GETTIME
577 clock_gettime(CLOCK_REALTIME, &TIME);
580 gettimeofday(&tv, NULL);
581 TIME.tv_sec = tv.tv_sec;
582 TIME.tv_nsec = tv.tv_usec * 1000;
589 #ifdef INSPIRCD_ENABLE_TESTSUITE
590 /* See if we're supposed to be running the test suite rather than entering the mainloop */
593 TestSuite* ts = new TestSuite;
600 time_t OLDTIME = TIME.tv_sec;
608 /* Check if there is a config thread which has finished executing but has not yet been freed */
609 if (this->ConfigThread && this->ConfigThread->IsDone())
611 /* Rehash has completed */
612 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
614 this->ConfigThread->Finish();
616 ConfigThread->join();
623 /* Run background module timers every few seconds
624 * (the docs say modules shouldnt rely on accurate
625 * timing using this event, so we dont have to
626 * time this exactly).
628 if (TIME.tv_sec != OLDTIME)
631 getrusage(RUSAGE_SELF, &ru);
632 stats.LastSampled = TIME;
633 stats.LastCPU = ru.ru_utime;
635 if(QueryPerformanceCounter(&stats.LastSampled))
637 FILETIME CreationTime;
641 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
642 stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
643 stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
647 if (Config->TimeSkipWarn)
649 time_t timediff = TIME.tv_sec - OLDTIME;
651 if (timediff > Config->TimeSkipWarn)
652 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped forwards by %lu seconds!", timediff);
654 else if (timediff < -Config->TimeSkipWarn)
655 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped backwards by %lu seconds!", labs(timediff));
658 OLDTIME = TIME.tv_sec;
660 if ((TIME.tv_sec % 3600) == 0)
662 FOREACH_MOD(OnGarbageCollect, ());
664 // HACK: ELines are not expired properly at the moment but it can't be fixed as
665 // the 2.0 XLine system is a spaghetti nightmare. Instead we skip over expired
666 // ELines in XLineManager::CheckELines() and expire them here instead.
670 Timers.TickTimers(TIME.tv_sec);
671 Users->DoBackgroundUserStuff();
673 if ((TIME.tv_sec % 5) == 0)
675 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
676 SNO->FlushSnotices();
680 /* Call the socket engine to wait on the active
681 * file descriptors. The socket engine has everything's
682 * descriptors in its list... dns, modules, users,
683 * servers... so its nice and easy, just one call.
684 * This will cause any read or write events to be
685 * dispatched to their handlers.
687 SocketEngine::DispatchTrialWrites();
688 SocketEngine::DispatchEvents();
690 /* if any users were quit, take them out */
696 this->SignalHandler(s_signal);
702 sig_atomic_t InspIRCd::s_signal = 0;
704 void InspIRCd::SetSignal(int signal)
709 /* On posix systems, the flow of the program starts right here, with
710 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
711 * defines smain() and the real main() is in the service code under
712 * win32service.cpp. This allows the service control manager to control
713 * the process where we are running as a windows service.
717 new InspIRCd(argc, argv);
718 ServerInstance->Run();
719 delete ServerInstance;