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 void InspIRCd::QuickExit(int status)
140 // Required for returning the proper value of EXIT_SUCCESS for the parent process
141 static void VoidSignalHandler(int signalreceived)
146 bool InspIRCd::DaemonSeed()
149 std::cout << "InspIRCd Process ID: " << con_green << GetCurrentProcessId() << con_reset << std::endl;
152 // Do not use QuickExit here: It will exit with status SIGTERM which would break e.g. daemon scripts
153 signal(SIGTERM, VoidSignalHandler);
155 int childpid = fork();
158 else if (childpid > 0)
160 /* We wait here for the child process to kill us,
161 * so that the shell prompt doesnt come back over
163 * Sending a kill with a signal of 0 just checks
164 * if the child pid is still around. If theyre not,
165 * they threw an error and we should give up.
167 while (kill(childpid, 0) != -1)
172 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
174 signal(SIGTERM, InspIRCd::SetSignal);
177 if (getrlimit(RLIMIT_CORE, &rl) == -1)
179 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to getrlimit()!");
182 rl.rlim_cur = rl.rlim_max;
184 if (setrlimit(RLIMIT_CORE, &rl) == -1)
185 this->Logs->Log("STARTUP", LOG_DEFAULT, "setrlimit() failed, cannot increase coredump size.");
191 void InspIRCd::WritePID(const std::string& filename, bool exitonfail)
194 std::string fname(filename);
196 fname = ServerInstance->Config->Paths.PrependData("inspircd.pid");
197 std::ofstream outfile(fname.c_str());
198 if (outfile.is_open())
206 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
207 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s'%s", fname.c_str(), (exitonfail ? ", exiting." : ""));
209 Exit(EXIT_STATUS_PID);
214 InspIRCd::InspIRCd(int argc, char** argv) :
215 ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf"),
216 PI(&DefaultProtocolInterface),
218 /* Functor pointer initialisation.
220 * THIS MUST MATCH THE ORDER OF DECLARATION OF THE FUNCTORS, e.g. the methods
221 * themselves within the class.
223 GenRandom(&DefaultGenRandom),
224 IsChannel(&DefaultIsChannel),
225 IsNick(&DefaultIsNick),
226 IsIdent(&DefaultIsIdent)
228 ServerInstance = this;
231 // Flag variables passed to getopt_long() later
232 int do_version = 0, do_nofork = 0, do_debug = 0,
233 do_nolog = 0, do_root = 0;
235 // Initialize so that if we exit before proper initialization they're not deleted
238 this->ConfigThread = NULL;
239 this->FakeClient = NULL;
242 this->startup_time = TIME.tv_sec;
244 SocketEngine::Init();
246 this->Config = new ServerConfig;
247 dynamic_reference_base::reset_all();
248 this->XLines = new XLineManager;
250 this->Config->cmdline.argv = argv;
251 this->Config->cmdline.argc = argc;
254 srand(TIME.tv_nsec ^ TIME.tv_sec);
256 // Initialize the console values
257 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
258 CONSOLE_SCREEN_BUFFER_INFO bufinf;
259 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
261 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
262 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
266 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
267 g_wBackgroundColor = 0;
270 srandom(TIME.tv_nsec ^ TIME.tv_sec);
273 struct option longopts[] =
275 { "nofork", no_argument, &do_nofork, 1 },
276 { "config", required_argument, NULL, 'c' },
277 { "debug", no_argument, &do_debug, 1 },
278 { "nolog", no_argument, &do_nolog, 1 },
279 { "runasroot", no_argument, &do_root, 1 },
280 { "version", no_argument, &do_version, 1 },
281 #ifdef INSPIRCD_ENABLE_TESTSUITE
282 { "testsuite", no_argument, &do_testsuite, 1 },
289 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
294 /* Config filename was set */
295 ConfigFileName = ServerInstance->Config->Paths.PrependConfig(optarg);
298 /* getopt_long_only() set an int variable, just keep going */
301 /* Unknown parameter */
303 /* Fall through to handle other weird values too */
304 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
305 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--debug] [--config <config>]" << std::endl <<
306 std::string(static_cast<size_t>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
307 Exit(EXIT_STATUS_ARGV);
312 #ifdef INSPIRCD_ENABLE_TESTSUITE
314 do_nofork = do_debug = true;
319 std::cout << std::endl << INSPIRCD_VERSION << std::endl;
320 Exit(EXIT_STATUS_NOERROR);
326 WSAStartup(MAKEWORD(2,2), &wsadata);
329 /* Set the finished argument values */
330 Config->cmdline.nofork = (do_nofork != 0);
331 Config->cmdline.forcedebug = (do_debug != 0);
332 Config->cmdline.writelog = !do_nolog;
336 FileWriter* fw = new FileWriter(stdout, 1);
337 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
338 Logs->AddLogTypes("*", fls, true);
341 if (!FileSystem::FileExists(ConfigFileName))
344 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
345 std::string txtconf = this->ConfigFileName;
346 txtconf.append(".txt");
348 if (FileSystem::FileExists(txtconf))
350 ConfigFileName = txtconf;
355 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
356 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
357 Exit(EXIT_STATUS_CONFIG);
361 std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl;
362 std::cout << "For contributors & authors: " << con_green << "See /INFO Output" << con_reset << std::endl;
369 std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
370 << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
371 << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
372 << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
373 << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
374 << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
375 << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
376 << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
383 if (!Config->cmdline.nofork)
385 if (!this->DaemonSeed())
387 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
388 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
389 Exit(EXIT_STATUS_FORK);
393 SocketEngine::RecoverFromFork();
395 /* During startup we read the configuration now, not in
398 this->Config->Read();
399 this->Config->Apply(NULL, "");
400 Logs->OpenFileLogs();
402 // If we don't have a SID, generate one based on the server name and the server description
403 if (Config->sid.empty())
404 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
406 // Initialize the UID generator with our sid
407 this->UIDGen.init(Config->sid);
409 // Create the server user for this server
410 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
412 // This is needed as all new XLines are marked pending until ApplyLines() is called
413 this->XLines->ApplyLines();
415 int bounditems = BindPorts(pl);
417 std::cout << std::endl;
419 this->Modules->LoadAll();
421 // Build ISupport as ModuleManager::LoadAll() does not do it
422 this->ISupport.Build();
423 Config->ApplyDisabledCommands();
427 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
428 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
429 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
431 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
433 std::cout << j << ".\tAddress: " << i->first.str() << " \tReason: " << strerror(i->second) << std::endl;
436 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
439 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
442 if (!Config->cmdline.nofork)
444 if (kill(getppid(), SIGTERM) == -1)
446 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
447 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
451 /* Explicitly shut down stdio's stdin/stdout/stderr.
453 * The previous logic here was to only do this if stdio was connected to a controlling
454 * terminal. However, we must do this always to avoid information leaks and other
455 * problems related to stdio.
457 * The only exception is if we are in debug mode.
461 if ((!do_nofork) && (!Config->cmdline.forcedebug))
463 int fd = open("/dev/null", O_RDWR);
469 if (dup2(fd, STDIN_FILENO) < 0)
470 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
471 if (dup2(fd, STDOUT_FILENO) < 0)
472 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
473 if (dup2(fd, STDERR_FILENO) < 0)
474 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
479 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
482 /* Set win32 service as running, if we are running as a service */
491 QueryPerformanceFrequency(&stats.QPFrequency);
494 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %lu max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
497 ConfigTag* security = Config->ConfValue("security");
499 const std::string SetGroup = security->getString("runasgroup");
500 if (!SetGroup.empty())
503 if (setgroups(0, NULL) == -1)
505 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
509 struct group* g = getgrnam(SetGroup.c_str());
512 this->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
516 if (setgid(g->gr_gid) == -1)
518 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgid(%d) failed (wrong group?): %s", g->gr_gid, strerror(errno));
523 const std::string SetUser = security->getString("runasuser");
524 if (!SetUser.empty())
527 struct passwd* u = getpwnam(SetUser.c_str());
530 this->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
534 if (setuid(u->pw_uid) == -1)
536 this->Logs->Log("STARTUP", LOG_DEFAULT, "setuid(%d) failed (wrong user?): %s", u->pw_uid, strerror(errno));
541 this->WritePID(Config->PID);
545 void InspIRCd::UpdateTime()
551 TIME.tv_sec = time(NULL);
552 TIME.tv_nsec = st.wMilliseconds;
554 #ifdef HAS_CLOCK_GETTIME
555 clock_gettime(CLOCK_REALTIME, &TIME);
558 gettimeofday(&tv, NULL);
559 TIME.tv_sec = tv.tv_sec;
560 TIME.tv_nsec = tv.tv_usec * 1000;
567 #ifdef INSPIRCD_ENABLE_TESTSUITE
568 /* See if we're supposed to be running the test suite rather than entering the mainloop */
571 TestSuite* ts = new TestSuite;
578 time_t OLDTIME = TIME.tv_sec;
586 /* Check if there is a config thread which has finished executing but has not yet been freed */
587 if (this->ConfigThread && this->ConfigThread->IsDone())
589 /* Rehash has completed */
590 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
592 this->ConfigThread->Finish();
594 ConfigThread->join();
601 /* Run background module timers every few seconds
602 * (the docs say modules shouldnt rely on accurate
603 * timing using this event, so we dont have to
604 * time this exactly).
606 if (TIME.tv_sec != OLDTIME)
609 getrusage(RUSAGE_SELF, &ru);
610 stats.LastSampled = TIME;
611 stats.LastCPU = ru.ru_utime;
613 if(QueryPerformanceCounter(&stats.LastSampled))
615 FILETIME CreationTime;
619 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
620 stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
621 stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
625 /* Allow a buffer of two seconds drift on this so that ntpdate etc dont harass admins */
626 if (TIME.tv_sec < OLDTIME - 2)
628 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %lu secs.", (unsigned long)(OLDTIME-TIME.tv_sec));
630 else if (TIME.tv_sec > OLDTIME + 2)
632 SNO->WriteToSnoMask('d', "\002EH?!\002 -- Time is jumping FORWARDS! Clock skipped %lu secs.", (unsigned long)(TIME.tv_sec - OLDTIME));
635 OLDTIME = TIME.tv_sec;
637 if ((TIME.tv_sec % 3600) == 0)
639 FOREACH_MOD(OnGarbageCollect, ());
641 // HACK: ELines are not expired properly at the moment but it can't be fixed as
642 // the 2.0 XLine system is a spaghetti nightmare. Instead we skip over expired
643 // ELines in XLineManager::CheckELines() and expire them here instead.
647 Timers.TickTimers(TIME.tv_sec);
648 Users->DoBackgroundUserStuff();
650 if ((TIME.tv_sec % 5) == 0)
652 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
653 SNO->FlushSnotices();
657 /* Call the socket engine to wait on the active
658 * file descriptors. The socket engine has everything's
659 * descriptors in its list... dns, modules, users,
660 * servers... so its nice and easy, just one call.
661 * This will cause any read or write events to be
662 * dispatched to their handlers.
664 SocketEngine::DispatchTrialWrites();
665 SocketEngine::DispatchEvents();
667 /* if any users were quit, take them out */
673 this->SignalHandler(s_signal);
679 sig_atomic_t InspIRCd::s_signal = 0;
681 void InspIRCd::SetSignal(int signal)
686 /* On posix systems, the flow of the program starts right here, with
687 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
688 * defines smain() and the real main() is in the service code under
689 * win32service.cpp. This allows the service control manager to control
690 * the process where we are running as a windows service.
694 new InspIRCd(argc, argv);
695 ServerInstance->Run();
696 delete ServerInstance;