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 std::string fname(filename);
191 fname = ServerInstance->Config->Paths.PrependData("inspircd.pid");
192 std::ofstream outfile(fname.c_str());
193 if (outfile.is_open())
201 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
202 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s'%s", fname.c_str(), (exitonfail ? ", exiting." : ""));
204 Exit(EXIT_STATUS_PID);
209 InspIRCd::InspIRCd(int argc, char** argv) :
210 ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf"),
211 PI(&DefaultProtocolInterface),
213 /* Functor pointer initialisation.
215 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
216 * themselves within the class.
218 GenRandom(&DefaultGenRandom),
219 IsChannel(&DefaultIsChannel),
220 IsNick(&DefaultIsNick),
221 IsIdent(&DefaultIsIdent)
223 ServerInstance = this;
226 // Flag variables passed to getopt_long() later
227 int do_version = 0, do_nofork = 0, do_debug = 0,
228 do_nolog = 0, do_root = 0;
230 // Initialize so that if we exit before proper initialization they're not deleted
233 this->ConfigThread = NULL;
234 this->FakeClient = NULL;
237 this->startup_time = TIME.tv_sec;
239 SocketEngine::Init();
241 this->Config = new ServerConfig;
242 dynamic_reference_base::reset_all();
243 this->XLines = new XLineManager;
245 this->Config->cmdline.argv = argv;
246 this->Config->cmdline.argc = argc;
249 srand(TIME.tv_nsec ^ TIME.tv_sec);
251 // Initialize the console values
252 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
253 CONSOLE_SCREEN_BUFFER_INFO bufinf;
254 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
256 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
257 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
261 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
262 g_wBackgroundColor = 0;
265 srandom(TIME.tv_nsec ^ TIME.tv_sec);
268 struct option longopts[] =
270 { "nofork", no_argument, &do_nofork, 1 },
271 { "config", required_argument, NULL, 'c' },
272 { "debug", no_argument, &do_debug, 1 },
273 { "nolog", no_argument, &do_nolog, 1 },
274 { "runasroot", no_argument, &do_root, 1 },
275 { "version", no_argument, &do_version, 1 },
276 #ifdef INSPIRCD_ENABLE_TESTSUITE
277 { "testsuite", no_argument, &do_testsuite, 1 },
284 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
289 /* Config filename was set */
290 ConfigFileName = ServerInstance->Config->Paths.PrependConfig(optarg);
293 /* getopt_long_only() set an int variable, just keep going */
296 /* Unknown parameter */
298 /* Fall through to handle other weird values too */
299 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
300 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--debug] [--config <config>]" << std::endl <<
301 std::string(static_cast<size_t>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
302 Exit(EXIT_STATUS_ARGV);
307 #ifdef INSPIRCD_ENABLE_TESTSUITE
309 do_nofork = do_debug = true;
314 std::cout << std::endl << INSPIRCD_VERSION << std::endl;
315 Exit(EXIT_STATUS_NOERROR);
321 WSAStartup(MAKEWORD(2,2), &wsadata);
324 /* Set the finished argument values */
325 Config->cmdline.nofork = (do_nofork != 0);
326 Config->cmdline.forcedebug = (do_debug != 0);
327 Config->cmdline.writelog = !do_nolog;
331 FileWriter* fw = new FileWriter(stdout, 1);
332 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
333 Logs->AddLogTypes("*", fls, true);
336 if (!FileSystem::FileExists(ConfigFileName))
339 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
340 std::string txtconf = this->ConfigFileName;
341 txtconf.append(".txt");
343 if (FileSystem::FileExists(txtconf))
345 ConfigFileName = txtconf;
350 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
351 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
352 Exit(EXIT_STATUS_CONFIG);
356 std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl;
357 std::cout << "For contributors & authors: " << con_green << "See /INFO Output" << con_reset << std::endl;
364 std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
365 << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
366 << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
367 << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
368 << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
369 << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
370 << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
371 << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
378 if (!Config->cmdline.nofork)
380 if (!this->DaemonSeed())
382 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
383 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
384 Exit(EXIT_STATUS_FORK);
388 SocketEngine::RecoverFromFork();
390 /* During startup we read the configuration now, not in
393 this->Config->Read();
394 this->Config->Apply(NULL, "");
395 Logs->OpenFileLogs();
397 // If we don't have a SID, generate one based on the server name and the server description
398 if (Config->sid.empty())
399 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
401 // Initialize the UID generator with our sid
402 this->UIDGen.init(Config->sid);
404 // Create the server user for this server
405 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
407 // This is needed as all new XLines are marked pending until ApplyLines() is called
408 this->XLines->ApplyLines();
410 int bounditems = BindPorts(pl);
412 std::cout << std::endl;
414 this->Modules->LoadAll();
416 // Build ISupport as ModuleManager::LoadAll() does not do it
417 this->ISupport.Build();
418 Config->ApplyDisabledCommands();
422 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
423 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
424 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
426 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
428 std::cout << j << ".\tAddress: " << i->first.str() << " \tReason: " << strerror(i->second) << std::endl;
431 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
434 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
437 if (!Config->cmdline.nofork)
439 if (kill(getppid(), SIGTERM) == -1)
441 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
442 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
446 /* Explicitly shut down stdio's stdin/stdout/stderr.
448 * The previous logic here was to only do this if stdio was connected to a controlling
449 * terminal. However, we must do this always to avoid information leaks and other
450 * problems related to stdio.
452 * The only exception is if we are in debug mode.
456 if ((!do_nofork) && (!Config->cmdline.forcedebug))
458 int fd = open("/dev/null", O_RDWR);
464 if (dup2(fd, STDIN_FILENO) < 0)
465 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
466 if (dup2(fd, STDOUT_FILENO) < 0)
467 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
468 if (dup2(fd, STDERR_FILENO) < 0)
469 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
474 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
477 /* Set win32 service as running, if we are running as a service */
486 QueryPerformanceFrequency(&stats.QPFrequency);
489 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %lu max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
492 ConfigTag* security = Config->ConfValue("security");
494 const std::string SetGroup = security->getString("runasgroup");
495 if (!SetGroup.empty())
498 if (setgroups(0, NULL) == -1)
500 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
501 exit(EXIT_STATUS_CONFIG);
504 struct group* g = getgrnam(SetGroup.c_str());
507 this->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
508 exit(EXIT_STATUS_CONFIG);
511 if (setgid(g->gr_gid) == -1)
513 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgid(%d) failed (wrong group?): %s", g->gr_gid, strerror(errno));
514 exit(EXIT_STATUS_CONFIG);
518 const std::string SetUser = security->getString("runasuser");
519 if (!SetUser.empty())
522 struct passwd* u = getpwnam(SetUser.c_str());
525 this->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
526 exit(EXIT_STATUS_CONFIG);
529 if (setuid(u->pw_uid) == -1)
531 this->Logs->Log("STARTUP", LOG_DEFAULT, "setuid(%d) failed (wrong user?): %s", u->pw_uid, strerror(errno));
532 exit(EXIT_STATUS_CONFIG);
536 this->WritePID(Config->PID);
540 void InspIRCd::UpdateTime()
546 TIME.tv_sec = time(NULL);
547 TIME.tv_nsec = st.wMilliseconds;
549 #ifdef HAS_CLOCK_GETTIME
550 clock_gettime(CLOCK_REALTIME, &TIME);
553 gettimeofday(&tv, NULL);
554 TIME.tv_sec = tv.tv_sec;
555 TIME.tv_nsec = tv.tv_usec * 1000;
562 #ifdef INSPIRCD_ENABLE_TESTSUITE
563 /* See if we're supposed to be running the test suite rather than entering the mainloop */
566 TestSuite* ts = new TestSuite;
573 time_t OLDTIME = TIME.tv_sec;
581 /* Check if there is a config thread which has finished executing but has not yet been freed */
582 if (this->ConfigThread && this->ConfigThread->IsDone())
584 /* Rehash has completed */
585 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
587 this->ConfigThread->Finish();
589 ConfigThread->join();
596 /* Run background module timers every few seconds
597 * (the docs say modules shouldnt rely on accurate
598 * timing using this event, so we dont have to
599 * time this exactly).
601 if (TIME.tv_sec != OLDTIME)
604 getrusage(RUSAGE_SELF, &ru);
605 stats.LastSampled = TIME;
606 stats.LastCPU = ru.ru_utime;
608 if(QueryPerformanceCounter(&stats.LastSampled))
610 FILETIME CreationTime;
614 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
615 stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
616 stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
620 /* Allow a buffer of two seconds drift on this so that ntpdate etc dont harass admins */
621 if (TIME.tv_sec < OLDTIME - 2)
623 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)(OLDTIME-TIME.tv_sec));
625 else if (TIME.tv_sec > OLDTIME + 2)
627 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is jumping FORWARDS! Clock skipped %lu secs.", (unsigned long)(TIME.tv_sec - OLDTIME));
630 OLDTIME = TIME.tv_sec;
632 if ((TIME.tv_sec % 3600) == 0)
634 FOREACH_MOD(OnGarbageCollect, ());
636 // HACK: ELines are not expired properly at the moment but it can't be fixed as
637 // the 2.0 XLine system is a spaghetti nightmare. Instead we skip over expired
638 // ELines in XLineManager::CheckELines() and expire them here instead.
642 Timers.TickTimers(TIME.tv_sec);
643 Users->DoBackgroundUserStuff();
645 if ((TIME.tv_sec % 5) == 0)
647 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
648 SNO->FlushSnotices();
652 /* Call the socket engine to wait on the active
653 * file descriptors. The socket engine has everything's
654 * descriptors in its list... dns, modules, users,
655 * servers... so its nice and easy, just one call.
656 * This will cause any read or write events to be
657 * dispatched to their handlers.
659 SocketEngine::DispatchTrialWrites();
660 SocketEngine::DispatchEvents();
662 /* if any users were quit, take them out */
668 this->SignalHandler(s_signal);
674 sig_atomic_t InspIRCd::s_signal = 0;
676 void InspIRCd::SetSignal(int signal)
681 /* On posix systems, the flow of the program starts right here, with
682 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
683 * defines smain() and the real main() is in the service code under
684 * win32service.cpp. This allows the service control manager to control
685 * the process where we are running as a windows service.
689 new InspIRCd(argc, argv);
690 ServerInstance->Run();
691 delete ServerInstance;