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/>.
34 #include <sys/resource.h>
37 #include <pwd.h> // setuid
38 #include <grp.h> // setgid
40 WORD g_wOriginalColors;
41 WORD g_wBackgroundColor;
48 #include "exitcodes.h"
50 InspIRCd* ServerInstance = NULL;
52 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
55 * This is provided as a pointer so that modules can change it to their custom mapping tables,
56 * e.g. for national character support.
58 unsigned const char *national_case_insensitive_map = rfc_case_insensitive_map;
61 /* Moved from exitcodes.h -- due to duplicate symbols -- Burlex
62 * XXX this is a bit ugly. -- w00t
64 const char* ExitCodes[] =
68 "Config file error", // 2
70 "POSIX fork failed", // 4
71 "Bad commandline parameters", // 5
72 "Can't write PID file", // 6
73 "SocketEngine could not initialize", // 7
74 "Refusing to start up as root", // 8
75 "Couldn't load module on startup", // 9
76 "Received SIGTERM" // 10
79 template<typename T> static void DeleteZero(T*&n)
86 void InspIRCd::Cleanup()
88 // Close all listening sockets
89 for (unsigned int i = 0; i < ports.size(); i++)
96 // Tell modules that we're shutting down.
97 const std::string quitmsg = "Server shutting down";
98 FOREACH_MOD(OnShutdown, (quitmsg));
100 // Disconnect all local users
101 const UserManager::LocalList& list = Users.GetLocalUsers();
102 while (!list.empty())
103 ServerInstance->Users.QuitUser(list.front(), quitmsg);
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(SIGCHLD, SIG_IGN);
127 signal(SIGHUP, InspIRCd::SetSignal);
128 signal(SIGPIPE, SIG_IGN);
129 signal(SIGUSR1, SIG_IGN);
130 signal(SIGUSR2, SIG_IGN);
131 signal(SIGXFSZ, SIG_IGN);
133 signal(SIGTERM, InspIRCd::SetSignal);
136 // Required for returning the proper value of EXIT_SUCCESS for the parent process
137 static void VoidSignalHandler(int signalreceived)
139 exit(EXIT_STATUS_NOERROR);
142 bool InspIRCd::DaemonSeed()
145 std::cout << "InspIRCd Process ID: " << con_green << GetCurrentProcessId() << con_reset << std::endl;
148 // Do not use exit() here: It will exit with status SIGTERM which would break e.g. daemon scripts
149 signal(SIGTERM, VoidSignalHandler);
151 int childpid = fork();
154 else if (childpid > 0)
156 /* We wait here for the child process to kill us,
157 * so that the shell prompt doesnt come back over
159 * Sending a kill with a signal of 0 just checks
160 * if the child pid is still around. If theyre not,
161 * they threw an error and we should give up.
163 while (kill(childpid, 0) != -1)
165 exit(EXIT_STATUS_NOERROR);
168 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
170 signal(SIGTERM, InspIRCd::SetSignal);
173 if (getrlimit(RLIMIT_CORE, &rl) == -1)
175 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to getrlimit()!");
178 rl.rlim_cur = rl.rlim_max;
180 if (setrlimit(RLIMIT_CORE, &rl) == -1)
181 this->Logs->Log("STARTUP", LOG_DEFAULT, "setrlimit() failed, cannot increase coredump size.");
187 void InspIRCd::WritePID(const std::string& filename, bool exitonfail)
190 if (!ServerInstance->Config->cmdline.writepid)
192 this->Logs->Log("STARTUP", LOG_DEFAULT, "--nopid specified on command line; PID file not written.");
196 std::string fname = ServerInstance->Config->Paths.PrependData(filename.empty() ? "inspircd.pid" : filename);
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)
216 , ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf")
220 , PI(&DefaultProtocolInterface)
221 , GenRandom(&DefaultGenRandom)
222 , IsChannel(&DefaultIsChannel)
223 , IsNick(&DefaultIsNick)
224 , IsIdent(&DefaultIsIdent)
226 ServerInstance = this;
229 this->startup_time = TIME.tv_sec;
231 SocketEngine::Init();
233 this->Config = new ServerConfig;
234 dynamic_reference_base::reset_all();
235 this->XLines = new XLineManager;
237 this->Config->cmdline.argv = argv;
238 this->Config->cmdline.argc = argc;
241 srand(TIME.tv_nsec ^ TIME.tv_sec);
243 // Initialize the console values
244 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
245 CONSOLE_SCREEN_BUFFER_INFO bufinf;
246 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
248 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
249 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
253 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
254 g_wBackgroundColor = 0;
257 srandom(TIME.tv_nsec ^ TIME.tv_sec);
261 ServiceProvider* provs[] =
263 &rfcevents.numeric, &rfcevents.join, &rfcevents.part, &rfcevents.kick, &rfcevents.quit, &rfcevents.nick,
264 &rfcevents.mode, &rfcevents.topic, &rfcevents.privmsg, &rfcevents.invite, &rfcevents.ping, &rfcevents.pong,
267 Modules.AddServices(provs, sizeof(provs)/sizeof(provs[0]));
270 // Flag variables passed to getopt_long() later
271 int do_version = 0, do_nofork = 0, do_debug = 0,
272 do_nolog = 0, do_nopid = 0, do_root = 0;
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 { "nopid", no_argument, &do_nopid, 1 },
280 { "runasroot", no_argument, &do_root, 1 },
281 { "version", no_argument, &do_version, 1 },
287 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
292 /* Config filename was set */
293 ConfigFileName = optarg;
295 TCHAR configPath[MAX_PATH + 1];
296 if (GetFullPathName(optarg, MAX_PATH, configPath, NULL) > 0)
297 ConfigFileName = configPath;
299 char configPath[PATH_MAX + 1];
300 if (realpath(optarg, configPath))
301 ConfigFileName = configPath;
305 /* getopt_long_only() set an int variable, just keep going */
308 /* Unknown parameter */
310 /* Fall through to handle other weird values too */
311 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
312 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--nopid] [--debug] [--config <config>]" << std::endl <<
313 std::string(static_cast<size_t>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
314 Exit(EXIT_STATUS_ARGV);
321 std::cout << std::endl << INSPIRCD_VERSION << std::endl;
322 Exit(EXIT_STATUS_NOERROR);
328 WSAStartup(MAKEWORD(2,2), &wsadata);
331 /* Set the finished argument values */
332 Config->cmdline.nofork = (do_nofork != 0);
333 Config->cmdline.forcedebug = (do_debug != 0);
334 Config->cmdline.writelog = !do_nolog;
335 Config->cmdline.writepid = !do_nopid;
339 FileWriter* fw = new FileWriter(stdout, 1);
340 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
341 Logs->AddLogTypes("*", fls, true);
344 if (!FileSystem::FileExists(ConfigFileName))
347 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
348 std::string txtconf = this->ConfigFileName;
349 txtconf.append(".txt");
351 if (FileSystem::FileExists(txtconf))
353 ConfigFileName = txtconf;
358 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
359 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
360 Exit(EXIT_STATUS_CONFIG);
364 std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl;
365 std::cout << "For contributors & authors: " << con_green << "See /INFO Output" << con_reset << std::endl;
372 std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
373 << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
374 << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
375 << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
376 << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
377 << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
378 << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
379 << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
386 if (!Config->cmdline.nofork)
388 if (!this->DaemonSeed())
390 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
391 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
392 Exit(EXIT_STATUS_FORK);
396 SocketEngine::RecoverFromFork();
398 /* During startup we read the configuration now, not in
401 this->Config->Read();
402 this->Config->Apply(NULL, "");
403 Logs->OpenFileLogs();
405 // If we don't have a SID, generate one based on the server name and the server description
406 if (Config->sid.empty())
407 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
409 // Initialize the UID generator with our sid
410 this->UIDGen.init(Config->sid);
412 // Create the server user for this server
413 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
415 // This is needed as all new XLines are marked pending until ApplyLines() is called
416 this->XLines->ApplyLines();
419 int bounditems = BindPorts(pl);
421 std::cout << std::endl;
423 this->Modules->LoadAll();
425 // Build ISupport as ModuleManager::LoadAll() does not do it
426 this->ISupport.Build();
430 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
431 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
432 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
434 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
436 std::cout << j << ".\tAddress: " << i->first.str() << " \tReason: " << strerror(i->second) << std::endl;
439 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
442 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
445 if (!Config->cmdline.nofork)
447 if (kill(getppid(), SIGTERM) == -1)
449 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
450 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
454 /* Explicitly shut down stdio's stdin/stdout/stderr.
456 * The previous logic here was to only do this if stdio was connected to a controlling
457 * terminal. However, we must do this always to avoid information leaks and other
458 * problems related to stdio.
460 * The only exception is if we are in debug mode.
464 if ((!do_nofork) && (!Config->cmdline.forcedebug))
466 int fd = open("/dev/null", O_RDWR);
472 if (dup2(fd, STDIN_FILENO) < 0)
473 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
474 if (dup2(fd, STDOUT_FILENO) < 0)
475 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
476 if (dup2(fd, STDERR_FILENO) < 0)
477 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
482 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
485 /* Set win32 service as running, if we are running as a service */
494 QueryPerformanceFrequency(&stats.QPFrequency);
497 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %lu max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
500 ConfigTag* security = Config->ConfValue("security");
502 const std::string SetGroup = security->getString("runasgroup");
503 if (!SetGroup.empty())
506 if (setgroups(0, NULL) == -1)
508 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
509 exit(EXIT_STATUS_CONFIG);
512 struct group* g = getgrnam(SetGroup.c_str());
515 this->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
516 exit(EXIT_STATUS_CONFIG);
519 if (setgid(g->gr_gid) == -1)
521 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgid(%d) failed (wrong group?): %s", g->gr_gid, strerror(errno));
522 exit(EXIT_STATUS_CONFIG);
526 const std::string SetUser = security->getString("runasuser");
527 if (!SetUser.empty())
530 struct passwd* u = getpwnam(SetUser.c_str());
533 this->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
534 exit(EXIT_STATUS_CONFIG);
537 if (setuid(u->pw_uid) == -1)
539 this->Logs->Log("STARTUP", LOG_DEFAULT, "setuid(%d) failed (wrong user?): %s", u->pw_uid, strerror(errno));
540 exit(EXIT_STATUS_CONFIG);
544 this->WritePID(Config->PID);
548 void InspIRCd::UpdateTime()
554 TIME.tv_sec = time(NULL);
555 TIME.tv_nsec = st.wMilliseconds;
557 #ifdef HAS_CLOCK_GETTIME
558 clock_gettime(CLOCK_REALTIME, &TIME);
561 gettimeofday(&tv, NULL);
562 TIME.tv_sec = tv.tv_sec;
563 TIME.tv_nsec = tv.tv_usec * 1000;
571 time_t OLDTIME = TIME.tv_sec;
579 /* Check if there is a config thread which has finished executing but has not yet been freed */
580 if (this->ConfigThread && this->ConfigThread->IsDone())
582 /* Rehash has completed */
583 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
585 this->ConfigThread->Finish();
587 ConfigThread->join();
594 /* Run background module timers every few seconds
595 * (the docs say modules shouldnt rely on accurate
596 * timing using this event, so we dont have to
597 * time this exactly).
599 if (TIME.tv_sec != OLDTIME)
602 getrusage(RUSAGE_SELF, &ru);
603 stats.LastSampled = TIME;
604 stats.LastCPU = ru.ru_utime;
606 if(QueryPerformanceCounter(&stats.LastSampled))
608 FILETIME CreationTime;
612 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
613 stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
614 stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
618 if (Config->TimeSkipWarn)
620 time_t timediff = TIME.tv_sec - OLDTIME;
622 if (timediff > Config->TimeSkipWarn)
623 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped forwards by %lu seconds!", timediff);
625 else if (timediff < -Config->TimeSkipWarn)
626 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped backwards by %lu seconds!", labs(timediff));
629 OLDTIME = TIME.tv_sec;
631 if ((TIME.tv_sec % 3600) == 0)
633 FOREACH_MOD(OnGarbageCollect, ());
635 // HACK: ELines are not expired properly at the moment but it can't be fixed as
636 // the 2.0 XLine system is a spaghetti nightmare. Instead we skip over expired
637 // ELines in XLineManager::CheckELines() and expire them here instead.
641 Timers.TickTimers(TIME.tv_sec);
642 Users->DoBackgroundUserStuff();
644 if ((TIME.tv_sec % 5) == 0)
646 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
647 SNO->FlushSnotices();
651 /* Call the socket engine to wait on the active
652 * file descriptors. The socket engine has everything's
653 * descriptors in its list... dns, modules, users,
654 * servers... so its nice and easy, just one call.
655 * This will cause any read or write events to be
656 * dispatched to their handlers.
658 SocketEngine::DispatchTrialWrites();
659 SocketEngine::DispatchEvents();
661 /* if any users were quit, take them out */
667 this->SignalHandler(s_signal);
673 sig_atomic_t InspIRCd::s_signal = 0;
675 void InspIRCd::SetSignal(int signal)
680 /* On posix systems, the flow of the program starts right here, with
681 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
682 * defines smain() and the real main() is in the service code under
683 * win32service.cpp. This allows the service control manager to control
684 * the process where we are running as a windows service.
688 new InspIRCd(argc, argv);
689 ServerInstance->Run();
690 delete ServerInstance;