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 // Warns a user running as root that they probably shouldn't.
87 if (getegid() != 0 && geteuid() != 0)
90 std::cout << con_red << "Warning!" << con_reset << " You have started as root. Running as root is generally not required" << std::endl
91 << "and may allow an attacker to gain access to your system if they find a way to" << std::endl
92 << "exploit your IRC server." << std::endl
94 if (isatty(fileno(stdout)))
96 std::cout << "InspIRCd will start in 30 seconds. If you are sure that you need to run as root" << std::endl
97 << "then you can pass the " << con_bright << "--runasroot" << con_reset << " option to disable this wait." << std::endl;
102 std::cout << "If you are sure that you need to run as root then you can pass the " << con_bright << "--runasroot" << con_reset << std::endl
103 << "option to disable this error." << std::endl;
104 ServerInstance->Exit(EXIT_STATUS_ROOT);
109 // Collects performance statistics for the STATS command.
114 if (getrusage(RUSAGE_SELF, &ru) == -1)
115 return; // Should never happen.
117 ServerInstance->stats.LastSampled.tv_sec = ServerInstance->Time();
118 ServerInstance->stats.LastSampled.tv_nsec = ServerInstance->Time_ns();
119 ServerInstance->stats.LastCPU = ru.ru_utime;
121 if (!QueryPerformanceCounter(&ServerInstance->stats.LastSampled))
122 return; // Should never happen.
124 FILETIME CreationTime;
128 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
130 ServerInstance->stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
131 ServerInstance->stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
135 // Deletes a pointer and then zeroes it.
137 void DeleteZero(T*& pr)
144 // Drops to the unprivileged user/group specified in <security:runas{user,group}>.
148 ConfigTag* security = ServerInstance->Config->ConfValue("security");
150 const std::string SetGroup = security->getString("runasgroup");
151 if (!SetGroup.empty())
154 if (setgroups(0, NULL) == -1)
156 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
157 exit(EXIT_STATUS_CONFIG);
160 struct group* g = getgrnam(SetGroup.c_str());
163 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
164 exit(EXIT_STATUS_CONFIG);
167 if (setgid(g->gr_gid) == -1)
169 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setgid(%d) failed (wrong group?): %s", g->gr_gid, strerror(errno));
170 exit(EXIT_STATUS_CONFIG);
174 const std::string SetUser = security->getString("runasuser");
175 if (!SetUser.empty())
178 struct passwd* u = getpwnam(SetUser.c_str());
181 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
182 exit(EXIT_STATUS_CONFIG);
185 if (setuid(u->pw_uid) == -1)
187 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setuid(%d) failed (wrong user?): %s", u->pw_uid, strerror(errno));
188 exit(EXIT_STATUS_CONFIG);
194 // Expands a path relative to the current working directory.
195 std::string ExpandPath(const char* path)
198 TCHAR configPath[MAX_PATH + 1];
199 if (GetFullPathName(path, MAX_PATH, configPath, NULL) > 0)
202 char configPath[PATH_MAX + 1];
203 if (realpath(path, configPath))
209 // Locates a config file on the file system.
210 bool FindConfigFile(std::string& path)
212 if (FileSystem::FileExists(path))
216 // Windows hides file extensions by default so try appending .txt to the path
217 // to help users who have that feature enabled and can't create .conf files.
218 const std::string txtpath = path + ".txt";
219 if (FileSystem::FileExists(txtpath))
221 path.assign(txtpath);
228 // Attempts to fork into the background.
229 void ForkIntoBackground()
232 // We use VoidSignalHandler whilst forking to avoid breaking daemon scripts
233 // if the parent process exits with SIGTERM (15) instead of EXIT_STATUS_NOERROR (0).
234 signal(SIGTERM, VoidSignalHandler);
237 int childpid = fork();
240 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "fork() failed: %s", strerror(errno));
241 std::cout << con_red << "Error:" << con_reset << " unable to fork into background: " << strerror(errno);
242 ServerInstance->Exit(EXIT_STATUS_FORK);
244 else if (childpid > 0)
246 // Wait until the child process kills the parent so that the shell prompt
247 // doesnt display over the output. Sending a kill with a signal of 0 just
248 // checks that the child pid is still running. If it is not then an error
249 // happened and the parent should exit.
250 while (kill(childpid, 0) != -1)
252 exit(EXIT_STATUS_NOERROR);
257 signal(SIGTERM, InspIRCd::SetSignal);
258 SocketEngine::RecoverFromFork();
263 // Increase the size of a core dump file to improve debugging problems.
264 void IncreaseCoreDumpSize()
269 if (getrlimit(RLIMIT_CORE, &rl) == -1)
271 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to increase core dump size: getrlimit(RLIMIT_CORE) failed: %s", strerror(errno));
275 rl.rlim_cur = rl.rlim_max;
276 if (setrlimit(RLIMIT_CORE, &rl) == -1)
277 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to increase core dump size: setrlimit(RLIMIT_CORE) failed: %s", strerror(errno));
281 // Parses the command line options.
284 int do_debug = 0, do_nofork = 0, do_nolog = 0;
285 int do_nopid = 0, do_runasroot = 0, do_version = 0;
286 struct option longopts[] =
288 { "config", required_argument, NULL, 'c' },
289 { "debug", no_argument, &do_debug, 1 },
290 { "nofork", no_argument, &do_nofork, 1 },
291 { "nolog", no_argument, &do_nolog, 1 },
292 { "nopid", no_argument, &do_nopid, 1 },
293 { "runasroot", no_argument, &do_runasroot, 1 },
294 { "version", no_argument, &do_version, 1 },
298 char** argv = ServerInstance->Config->cmdline.argv;
300 while ((ret = getopt_long(ServerInstance->Config->cmdline.argc, argv, ":c:", longopts, NULL)) != -1)
305 // A long option was specified.
309 // The -c option was specified.
310 ServerInstance->ConfigFileName = ExpandPath(optarg);
314 // An unknown option was specified.
315 std::cout << con_red << "Error:" << con_reset << " unknown option '" << argv[optind - 1] << "'." << std::endl
316 << con_bright << "Usage: " << con_reset << argv[0] << " [--config <file>] [--debug] [--nofork] [--nolog]" << std::endl
317 << std::string(strlen(argv[0]) + 8, ' ') << "[--nopid] [--runasroot] [--version]" << std::endl;
318 ServerInstance->Exit(EXIT_STATUS_ARGV);
325 std::cout << std::endl << INSPIRCD_VERSION << std::endl;
326 ServerInstance->Exit(EXIT_STATUS_NOERROR);
329 // Store the relevant parsed arguments
330 ServerInstance->Config->cmdline.forcedebug = !!do_debug;
331 ServerInstance->Config->cmdline.nofork = !!do_nofork;
332 ServerInstance->Config->cmdline.runasroot = !!do_runasroot;
333 ServerInstance->Config->cmdline.writelog = !do_nolog;
334 ServerInstance->Config->cmdline.writepid = !do_nopid;
336 // Seeds the random number generator if applicable.
337 void SeedRng(timespec ts)
340 srand(ts.tv_nsec ^ ts.tv_sec);
341 #elif !defined HAS_ARC4RANDOM_BUF
342 srandom(ts.tv_nsec ^ ts.tv_sec);
346 // Sets handlers for various process signals.
350 signal(SIGALRM, SIG_IGN);
351 signal(SIGCHLD, SIG_IGN);
352 signal(SIGHUP, InspIRCd::SetSignal);
353 signal(SIGPIPE, SIG_IGN);
354 signal(SIGUSR1, SIG_IGN);
355 signal(SIGUSR2, SIG_IGN);
356 signal(SIGXFSZ, SIG_IGN);
358 signal(SIGTERM, InspIRCd::SetSignal);
361 // Required for returning the proper value of EXIT_SUCCESS for the parent process.
362 void VoidSignalHandler(int)
364 exit(EXIT_STATUS_NOERROR);
368 void InspIRCd::Cleanup()
370 // Close all listening sockets
371 for (unsigned int i = 0; i < ports.size(); i++)
378 // Tell modules that we're shutting down.
379 const std::string quitmsg = "Server shutting down";
380 FOREACH_MOD(OnShutdown, (quitmsg));
382 // Disconnect all local users
383 const UserManager::LocalList& list = Users.GetLocalUsers();
384 while (!list.empty())
385 ServerInstance->Users.QuitUser(list.front(), quitmsg);
388 Modules->UnloadAll();
390 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
391 /* Must be deleted before modes as it decrements modelines */
394 delete FakeClient->server;
397 DeleteZero(this->FakeClient);
398 DeleteZero(this->XLines);
399 DeleteZero(this->Config);
400 SocketEngine::Deinit();
404 void InspIRCd::WritePID(const std::string& filename, bool exitonfail)
407 if (!ServerInstance->Config->cmdline.writepid)
409 this->Logs->Log("STARTUP", LOG_DEFAULT, "--nopid specified on command line; PID file not written.");
413 std::string fname = ServerInstance->Config->Paths.PrependData(filename.empty() ? "inspircd.pid" : filename);
414 std::ofstream outfile(fname.c_str());
415 if (outfile.is_open())
423 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
424 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s'%s", fname.c_str(), (exitonfail ? ", exiting." : ""));
426 Exit(EXIT_STATUS_PID);
431 InspIRCd::InspIRCd(int argc, char** argv)
433 , ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf")
437 , PI(&DefaultProtocolInterface)
438 , GenRandom(&DefaultGenRandom)
439 , IsChannel(&DefaultIsChannel)
440 , IsNick(&DefaultIsNick)
441 , IsIdent(&DefaultIsIdent)
443 ServerInstance = this;
446 this->startup_time = TIME.tv_sec;
448 IncreaseCoreDumpSize();
450 SocketEngine::Init();
452 this->Config = new ServerConfig;
453 dynamic_reference_base::reset_all();
454 this->XLines = new XLineManager;
456 this->Config->cmdline.argv = argv;
457 this->Config->cmdline.argc = argc;
460 // Initialize the console values
461 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
462 CONSOLE_SCREEN_BUFFER_INFO bufinf;
463 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
465 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
466 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
470 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
471 g_wBackgroundColor = 0;
476 ServiceProvider* provs[] =
478 &rfcevents.numeric, &rfcevents.join, &rfcevents.part, &rfcevents.kick, &rfcevents.quit, &rfcevents.nick,
479 &rfcevents.mode, &rfcevents.topic, &rfcevents.privmsg, &rfcevents.invite, &rfcevents.ping, &rfcevents.pong,
482 Modules.AddServices(provs, sizeof(provs)/sizeof(provs[0]));
485 std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl
486 << "See " << con_green << "/INFO" << con_reset << " for contributors & authors" << std::endl
490 if (Config->cmdline.forcedebug)
492 FileWriter* fw = new FileWriter(stdout, 1);
493 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
494 Logs->AddLogTypes("*", fls, true);
497 if (!FindConfigFile(ConfigFileName))
499 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
500 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
501 Exit(EXIT_STATUS_CONFIG);
505 if (!Config->cmdline.runasroot)
507 if (!Config->cmdline.nofork)
508 ForkIntoBackground();
510 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
512 /* During startup we read the configuration now, not in
515 this->Config->Read();
516 this->Config->Apply(NULL, "");
517 Logs->OpenFileLogs();
519 // If we don't have a SID, generate one based on the server name and the server description
520 if (Config->sid.empty())
521 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
523 // Initialize the UID generator with our sid
524 this->UIDGen.init(Config->sid);
526 // Create the server user for this server
527 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
529 // This is needed as all new XLines are marked pending until ApplyLines() is called
530 this->XLines->ApplyLines();
533 size_t bounditems = BindPorts(pl);
535 std::cout << std::endl;
537 this->Modules->LoadAll();
539 // Build ISupport as ModuleManager::LoadAll() does not do it
540 this->ISupport.Build();
544 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
545 << " of " << (bounditems + pl.size()) << " client ports bound." << std::endl << std::endl;
546 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
548 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
550 std::cout << j << ".\tAddress: " << i->first.str() << " \tReason: " << strerror(i->second) << std::endl;
553 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
556 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
559 if (!Config->cmdline.nofork)
561 if (kill(getppid(), SIGTERM) == -1)
563 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
564 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
568 /* Explicitly shut down stdio's stdin/stdout/stderr.
570 * The previous logic here was to only do this if stdio was connected to a controlling
571 * terminal. However, we must do this always to avoid information leaks and other
572 * problems related to stdio.
574 * The only exception is if we are in debug mode.
578 if ((!Config->cmdline.nofork) && (!Config->cmdline.forcedebug))
580 int fd = open("/dev/null", O_RDWR);
586 if (dup2(fd, STDIN_FILENO) < 0)
587 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
588 if (dup2(fd, STDOUT_FILENO) < 0)
589 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
590 if (dup2(fd, STDERR_FILENO) < 0)
591 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
596 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
599 /* Set win32 service as running, if we are running as a service */
603 if(!Config->cmdline.nofork)
608 QueryPerformanceFrequency(&stats.QPFrequency);
611 WritePID(Config->PID);
614 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %lu max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
617 void InspIRCd::UpdateTime()
619 #if defined HAS_CLOCK_GETTIME
620 clock_gettime(CLOCK_REALTIME, &TIME);
625 TIME.tv_sec = time(NULL);
626 TIME.tv_nsec = st.wMilliseconds;
629 gettimeofday(&tv, NULL);
631 TIME.tv_sec = tv.tv_sec;
632 TIME.tv_nsec = tv.tv_usec * 1000;
639 time_t OLDTIME = TIME.tv_sec;
643 /* Check if there is a config thread which has finished executing but has not yet been freed */
644 if (this->ConfigThread && this->ConfigThread->IsDone())
646 /* Rehash has completed */
647 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
649 this->ConfigThread->Finish();
651 ConfigThread->join();
658 /* Run background module timers every few seconds
659 * (the docs say modules shouldnt rely on accurate
660 * timing using this event, so we dont have to
661 * time this exactly).
663 if (TIME.tv_sec != OLDTIME)
667 if (Config->TimeSkipWarn)
669 time_t timediff = TIME.tv_sec - OLDTIME;
671 if (timediff > Config->TimeSkipWarn)
672 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped forwards by %lu seconds!", timediff);
674 else if (timediff < -Config->TimeSkipWarn)
675 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped backwards by %lu seconds!", labs(timediff));
678 OLDTIME = TIME.tv_sec;
680 if ((TIME.tv_sec % 3600) == 0)
681 FOREACH_MOD(OnGarbageCollect, ());
683 Timers.TickTimers(TIME.tv_sec);
684 Users->DoBackgroundUserStuff();
686 if ((TIME.tv_sec % 5) == 0)
688 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
689 SNO->FlushSnotices();
693 /* Call the socket engine to wait on the active
694 * file descriptors. The socket engine has everything's
695 * descriptors in its list... dns, modules, users,
696 * servers... so its nice and easy, just one call.
697 * This will cause any read or write events to be
698 * dispatched to their handlers.
700 SocketEngine::DispatchTrialWrites();
701 SocketEngine::DispatchEvents();
703 /* if any users were quit, take them out */
709 this->SignalHandler(s_signal);
715 sig_atomic_t InspIRCd::s_signal = 0;
717 void InspIRCd::SetSignal(int signal)
722 /* On posix systems, the flow of the program starts right here, with
723 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
724 * defines smain() and the real main() is in the service code under
725 * win32service.cpp. This allows the service control manager to control
726 * the process where we are running as a windows service.
730 new InspIRCd(argc, argv);
731 ServerInstance->Run();
732 delete ServerInstance;