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 void VoidSignalHandler(int);
83 // Deletes a pointer and then zeroes it.
85 void DeleteZero(T*& pr)
92 // Drops to the unprivileged user/group specified in <security:runas{user,group}>.
96 ConfigTag* security = ServerInstance->Config->ConfValue("security");
98 const std::string SetGroup = security->getString("runasgroup");
99 if (!SetGroup.empty())
102 if (setgroups(0, NULL) == -1)
104 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
105 exit(EXIT_STATUS_CONFIG);
108 struct group* g = getgrnam(SetGroup.c_str());
111 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
112 exit(EXIT_STATUS_CONFIG);
115 if (setgid(g->gr_gid) == -1)
117 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setgid(%d) failed (wrong group?): %s", g->gr_gid, strerror(errno));
118 exit(EXIT_STATUS_CONFIG);
122 const std::string SetUser = security->getString("runasuser");
123 if (!SetUser.empty())
126 struct passwd* u = getpwnam(SetUser.c_str());
129 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
130 exit(EXIT_STATUS_CONFIG);
133 if (setuid(u->pw_uid) == -1)
135 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setuid(%d) failed (wrong user?): %s", u->pw_uid, strerror(errno));
136 exit(EXIT_STATUS_CONFIG);
142 // Attempts to fork into the background.
143 bool ForkIntoBackground()
146 // We use VoidSignalHandler whilst forking to avoid breaking daemon scripts
147 // if the parent process exits with SIGTERM (15) instead of EXIT_STATUS_NOERROR (0).
148 signal(SIGTERM, VoidSignalHandler);
151 int childpid = fork();
154 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "fork() failed: %s", strerror(errno));
157 else if (childpid > 0)
159 // Wait until the child process kills the parent so that the shell prompt
160 // doesnt display over the output. Sending a kill with a signal of 0 just
161 // checks that the child pid is still running. If it is not then an error
162 // happened and the parent should exit.
163 while (kill(childpid, 0) != -1)
165 exit(EXIT_STATUS_NOERROR);
170 signal(SIGTERM, InspIRCd::SetSignal);
176 // Increase the size of a core dump file to improve debugging problems.
177 void IncreaseCoreDumpSize()
182 if (getrlimit(RLIMIT_CORE, &rl) == -1)
184 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to increase core dump size: getrlimit(RLIMIT_CORE) failed: %s", strerror(errno));
188 rl.rlim_cur = rl.rlim_max;
189 if (setrlimit(RLIMIT_CORE, &rl) == -1)
190 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to increase core dump size: setrlimit(RLIMIT_CORE) failed: %s", strerror(errno));
194 // Seeds the random number generator if applicable.
195 void SeedRng(timespec ts)
198 srand(ts.tv_nsec ^ ts.tv_sec);
199 #elif !defined HAS_ARC4RANDOM_BUF
200 srandom(ts.tv_nsec ^ ts.tv_sec);
204 // Sets handlers for various process signals.
208 signal(SIGALRM, SIG_IGN);
209 signal(SIGCHLD, SIG_IGN);
210 signal(SIGHUP, InspIRCd::SetSignal);
211 signal(SIGPIPE, SIG_IGN);
212 signal(SIGUSR1, SIG_IGN);
213 signal(SIGUSR2, SIG_IGN);
214 signal(SIGXFSZ, SIG_IGN);
216 signal(SIGTERM, InspIRCd::SetSignal);
219 // Required for returning the proper value of EXIT_SUCCESS for the parent process.
220 void VoidSignalHandler(int)
222 exit(EXIT_STATUS_NOERROR);
226 void InspIRCd::Cleanup()
228 // Close all listening sockets
229 for (unsigned int i = 0; i < ports.size(); i++)
236 // Tell modules that we're shutting down.
237 const std::string quitmsg = "Server shutting down";
238 FOREACH_MOD(OnShutdown, (quitmsg));
240 // Disconnect all local users
241 const UserManager::LocalList& list = Users.GetLocalUsers();
242 while (!list.empty())
243 ServerInstance->Users.QuitUser(list.front(), quitmsg);
246 Modules->UnloadAll();
248 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
249 /* Must be deleted before modes as it decrements modelines */
252 delete FakeClient->server;
255 DeleteZero(this->FakeClient);
256 DeleteZero(this->XLines);
257 DeleteZero(this->Config);
258 SocketEngine::Deinit();
262 void InspIRCd::WritePID(const std::string& filename, bool exitonfail)
265 if (!ServerInstance->Config->cmdline.writepid)
267 this->Logs->Log("STARTUP", LOG_DEFAULT, "--nopid specified on command line; PID file not written.");
271 std::string fname = ServerInstance->Config->Paths.PrependData(filename.empty() ? "inspircd.pid" : filename);
272 std::ofstream outfile(fname.c_str());
273 if (outfile.is_open())
281 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
282 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s'%s", fname.c_str(), (exitonfail ? ", exiting." : ""));
284 Exit(EXIT_STATUS_PID);
289 InspIRCd::InspIRCd(int argc, char** argv)
291 , ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf")
295 , PI(&DefaultProtocolInterface)
296 , GenRandom(&DefaultGenRandom)
297 , IsChannel(&DefaultIsChannel)
298 , IsNick(&DefaultIsNick)
299 , IsIdent(&DefaultIsIdent)
301 ServerInstance = this;
304 this->startup_time = TIME.tv_sec;
307 SocketEngine::Init();
309 this->Config = new ServerConfig;
310 dynamic_reference_base::reset_all();
311 this->XLines = new XLineManager;
313 this->Config->cmdline.argv = argv;
314 this->Config->cmdline.argc = argc;
317 // Initialize the console values
318 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
319 CONSOLE_SCREEN_BUFFER_INFO bufinf;
320 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
322 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
323 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
327 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
328 g_wBackgroundColor = 0;
333 ServiceProvider* provs[] =
335 &rfcevents.numeric, &rfcevents.join, &rfcevents.part, &rfcevents.kick, &rfcevents.quit, &rfcevents.nick,
336 &rfcevents.mode, &rfcevents.topic, &rfcevents.privmsg, &rfcevents.invite, &rfcevents.ping, &rfcevents.pong,
339 Modules.AddServices(provs, sizeof(provs)/sizeof(provs[0]));
342 // Flag variables passed to getopt_long() later
343 int do_version = 0, do_nofork = 0, do_debug = 0,
344 do_nolog = 0, do_nopid = 0, do_root = 0;
345 struct option longopts[] =
347 { "nofork", no_argument, &do_nofork, 1 },
348 { "config", required_argument, NULL, 'c' },
349 { "debug", no_argument, &do_debug, 1 },
350 { "nolog", no_argument, &do_nolog, 1 },
351 { "nopid", no_argument, &do_nopid, 1 },
352 { "runasroot", no_argument, &do_root, 1 },
353 { "version", no_argument, &do_version, 1 },
359 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
364 /* Config filename was set */
365 ConfigFileName = optarg;
367 TCHAR configPath[MAX_PATH + 1];
368 if (GetFullPathName(optarg, MAX_PATH, configPath, NULL) > 0)
369 ConfigFileName = configPath;
371 char configPath[PATH_MAX + 1];
372 if (realpath(optarg, configPath))
373 ConfigFileName = configPath;
377 /* getopt_long_only() set an int variable, just keep going */
380 /* Unknown parameter */
382 /* Fall through to handle other weird values too */
383 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
384 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--nopid] [--debug] [--config <config>]" << std::endl <<
385 std::string(static_cast<size_t>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
386 Exit(EXIT_STATUS_ARGV);
393 std::cout << std::endl << INSPIRCD_VERSION << std::endl;
394 Exit(EXIT_STATUS_NOERROR);
400 WSAStartup(MAKEWORD(2,2), &wsadata);
403 /* Set the finished argument values */
404 Config->cmdline.nofork = (do_nofork != 0);
405 Config->cmdline.forcedebug = (do_debug != 0);
406 Config->cmdline.writelog = !do_nolog;
407 Config->cmdline.writepid = !do_nopid;
411 FileWriter* fw = new FileWriter(stdout, 1);
412 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
413 Logs->AddLogTypes("*", fls, true);
416 if (!FileSystem::FileExists(ConfigFileName))
419 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
420 std::string txtconf = this->ConfigFileName;
421 txtconf.append(".txt");
423 if (FileSystem::FileExists(txtconf))
425 ConfigFileName = txtconf;
430 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
431 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
432 Exit(EXIT_STATUS_CONFIG);
436 std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl;
437 std::cout << "For contributors & authors: " << con_green << "See /INFO Output" << con_reset << std::endl;
444 std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
445 << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
446 << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
447 << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
448 << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
449 << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
450 << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
451 << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
458 if (!Config->cmdline.nofork && !ForkIntoBackground())
460 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
461 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
462 Exit(EXIT_STATUS_FORK);
465 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
467 IncreaseCoreDumpSize();
468 SocketEngine::RecoverFromFork();
470 /* During startup we read the configuration now, not in
473 this->Config->Read();
474 this->Config->Apply(NULL, "");
475 Logs->OpenFileLogs();
477 // If we don't have a SID, generate one based on the server name and the server description
478 if (Config->sid.empty())
479 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
481 // Initialize the UID generator with our sid
482 this->UIDGen.init(Config->sid);
484 // Create the server user for this server
485 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
487 // This is needed as all new XLines are marked pending until ApplyLines() is called
488 this->XLines->ApplyLines();
491 int bounditems = BindPorts(pl);
493 std::cout << std::endl;
495 this->Modules->LoadAll();
497 // Build ISupport as ModuleManager::LoadAll() does not do it
498 this->ISupport.Build();
502 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
503 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
504 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
506 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
508 std::cout << j << ".\tAddress: " << i->first.str() << " \tReason: " << strerror(i->second) << std::endl;
511 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
514 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
517 if (!Config->cmdline.nofork)
519 if (kill(getppid(), SIGTERM) == -1)
521 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
522 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
526 /* Explicitly shut down stdio's stdin/stdout/stderr.
528 * The previous logic here was to only do this if stdio was connected to a controlling
529 * terminal. However, we must do this always to avoid information leaks and other
530 * problems related to stdio.
532 * The only exception is if we are in debug mode.
536 if ((!do_nofork) && (!Config->cmdline.forcedebug))
538 int fd = open("/dev/null", O_RDWR);
544 if (dup2(fd, STDIN_FILENO) < 0)
545 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
546 if (dup2(fd, STDOUT_FILENO) < 0)
547 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
548 if (dup2(fd, STDERR_FILENO) < 0)
549 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
554 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
557 /* Set win32 service as running, if we are running as a service */
566 QueryPerformanceFrequency(&stats.QPFrequency);
569 WritePID(Config->PID);
572 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %lu max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
575 void InspIRCd::UpdateTime()
577 #if defined HAS_CLOCK_GETTIME
578 clock_gettime(CLOCK_REALTIME, &TIME);
583 TIME.tv_sec = time(NULL);
584 TIME.tv_nsec = st.wMilliseconds;
587 gettimeofday(&tv, NULL);
589 TIME.tv_sec = tv.tv_sec;
590 TIME.tv_nsec = tv.tv_usec * 1000;
597 time_t OLDTIME = TIME.tv_sec;
605 /* Check if there is a config thread which has finished executing but has not yet been freed */
606 if (this->ConfigThread && this->ConfigThread->IsDone())
608 /* Rehash has completed */
609 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
611 this->ConfigThread->Finish();
613 ConfigThread->join();
620 /* Run background module timers every few seconds
621 * (the docs say modules shouldnt rely on accurate
622 * timing using this event, so we dont have to
623 * time this exactly).
625 if (TIME.tv_sec != OLDTIME)
628 getrusage(RUSAGE_SELF, &ru);
629 stats.LastSampled = TIME;
630 stats.LastCPU = ru.ru_utime;
632 if(QueryPerformanceCounter(&stats.LastSampled))
634 FILETIME CreationTime;
638 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
639 stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
640 stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
644 if (Config->TimeSkipWarn)
646 time_t timediff = TIME.tv_sec - OLDTIME;
648 if (timediff > Config->TimeSkipWarn)
649 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped forwards by %lu seconds!", timediff);
651 else if (timediff < -Config->TimeSkipWarn)
652 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped backwards by %lu seconds!", labs(timediff));
655 OLDTIME = TIME.tv_sec;
657 if ((TIME.tv_sec % 3600) == 0)
659 FOREACH_MOD(OnGarbageCollect, ());
661 // HACK: ELines are not expired properly at the moment but it can't be fixed as
662 // the 2.0 XLine system is a spaghetti nightmare. Instead we skip over expired
663 // ELines in XLineManager::CheckELines() and expire them here instead.
667 Timers.TickTimers(TIME.tv_sec);
668 Users->DoBackgroundUserStuff();
670 if ((TIME.tv_sec % 5) == 0)
672 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
673 SNO->FlushSnotices();
677 /* Call the socket engine to wait on the active
678 * file descriptors. The socket engine has everything's
679 * descriptors in its list... dns, modules, users,
680 * servers... so its nice and easy, just one call.
681 * This will cause any read or write events to be
682 * dispatched to their handlers.
684 SocketEngine::DispatchTrialWrites();
685 SocketEngine::DispatchEvents();
687 /* if any users were quit, take them out */
693 this->SignalHandler(s_signal);
699 sig_atomic_t InspIRCd::s_signal = 0;
701 void InspIRCd::SetSignal(int signal)
706 /* On posix systems, the flow of the program starts right here, with
707 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
708 * defines smain() and the real main() is in the service code under
709 * win32service.cpp. This allows the service control manager to control
710 * the process where we are running as a windows service.
714 new InspIRCd(argc, argv);
715 ServerInstance->Run();
716 delete ServerInstance;