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 // Seeds the random number generator if applicable.
91 void SeedRng(timespec ts)
94 srand(ts.tv_nsec ^ ts.tv_sec);
95 #elif !defined HAS_ARC4RANDOM_BUF
96 srandom(ts.tv_nsec ^ ts.tv_sec);
100 // Required for returning the proper value of EXIT_SUCCESS for the parent process.
101 void VoidSignalHandler(int)
103 exit(EXIT_STATUS_NOERROR);
107 void InspIRCd::Cleanup()
109 // Close all listening sockets
110 for (unsigned int i = 0; i < ports.size(); i++)
117 // Tell modules that we're shutting down.
118 const std::string quitmsg = "Server shutting down";
119 FOREACH_MOD(OnShutdown, (quitmsg));
121 // Disconnect all local users
122 const UserManager::LocalList& list = Users.GetLocalUsers();
123 while (!list.empty())
124 ServerInstance->Users.QuitUser(list.front(), quitmsg);
127 Modules->UnloadAll();
129 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
130 /* Must be deleted before modes as it decrements modelines */
133 delete FakeClient->server;
136 DeleteZero(this->FakeClient);
137 DeleteZero(this->XLines);
138 DeleteZero(this->Config);
139 SocketEngine::Deinit();
143 void InspIRCd::SetSignals()
146 signal(SIGALRM, SIG_IGN);
147 signal(SIGCHLD, SIG_IGN);
148 signal(SIGHUP, InspIRCd::SetSignal);
149 signal(SIGPIPE, SIG_IGN);
150 signal(SIGUSR1, SIG_IGN);
151 signal(SIGUSR2, SIG_IGN);
152 signal(SIGXFSZ, SIG_IGN);
154 signal(SIGTERM, InspIRCd::SetSignal);
157 bool InspIRCd::DaemonSeed()
160 std::cout << "InspIRCd Process ID: " << con_green << GetCurrentProcessId() << con_reset << std::endl;
163 // Do not use exit() here: It will exit with status SIGTERM which would break e.g. daemon scripts
164 signal(SIGTERM, VoidSignalHandler);
166 int childpid = fork();
169 else if (childpid > 0)
171 /* We wait here for the child process to kill us,
172 * so that the shell prompt doesnt come back over
174 * Sending a kill with a signal of 0 just checks
175 * if the child pid is still around. If theyre not,
176 * they threw an error and we should give up.
178 while (kill(childpid, 0) != -1)
180 exit(EXIT_STATUS_NOERROR);
183 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
185 signal(SIGTERM, InspIRCd::SetSignal);
188 if (getrlimit(RLIMIT_CORE, &rl) == -1)
190 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to getrlimit()!");
193 rl.rlim_cur = rl.rlim_max;
195 if (setrlimit(RLIMIT_CORE, &rl) == -1)
196 this->Logs->Log("STARTUP", LOG_DEFAULT, "setrlimit() failed, cannot increase coredump size.");
202 void InspIRCd::WritePID(const std::string& filename, bool exitonfail)
205 if (!ServerInstance->Config->cmdline.writepid)
207 this->Logs->Log("STARTUP", LOG_DEFAULT, "--nopid specified on command line; PID file not written.");
211 std::string fname = ServerInstance->Config->Paths.PrependData(filename.empty() ? "inspircd.pid" : filename);
212 std::ofstream outfile(fname.c_str());
213 if (outfile.is_open())
221 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
222 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s'%s", fname.c_str(), (exitonfail ? ", exiting." : ""));
224 Exit(EXIT_STATUS_PID);
229 InspIRCd::InspIRCd(int argc, char** argv)
231 , ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf")
235 , PI(&DefaultProtocolInterface)
236 , GenRandom(&DefaultGenRandom)
237 , IsChannel(&DefaultIsChannel)
238 , IsNick(&DefaultIsNick)
239 , IsIdent(&DefaultIsIdent)
241 ServerInstance = this;
244 this->startup_time = TIME.tv_sec;
247 SocketEngine::Init();
249 this->Config = new ServerConfig;
250 dynamic_reference_base::reset_all();
251 this->XLines = new XLineManager;
253 this->Config->cmdline.argv = argv;
254 this->Config->cmdline.argc = argc;
257 // Initialize the console values
258 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
259 CONSOLE_SCREEN_BUFFER_INFO bufinf;
260 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
262 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
263 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
267 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
268 g_wBackgroundColor = 0;
273 ServiceProvider* provs[] =
275 &rfcevents.numeric, &rfcevents.join, &rfcevents.part, &rfcevents.kick, &rfcevents.quit, &rfcevents.nick,
276 &rfcevents.mode, &rfcevents.topic, &rfcevents.privmsg, &rfcevents.invite, &rfcevents.ping, &rfcevents.pong,
279 Modules.AddServices(provs, sizeof(provs)/sizeof(provs[0]));
282 // Flag variables passed to getopt_long() later
283 int do_version = 0, do_nofork = 0, do_debug = 0,
284 do_nolog = 0, do_nopid = 0, do_root = 0;
285 struct option longopts[] =
287 { "nofork", no_argument, &do_nofork, 1 },
288 { "config", required_argument, NULL, 'c' },
289 { "debug", no_argument, &do_debug, 1 },
290 { "nolog", no_argument, &do_nolog, 1 },
291 { "nopid", no_argument, &do_nopid, 1 },
292 { "runasroot", no_argument, &do_root, 1 },
293 { "version", no_argument, &do_version, 1 },
299 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
304 /* Config filename was set */
305 ConfigFileName = optarg;
307 TCHAR configPath[MAX_PATH + 1];
308 if (GetFullPathName(optarg, MAX_PATH, configPath, NULL) > 0)
309 ConfigFileName = configPath;
311 char configPath[PATH_MAX + 1];
312 if (realpath(optarg, configPath))
313 ConfigFileName = configPath;
317 /* getopt_long_only() set an int variable, just keep going */
320 /* Unknown parameter */
322 /* Fall through to handle other weird values too */
323 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
324 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--nopid] [--debug] [--config <config>]" << std::endl <<
325 std::string(static_cast<size_t>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
326 Exit(EXIT_STATUS_ARGV);
333 std::cout << std::endl << INSPIRCD_VERSION << std::endl;
334 Exit(EXIT_STATUS_NOERROR);
340 WSAStartup(MAKEWORD(2,2), &wsadata);
343 /* Set the finished argument values */
344 Config->cmdline.nofork = (do_nofork != 0);
345 Config->cmdline.forcedebug = (do_debug != 0);
346 Config->cmdline.writelog = !do_nolog;
347 Config->cmdline.writepid = !do_nopid;
351 FileWriter* fw = new FileWriter(stdout, 1);
352 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
353 Logs->AddLogTypes("*", fls, true);
356 if (!FileSystem::FileExists(ConfigFileName))
359 /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
360 std::string txtconf = this->ConfigFileName;
361 txtconf.append(".txt");
363 if (FileSystem::FileExists(txtconf))
365 ConfigFileName = txtconf;
370 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
371 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
372 Exit(EXIT_STATUS_CONFIG);
376 std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl;
377 std::cout << "For contributors & authors: " << con_green << "See /INFO Output" << con_reset << std::endl;
384 std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
385 << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
386 << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
387 << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
388 << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
389 << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
390 << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
391 << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
398 if (!Config->cmdline.nofork)
400 if (!this->DaemonSeed())
402 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
403 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
404 Exit(EXIT_STATUS_FORK);
408 SocketEngine::RecoverFromFork();
410 /* During startup we read the configuration now, not in
413 this->Config->Read();
414 this->Config->Apply(NULL, "");
415 Logs->OpenFileLogs();
417 // If we don't have a SID, generate one based on the server name and the server description
418 if (Config->sid.empty())
419 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
421 // Initialize the UID generator with our sid
422 this->UIDGen.init(Config->sid);
424 // Create the server user for this server
425 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
427 // This is needed as all new XLines are marked pending until ApplyLines() is called
428 this->XLines->ApplyLines();
431 int bounditems = BindPorts(pl);
433 std::cout << std::endl;
435 this->Modules->LoadAll();
437 // Build ISupport as ModuleManager::LoadAll() does not do it
438 this->ISupport.Build();
442 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
443 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
444 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
446 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
448 std::cout << j << ".\tAddress: " << i->first.str() << " \tReason: " << strerror(i->second) << std::endl;
451 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
454 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
457 if (!Config->cmdline.nofork)
459 if (kill(getppid(), SIGTERM) == -1)
461 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
462 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
466 /* Explicitly shut down stdio's stdin/stdout/stderr.
468 * The previous logic here was to only do this if stdio was connected to a controlling
469 * terminal. However, we must do this always to avoid information leaks and other
470 * problems related to stdio.
472 * The only exception is if we are in debug mode.
476 if ((!do_nofork) && (!Config->cmdline.forcedebug))
478 int fd = open("/dev/null", O_RDWR);
484 if (dup2(fd, STDIN_FILENO) < 0)
485 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
486 if (dup2(fd, STDOUT_FILENO) < 0)
487 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
488 if (dup2(fd, STDERR_FILENO) < 0)
489 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
494 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
497 /* Set win32 service as running, if we are running as a service */
506 QueryPerformanceFrequency(&stats.QPFrequency);
509 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %lu max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
512 ConfigTag* security = Config->ConfValue("security");
514 const std::string SetGroup = security->getString("runasgroup");
515 if (!SetGroup.empty())
518 if (setgroups(0, NULL) == -1)
520 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
521 exit(EXIT_STATUS_CONFIG);
524 struct group* g = getgrnam(SetGroup.c_str());
527 this->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
528 exit(EXIT_STATUS_CONFIG);
531 if (setgid(g->gr_gid) == -1)
533 this->Logs->Log("STARTUP", LOG_DEFAULT, "setgid(%d) failed (wrong group?): %s", g->gr_gid, strerror(errno));
534 exit(EXIT_STATUS_CONFIG);
538 const std::string SetUser = security->getString("runasuser");
539 if (!SetUser.empty())
542 struct passwd* u = getpwnam(SetUser.c_str());
545 this->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
546 exit(EXIT_STATUS_CONFIG);
549 if (setuid(u->pw_uid) == -1)
551 this->Logs->Log("STARTUP", LOG_DEFAULT, "setuid(%d) failed (wrong user?): %s", u->pw_uid, strerror(errno));
552 exit(EXIT_STATUS_CONFIG);
556 this->WritePID(Config->PID);
560 void InspIRCd::UpdateTime()
566 TIME.tv_sec = time(NULL);
567 TIME.tv_nsec = st.wMilliseconds;
569 #ifdef HAS_CLOCK_GETTIME
570 clock_gettime(CLOCK_REALTIME, &TIME);
573 gettimeofday(&tv, NULL);
574 TIME.tv_sec = tv.tv_sec;
575 TIME.tv_nsec = tv.tv_usec * 1000;
583 time_t OLDTIME = TIME.tv_sec;
591 /* Check if there is a config thread which has finished executing but has not yet been freed */
592 if (this->ConfigThread && this->ConfigThread->IsDone())
594 /* Rehash has completed */
595 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
597 this->ConfigThread->Finish();
599 ConfigThread->join();
606 /* Run background module timers every few seconds
607 * (the docs say modules shouldnt rely on accurate
608 * timing using this event, so we dont have to
609 * time this exactly).
611 if (TIME.tv_sec != OLDTIME)
614 getrusage(RUSAGE_SELF, &ru);
615 stats.LastSampled = TIME;
616 stats.LastCPU = ru.ru_utime;
618 if(QueryPerformanceCounter(&stats.LastSampled))
620 FILETIME CreationTime;
624 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
625 stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
626 stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
630 if (Config->TimeSkipWarn)
632 time_t timediff = TIME.tv_sec - OLDTIME;
634 if (timediff > Config->TimeSkipWarn)
635 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped forwards by %lu seconds!", timediff);
637 else if (timediff < -Config->TimeSkipWarn)
638 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped backwards by %lu seconds!", labs(timediff));
641 OLDTIME = TIME.tv_sec;
643 if ((TIME.tv_sec % 3600) == 0)
645 FOREACH_MOD(OnGarbageCollect, ());
647 // HACK: ELines are not expired properly at the moment but it can't be fixed as
648 // the 2.0 XLine system is a spaghetti nightmare. Instead we skip over expired
649 // ELines in XLineManager::CheckELines() and expire them here instead.
653 Timers.TickTimers(TIME.tv_sec);
654 Users->DoBackgroundUserStuff();
656 if ((TIME.tv_sec % 5) == 0)
658 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
659 SNO->FlushSnotices();
663 /* Call the socket engine to wait on the active
664 * file descriptors. The socket engine has everything's
665 * descriptors in its list... dns, modules, users,
666 * servers... so its nice and easy, just one call.
667 * This will cause any read or write events to be
668 * dispatched to their handlers.
670 SocketEngine::DispatchTrialWrites();
671 SocketEngine::DispatchEvents();
673 /* if any users were quit, take them out */
679 this->SignalHandler(s_signal);
685 sig_atomic_t InspIRCd::s_signal = 0;
687 void InspIRCd::SetSignal(int signal)
692 /* On posix systems, the flow of the program starts right here, with
693 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
694 * defines smain() and the real main() is in the service code under
695 * win32service.cpp. This allows the service control manager to control
696 * the process where we are running as a windows service.
700 new InspIRCd(argc, argv);
701 ServerInstance->Run();
702 delete ServerInstance;