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 // Locates a config file on the file system.
195 bool FindConfigFile(std::string& path)
197 if (FileSystem::FileExists(path))
201 // Windows hides file extensions by default so try appending .txt to the path
202 // to help users who have that feature enabled and can't create .conf files.
203 const std::string txtpath = path + ".txt";
204 if (FileSystem::FileExists(txtpath))
206 path.assign(txtpath);
213 // Attempts to fork into the background.
214 bool ForkIntoBackground()
217 // We use VoidSignalHandler whilst forking to avoid breaking daemon scripts
218 // if the parent process exits with SIGTERM (15) instead of EXIT_STATUS_NOERROR (0).
219 signal(SIGTERM, VoidSignalHandler);
222 int childpid = fork();
225 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "fork() failed: %s", strerror(errno));
228 else if (childpid > 0)
230 // Wait until the child process kills the parent so that the shell prompt
231 // doesnt display over the output. Sending a kill with a signal of 0 just
232 // checks that the child pid is still running. If it is not then an error
233 // happened and the parent should exit.
234 while (kill(childpid, 0) != -1)
236 exit(EXIT_STATUS_NOERROR);
241 signal(SIGTERM, InspIRCd::SetSignal);
242 SocketEngine::RecoverFromFork();
248 // Increase the size of a core dump file to improve debugging problems.
249 void IncreaseCoreDumpSize()
254 if (getrlimit(RLIMIT_CORE, &rl) == -1)
256 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to increase core dump size: getrlimit(RLIMIT_CORE) failed: %s", strerror(errno));
260 rl.rlim_cur = rl.rlim_max;
261 if (setrlimit(RLIMIT_CORE, &rl) == -1)
262 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to increase core dump size: setrlimit(RLIMIT_CORE) failed: %s", strerror(errno));
266 // Seeds the random number generator if applicable.
267 void SeedRng(timespec ts)
270 srand(ts.tv_nsec ^ ts.tv_sec);
271 #elif !defined HAS_ARC4RANDOM_BUF
272 srandom(ts.tv_nsec ^ ts.tv_sec);
276 // Sets handlers for various process signals.
280 signal(SIGALRM, SIG_IGN);
281 signal(SIGCHLD, SIG_IGN);
282 signal(SIGHUP, InspIRCd::SetSignal);
283 signal(SIGPIPE, SIG_IGN);
284 signal(SIGUSR1, SIG_IGN);
285 signal(SIGUSR2, SIG_IGN);
286 signal(SIGXFSZ, SIG_IGN);
288 signal(SIGTERM, InspIRCd::SetSignal);
291 // Required for returning the proper value of EXIT_SUCCESS for the parent process.
292 void VoidSignalHandler(int)
294 exit(EXIT_STATUS_NOERROR);
298 void InspIRCd::Cleanup()
300 // Close all listening sockets
301 for (unsigned int i = 0; i < ports.size(); i++)
308 // Tell modules that we're shutting down.
309 const std::string quitmsg = "Server shutting down";
310 FOREACH_MOD(OnShutdown, (quitmsg));
312 // Disconnect all local users
313 const UserManager::LocalList& list = Users.GetLocalUsers();
314 while (!list.empty())
315 ServerInstance->Users.QuitUser(list.front(), quitmsg);
318 Modules->UnloadAll();
320 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
321 /* Must be deleted before modes as it decrements modelines */
324 delete FakeClient->server;
327 DeleteZero(this->FakeClient);
328 DeleteZero(this->XLines);
329 DeleteZero(this->Config);
330 SocketEngine::Deinit();
334 void InspIRCd::WritePID(const std::string& filename, bool exitonfail)
337 if (!ServerInstance->Config->cmdline.writepid)
339 this->Logs->Log("STARTUP", LOG_DEFAULT, "--nopid specified on command line; PID file not written.");
343 std::string fname = ServerInstance->Config->Paths.PrependData(filename.empty() ? "inspircd.pid" : filename);
344 std::ofstream outfile(fname.c_str());
345 if (outfile.is_open())
353 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
354 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s'%s", fname.c_str(), (exitonfail ? ", exiting." : ""));
356 Exit(EXIT_STATUS_PID);
361 InspIRCd::InspIRCd(int argc, char** argv)
363 , ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf")
367 , PI(&DefaultProtocolInterface)
368 , GenRandom(&DefaultGenRandom)
369 , IsChannel(&DefaultIsChannel)
370 , IsNick(&DefaultIsNick)
371 , IsIdent(&DefaultIsIdent)
373 ServerInstance = this;
376 this->startup_time = TIME.tv_sec;
378 IncreaseCoreDumpSize();
380 SocketEngine::Init();
382 this->Config = new ServerConfig;
383 dynamic_reference_base::reset_all();
384 this->XLines = new XLineManager;
386 this->Config->cmdline.argv = argv;
387 this->Config->cmdline.argc = argc;
390 // Initialize the console values
391 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
392 CONSOLE_SCREEN_BUFFER_INFO bufinf;
393 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
395 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
396 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
400 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
401 g_wBackgroundColor = 0;
406 ServiceProvider* provs[] =
408 &rfcevents.numeric, &rfcevents.join, &rfcevents.part, &rfcevents.kick, &rfcevents.quit, &rfcevents.nick,
409 &rfcevents.mode, &rfcevents.topic, &rfcevents.privmsg, &rfcevents.invite, &rfcevents.ping, &rfcevents.pong,
412 Modules.AddServices(provs, sizeof(provs)/sizeof(provs[0]));
415 // Flag variables passed to getopt_long() later
416 int do_version = 0, do_nofork = 0, do_debug = 0,
417 do_nolog = 0, do_nopid = 0, do_root = 0;
418 struct option longopts[] =
420 { "nofork", no_argument, &do_nofork, 1 },
421 { "config", required_argument, NULL, 'c' },
422 { "debug", no_argument, &do_debug, 1 },
423 { "nolog", no_argument, &do_nolog, 1 },
424 { "nopid", no_argument, &do_nopid, 1 },
425 { "runasroot", no_argument, &do_root, 1 },
426 { "version", no_argument, &do_version, 1 },
432 while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
437 /* Config filename was set */
438 ConfigFileName = optarg;
440 TCHAR configPath[MAX_PATH + 1];
441 if (GetFullPathName(optarg, MAX_PATH, configPath, NULL) > 0)
442 ConfigFileName = configPath;
444 char configPath[PATH_MAX + 1];
445 if (realpath(optarg, configPath))
446 ConfigFileName = configPath;
450 /* getopt_long_only() set an int variable, just keep going */
453 /* Unknown parameter */
455 /* Fall through to handle other weird values too */
456 std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
457 std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--nopid] [--debug] [--config <config>]" << std::endl <<
458 std::string(static_cast<size_t>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
459 Exit(EXIT_STATUS_ARGV);
466 std::cout << std::endl << INSPIRCD_VERSION << std::endl;
467 Exit(EXIT_STATUS_NOERROR);
470 /* Set the finished argument values */
471 Config->cmdline.nofork = (do_nofork != 0);
472 Config->cmdline.forcedebug = (do_debug != 0);
473 Config->cmdline.writelog = !do_nolog;
474 Config->cmdline.writepid = !do_nopid;
478 FileWriter* fw = new FileWriter(stdout, 1);
479 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
480 Logs->AddLogTypes("*", fls, true);
483 std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl
484 << "See " << con_green << "/INFO" << con_reset << " for contributors & authors" << std::endl
487 if (!FindConfigFile(ConfigFileName))
489 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
490 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
491 Exit(EXIT_STATUS_CONFIG);
498 if (!Config->cmdline.nofork && !ForkIntoBackground())
500 std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
501 Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
502 Exit(EXIT_STATUS_FORK);
505 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
507 /* During startup we read the configuration now, not in
510 this->Config->Read();
511 this->Config->Apply(NULL, "");
512 Logs->OpenFileLogs();
514 // If we don't have a SID, generate one based on the server name and the server description
515 if (Config->sid.empty())
516 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
518 // Initialize the UID generator with our sid
519 this->UIDGen.init(Config->sid);
521 // Create the server user for this server
522 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
524 // This is needed as all new XLines are marked pending until ApplyLines() is called
525 this->XLines->ApplyLines();
528 int bounditems = BindPorts(pl);
530 std::cout << std::endl;
532 this->Modules->LoadAll();
534 // Build ISupport as ModuleManager::LoadAll() does not do it
535 this->ISupport.Build();
539 std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
540 << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
541 std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
543 for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
545 std::cout << j << ".\tAddress: " << i->first.str() << " \tReason: " << strerror(i->second) << std::endl;
548 std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
551 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
554 if (!Config->cmdline.nofork)
556 if (kill(getppid(), SIGTERM) == -1)
558 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
559 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
563 /* Explicitly shut down stdio's stdin/stdout/stderr.
565 * The previous logic here was to only do this if stdio was connected to a controlling
566 * terminal. However, we must do this always to avoid information leaks and other
567 * problems related to stdio.
569 * The only exception is if we are in debug mode.
573 if ((!do_nofork) && (!Config->cmdline.forcedebug))
575 int fd = open("/dev/null", O_RDWR);
581 if (dup2(fd, STDIN_FILENO) < 0)
582 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
583 if (dup2(fd, STDOUT_FILENO) < 0)
584 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
585 if (dup2(fd, STDERR_FILENO) < 0)
586 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
591 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
594 /* Set win32 service as running, if we are running as a service */
603 QueryPerformanceFrequency(&stats.QPFrequency);
606 WritePID(Config->PID);
609 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %lu max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
612 void InspIRCd::UpdateTime()
614 #if defined HAS_CLOCK_GETTIME
615 clock_gettime(CLOCK_REALTIME, &TIME);
620 TIME.tv_sec = time(NULL);
621 TIME.tv_nsec = st.wMilliseconds;
624 gettimeofday(&tv, NULL);
626 TIME.tv_sec = tv.tv_sec;
627 TIME.tv_nsec = tv.tv_usec * 1000;
634 time_t OLDTIME = TIME.tv_sec;
638 /* Check if there is a config thread which has finished executing but has not yet been freed */
639 if (this->ConfigThread && this->ConfigThread->IsDone())
641 /* Rehash has completed */
642 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
644 this->ConfigThread->Finish();
646 ConfigThread->join();
653 /* Run background module timers every few seconds
654 * (the docs say modules shouldnt rely on accurate
655 * timing using this event, so we dont have to
656 * time this exactly).
658 if (TIME.tv_sec != OLDTIME)
662 if (Config->TimeSkipWarn)
664 time_t timediff = TIME.tv_sec - OLDTIME;
666 if (timediff > Config->TimeSkipWarn)
667 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped forwards by %lu seconds!", timediff);
669 else if (timediff < -Config->TimeSkipWarn)
670 SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped backwards by %lu seconds!", labs(timediff));
673 OLDTIME = TIME.tv_sec;
675 if ((TIME.tv_sec % 3600) == 0)
676 FOREACH_MOD(OnGarbageCollect, ());
678 Timers.TickTimers(TIME.tv_sec);
679 Users->DoBackgroundUserStuff();
681 if ((TIME.tv_sec % 5) == 0)
683 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
684 SNO->FlushSnotices();
688 /* Call the socket engine to wait on the active
689 * file descriptors. The socket engine has everything's
690 * descriptors in its list... dns, modules, users,
691 * servers... so its nice and easy, just one call.
692 * This will cause any read or write events to be
693 * dispatched to their handlers.
695 SocketEngine::DispatchTrialWrites();
696 SocketEngine::DispatchEvents();
698 /* if any users were quit, take them out */
704 this->SignalHandler(s_signal);
710 sig_atomic_t InspIRCd::s_signal = 0;
712 void InspIRCd::SetSignal(int signal)
717 /* On posix systems, the flow of the program starts right here, with
718 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
719 * defines smain() and the real main() is in the service code under
720 * win32service.cpp. This allows the service control manager to control
721 * the process where we are running as a windows service.
725 new InspIRCd(argc, argv);
726 ServerInstance->Run();
727 delete ServerInstance;