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
81 // Deletes a pointer and then zeroes it.
83 void DeleteZero(T*& pr)
90 // Drops to the unprivileged user/group specified in <security:runas{user,group}>.
94 ConfigTag* security = ServerInstance->Config->ConfValue("security");
96 const std::string SetGroup = security->getString("runasgroup");
97 if (!SetGroup.empty())
100 if (setgroups(0, NULL) == -1)
102 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
103 exit(EXIT_STATUS_CONFIG);
106 struct group* g = getgrnam(SetGroup.c_str());
109 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
110 exit(EXIT_STATUS_CONFIG);
113 if (setgid(g->gr_gid) == -1)
115 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setgid(%d) failed (wrong group?): %s", g->gr_gid, strerror(errno));
116 exit(EXIT_STATUS_CONFIG);
120 const std::string SetUser = security->getString("runasuser");
121 if (!SetUser.empty())
124 struct passwd* u = getpwnam(SetUser.c_str());
127 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
128 exit(EXIT_STATUS_CONFIG);
131 if (setuid(u->pw_uid) == -1)
133 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setuid(%d) failed (wrong user?): %s", u->pw_uid, strerror(errno));
134 exit(EXIT_STATUS_CONFIG);
140 // Seeds the random number generator if applicable.
141 void SeedRng(timespec ts)
144 srand(ts.tv_nsec ^ ts.tv_sec);
145 #elif !defined HAS_ARC4RANDOM_BUF
146 srandom(ts.tv_nsec ^ ts.tv_sec);
150 // Required for returning the proper value of EXIT_SUCCESS for the parent process.
151 void VoidSignalHandler(int)
153 exit(EXIT_STATUS_NOERROR);
157 void InspIRCd::Cleanup()
159 // Close all listening sockets
160 for (unsigned int i = 0; i < ports.size(); i++)
167 // Tell modules that we're shutting down.
168 const std::string quitmsg = "Server shutting down";
169 FOREACH_MOD(OnShutdown, (quitmsg));
171 // Disconnect all local users
172 const UserManager::LocalList& list = Users.GetLocalUsers();
173 while (!list.empty())
174 ServerInstance->Users.QuitUser(list.front(), quitmsg);
177 Modules->UnloadAll();
179 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
180 /* Must be deleted before modes as it decrements modelines */
183 delete FakeClient->server;
186 DeleteZero(this->FakeClient);
187 DeleteZero(this->XLines);
188 DeleteZero(this->Config);
189 SocketEngine::Deinit();
193 void InspIRCd::SetSignals()
196 signal(SIGALRM, SIG_IGN);
197 signal(SIGCHLD, SIG_IGN);
198 signal(SIGHUP, InspIRCd::SetSignal);
199 signal(SIGPIPE, SIG_IGN);
200 signal(SIGUSR1, SIG_IGN);
201 signal(SIGUSR2, SIG_IGN);
202 signal(SIGXFSZ, SIG_IGN);
204 signal(SIGTERM, InspIRCd::SetSignal);
207 bool InspIRCd::DaemonSeed()
210 std::cout << "InspIRCd Process ID: " << con_green << GetCurrentProcessId() << con_reset << std::endl;
213 // Do not use exit() here: It will exit with status SIGTERM which would break e.g. daemon scripts
214 signal(SIGTERM, VoidSignalHandler);
216 int childpid = fork();
219 else if (childpid > 0)
221 /* We wait here for the child process to kill us,
222 * so that the shell prompt doesnt come back over
224 * Sending a kill with a signal of 0 just checks
225 * if the child pid is still around. If theyre not,
226 * they threw an error and we should give up.
228 while (kill(childpid, 0) != -1)
230 exit(EXIT_STATUS_NOERROR);
233 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
235 signal(SIGTERM, InspIRCd::SetSignal);
238 if (getrlimit(RLIMIT_CORE, &rl) == -1)
240 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to getrlimit()!");
243 rl.rlim_cur = rl.rlim_max;
245 if (setrlimit(RLIMIT_CORE, &rl) == -1)
246 this->Logs->Log("STARTUP", LOG_DEFAULT, "setrlimit() failed, cannot increase coredump size.");
252 void InspIRCd::WritePID(const std::string& filename, bool exitonfail)
255 if (!ServerInstance->Config->cmdline.writepid)
257 this->Logs->Log("STARTUP", LOG_DEFAULT, "--nopid specified on command line; PID file not written.");
261 std::string fname = ServerInstance->Config->Paths.PrependData(filename.empty() ? "inspircd.pid" : filename);
262 std::ofstream outfile(fname.c_str());
263 if (outfile.is_open())
271 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
272 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s'%s", fname.c_str(), (exitonfail ? ", exiting." : ""));
274 Exit(EXIT_STATUS_PID);
279 InspIRCd::InspIRCd(int argc, char** argv)
281 , ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf")
285 , PI(&DefaultProtocolInterface)
286 , GenRandom(&DefaultGenRandom)
287 , IsChannel(&DefaultIsChannel)
288 , IsNick(&DefaultIsNick)
289 , IsIdent(&DefaultIsIdent)
291 ServerInstance = this;
294 this->startup_time = TIME.tv_sec;
297 SocketEngine::Init();
299 this->Config = new ServerConfig;
300 dynamic_reference_base::reset_all();
301 this->XLines = new XLineManager;
303 this->Config->cmdline.argv = argv;
304 this->Config->cmdline.argc = argc;
307 // Initialize the console values
308 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
309 CONSOLE_SCREEN_BUFFER_INFO bufinf;
310 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
312 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
313 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
317 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
318 g_wBackgroundColor = 0;
323 ServiceProvider* provs[] =
325 &rfcevents.numeric, &rfcevents.join, &rfcevents.part, &rfcevents.kick, &rfcevents.quit, &rfcevents.nick,
326 &rfcevents.mode, &rfcevents.topic, &rfcevents.privmsg, &rfcevents.invite, &rfcevents.ping, &rfcevents.pong,
329 Modules.AddServices(provs, sizeof(provs)/sizeof(provs[0]));
332 // Flag variables passed to getopt_long() later
333 int do_version = 0, do_nofork = 0, do_debug = 0,
334 do_nolog = 0, do_nopid = 0, do_root = 0;
335 struct option longopts[] =
337 { "nofork", no_argument, &do_nofork, 1 },
338 { "config", required_argument, NULL, 'c' },
339 { "debug", no_argument, &do_debug, 1 },
340 { "nolog", no_argument, &do_nolog, 1 },
341 { "nopid", no_argument, &do_nopid, 1 },
342 { "runasroot", no_argument, &do_root, 1 },
343 { "version", no_argument, &do_version, 1 },
349 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
354 /* Config filename was set */
355 ConfigFileName = optarg;
357 TCHAR configPath[MAX_PATH + 1];
358 if (GetFullPathName(optarg, MAX_PATH, configPath, NULL) > 0)
359 ConfigFileName = configPath;
361 char configPath[PATH_MAX + 1];
362 if (realpath(optarg, configPath))
363 ConfigFileName = configPath;
367 /* getopt_long_only() set an int variable, just keep going */
370 /* Unknown parameter */
372 /* Fall through to handle other weird values too */
373 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
374 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--nopid] [--debug] [--config <config>]" << std::endl <<
375 std::string(static_cast<size_t>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
376 Exit(EXIT_STATUS_ARGV);
383 std::cout << std::endl << INSPIRCD_VERSION << std::endl;
384 Exit(EXIT_STATUS_NOERROR);
390 WSAStartup(MAKEWORD(2,2), &wsadata);
393 /* Set the finished argument values */
394 Config->cmdline.nofork = (do_nofork != 0);
395 Config->cmdline.forcedebug = (do_debug != 0);
396 Config->cmdline.writelog = !do_nolog;
397 Config->cmdline.writepid = !do_nopid;
401 FileWriter* fw = new FileWriter(stdout, 1);
402 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
403 Logs->AddLogTypes("*", fls, true);
406 if (!FileSystem::FileExists(ConfigFileName))
409 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
410 std::string txtconf = this->ConfigFileName;
411 txtconf.append(".txt");
413 if (FileSystem::FileExists(txtconf))
415 ConfigFileName = txtconf;
420 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
421 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
422 Exit(EXIT_STATUS_CONFIG);
426 std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl;
427 std::cout << "For contributors & authors: " << con_green << "See /INFO Output" << con_reset << std::endl;
434 std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
435 << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
436 << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
437 << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
438 << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
439 << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
440 << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
441 << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
448 if (!Config->cmdline.nofork)
450 if (!this->DaemonSeed())
452 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
453 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
454 Exit(EXIT_STATUS_FORK);
458 SocketEngine::RecoverFromFork();
460 /* During startup we read the configuration now, not in
463 this->Config->Read();
464 this->Config->Apply(NULL, "");
465 Logs->OpenFileLogs();
467 // If we don't have a SID, generate one based on the server name and the server description
468 if (Config->sid.empty())
469 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
471 // Initialize the UID generator with our sid
472 this->UIDGen.init(Config->sid);
474 // Create the server user for this server
475 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
477 // This is needed as all new XLines are marked pending until ApplyLines() is called
478 this->XLines->ApplyLines();
481 int bounditems = BindPorts(pl);
483 std::cout << std::endl;
485 this->Modules->LoadAll();
487 // Build ISupport as ModuleManager::LoadAll() does not do it
488 this->ISupport.Build();
492 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
493 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
494 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
496 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
498 std::cout << j << ".\tAddress: " << i->first.str() << " \tReason: " << strerror(i->second) << std::endl;
501 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
504 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
507 if (!Config->cmdline.nofork)
509 if (kill(getppid(), SIGTERM) == -1)
511 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
512 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
516 /* Explicitly shut down stdio's stdin/stdout/stderr.
518 * The previous logic here was to only do this if stdio was connected to a controlling
519 * terminal. However, we must do this always to avoid information leaks and other
520 * problems related to stdio.
522 * The only exception is if we are in debug mode.
526 if ((!do_nofork) && (!Config->cmdline.forcedebug))
528 int fd = open("/dev/null", O_RDWR);
534 if (dup2(fd, STDIN_FILENO) < 0)
535 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
536 if (dup2(fd, STDOUT_FILENO) < 0)
537 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
538 if (dup2(fd, STDERR_FILENO) < 0)
539 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
544 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
547 /* Set win32 service as running, if we are running as a service */
556 QueryPerformanceFrequency(&stats.QPFrequency);
559 WritePID(Config->PID);
562 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %lu max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
565 void InspIRCd::UpdateTime()
571 TIME.tv_sec = time(NULL);
572 TIME.tv_nsec = st.wMilliseconds;
574 #ifdef HAS_CLOCK_GETTIME
575 clock_gettime(CLOCK_REALTIME, &TIME);
578 gettimeofday(&tv, NULL);
579 TIME.tv_sec = tv.tv_sec;
580 TIME.tv_nsec = tv.tv_usec * 1000;
588 time_t OLDTIME = TIME.tv_sec;
596 /* Check if there is a config thread which has finished executing but has not yet been freed */
597 if (this->ConfigThread && this->ConfigThread->IsDone())
599 /* Rehash has completed */
600 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
602 this->ConfigThread->Finish();
604 ConfigThread->join();
611 /* Run background module timers every few seconds
612 * (the docs say modules shouldnt rely on accurate
613 * timing using this event, so we dont have to
614 * time this exactly).
616 if (TIME.tv_sec != OLDTIME)
619 getrusage(RUSAGE_SELF, &ru);
620 stats.LastSampled = TIME;
621 stats.LastCPU = ru.ru_utime;
623 if(QueryPerformanceCounter(&stats.LastSampled))
625 FILETIME CreationTime;
629 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
630 stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
631 stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
635 if (Config->TimeSkipWarn)
637 time_t timediff = TIME.tv_sec - OLDTIME;
639 if (timediff > Config->TimeSkipWarn)
640 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped forwards by %lu seconds!", timediff);
642 else if (timediff < -Config->TimeSkipWarn)
643 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped backwards by %lu seconds!", labs(timediff));
646 OLDTIME = TIME.tv_sec;
648 if ((TIME.tv_sec % 3600) == 0)
650 FOREACH_MOD(OnGarbageCollect, ());
652 // HACK: ELines are not expired properly at the moment but it can't be fixed as
653 // the 2.0 XLine system is a spaghetti nightmare. Instead we skip over expired
654 // ELines in XLineManager::CheckELines() and expire them here instead.
658 Timers.TickTimers(TIME.tv_sec);
659 Users->DoBackgroundUserStuff();
661 if ((TIME.tv_sec % 5) == 0)
663 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
664 SNO->FlushSnotices();
668 /* Call the socket engine to wait on the active
669 * file descriptors. The socket engine has everything's
670 * descriptors in its list... dns, modules, users,
671 * servers... so its nice and easy, just one call.
672 * This will cause any read or write events to be
673 * dispatched to their handlers.
675 SocketEngine::DispatchTrialWrites();
676 SocketEngine::DispatchEvents();
678 /* if any users were quit, take them out */
684 this->SignalHandler(s_signal);
690 sig_atomic_t InspIRCd::s_signal = 0;
692 void InspIRCd::SetSignal(int signal)
697 /* On posix systems, the flow of the program starts right here, with
698 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
699 * defines smain() and the real main() is in the service code under
700 * win32service.cpp. This allows the service control manager to control
701 * the process where we are running as a windows service.
705 new InspIRCd(argc, argv);
706 ServerInstance->Run();
707 delete ServerInstance;