2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
6 * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
8 * This file is part of InspIRCd. InspIRCd is free software: you can
9 * redistribute it and/or modify it under the terms of the GNU General Public
10 * License as published by the Free Software Foundation, version 2.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 #pragma comment(lib, "psapi.lib") // For GetProcessMemoryInfo()
32 class CommandStats : public Command
34 void DoStats(Stats::Context& stats);
36 /** Constructor for stats.
38 CommandStats ( Module* parent) : Command(parent,"STATS",1,2) { allow_empty_last_param = false; syntax = "<stats-symbol> [<servername>]"; }
40 * @param parameters The parameters to the command
41 * @param user The user issuing the command
42 * @return A value from CmdResult to indicate command success or failure.
44 CmdResult Handle(const std::vector<std::string>& parameters, User *user);
45 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
47 if ((parameters.size() > 1) && (parameters[1].find('.') != std::string::npos))
48 return ROUTE_UNICAST(parameters[1]);
49 return ROUTE_LOCALONLY;
53 static void GenerateStatsLl(Stats::Context& stats)
55 stats.AddRow(211, InspIRCd::Format("nick[ident@%s] sendq cmds_out bytes_out cmds_in bytes_in time_open", (stats.GetSymbol() == 'l' ? "host" : "ip")));
57 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
58 for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
61 stats.AddRow(211, u->nick+"["+u->ident+"@"+(stats.GetSymbol() == 'l' ? u->dhost : u->GetIPString())+"] "+ConvToStr(u->eh.getSendQSize())+" "+ConvToStr(u->cmds_out)+" "+ConvToStr(u->bytes_out)+" "+ConvToStr(u->cmds_in)+" "+ConvToStr(u->bytes_in)+" "+ConvToStr(ServerInstance->Time() - u->signon));
65 void CommandStats::DoStats(Stats::Context& stats)
67 User* const user = stats.GetSource();
68 const char statschar = stats.GetSymbol();
70 bool isPublic = ServerInstance->Config->UserStats.find(statschar) != std::string::npos;
71 bool isRemoteOper = IS_REMOTE(user) && (user->IsOper());
72 bool isLocalOperWithPrivs = IS_LOCAL(user) && user->HasPrivPermission("servers/auspex");
74 if (!isPublic && !isRemoteOper && !isLocalOperWithPrivs)
76 ServerInstance->SNO->WriteToSnoMask('t',
77 "%s '%c' denied for %s (%s@%s)",
78 (IS_LOCAL(user) ? "Stats" : "Remote stats"),
79 statschar, user->nick.c_str(), user->ident.c_str(), user->host.c_str());
80 stats.AddRow(481, (std::string("Permission Denied - STATS ") + statschar + " requires the servers/auspex priv."));
85 FIRST_MOD_RESULT(OnStats, MOD_RESULT, (stats));
86 if (MOD_RESULT == MOD_RES_DENY)
88 stats.AddRow(219, statschar, "End of /STATS report");
89 ServerInstance->SNO->WriteToSnoMask('t',"%s '%c' requested by %s (%s@%s)",
90 (IS_LOCAL(user) ? "Stats" : "Remote stats"), statschar, user->nick.c_str(), user->ident.c_str(), user->host.c_str());
96 /* stats p (show listening ports) */
99 for (std::vector<ListenSocket*>::const_iterator i = ServerInstance->ports.begin(); i != ServerInstance->ports.end(); ++i)
101 ListenSocket* ls = *i;
102 std::string ip = ls->bind_addr;
105 else if (ip.find_first_of(':') != std::string::npos)
107 ip.insert(ip.begin(), '[');
108 ip.insert(ip.end(), ']');
110 std::string type = ls->bind_tag->getString("type", "clients");
111 std::string hook = ls->bind_tag->getString("ssl", "plaintext");
113 stats.AddRow(249, ip + ":"+ConvToStr(ls->bind_port) + " (" + type + ", " + hook + ")");
118 /* These stats symbols must be handled by a linking module */
125 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
127 ConnectClass* c = *i;
129 row.push("I").push(c->name);
132 if (c->type == CC_ALLOW)
133 param.push_back('+');
134 if (c->type == CC_DENY)
135 param.push_back('-');
137 if (c->type == CC_NAMED)
138 param.push_back('*');
140 param.append(c->host);
142 row.push(param).push(c->config->getString("port", "*"));
143 row.push(ConvToStr(c->GetRecvqMax())).push(ConvToStr(c->GetSendqSoftMax())).push(ConvToStr(c->GetSendqHardMax())).push(ConvToStr(c->GetCommandRate()));
145 param = ConvToStr(c->GetPenaltyThreshold());
147 param.push_back('*');
158 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); i++)
160 ConnectClass* c = *i;
161 stats.AddRow(215, 'i', "NOMATCH", '*', c->GetHost(), (c->limit ? c->limit : SocketEngine::GetMaxFds()), idx, ServerInstance->Config->ServerName, '*');
162 stats.AddRow(218, 'Y', idx, c->GetPingTime(), '0', c->GetSendqHardMax(), ConvToStr(c->GetRecvqMax())+" "+ConvToStr(c->GetRegTimeout()));
170 unsigned int idx = 0;
171 const UserManager::OperList& opers = ServerInstance->Users->all_opers;
172 for (UserManager::OperList::const_iterator i = opers.begin(); i != opers.end(); ++i)
175 if (!oper->server->IsULine())
177 LocalUser* lu = IS_LOCAL(oper);
178 stats.AddRow(249, oper->nick + " (" + oper->ident + "@" + oper->dhost + ") Idle: " +
179 (lu ? ConvToStr(ServerInstance->Time() - lu->idle_lastmsg) + " secs" : "unavailable"));
183 stats.AddRow(249, ConvToStr(idx)+" OPER(s)");
188 ServerInstance->XLines->InvokeStats("K",216,stats);
191 ServerInstance->XLines->InvokeStats("G",223,stats);
194 ServerInstance->XLines->InvokeStats("Q",217,stats);
197 ServerInstance->XLines->InvokeStats("Z",223,stats);
200 ServerInstance->XLines->InvokeStats("E",223,stats);
204 const SocketEngine::Statistics& sestats = SocketEngine::GetStats();
205 stats.AddRow(249, "Total events: "+ConvToStr(sestats.TotalEvents));
206 stats.AddRow(249, "Read events: "+ConvToStr(sestats.ReadEvents));
207 stats.AddRow(249, "Write events: "+ConvToStr(sestats.WriteEvents));
208 stats.AddRow(249, "Error events: "+ConvToStr(sestats.ErrorEvents));
212 /* stats m (list number of times each command has been used, plus bytecount) */
215 const CommandParser::CommandMap& commands = ServerInstance->Parser.GetCommands();
216 for (CommandParser::CommandMap::const_iterator i = commands.begin(); i != commands.end(); ++i)
218 if (i->second->use_count)
220 /* RPL_STATSCOMMANDS */
221 stats.AddRow(212, i->second->name, i->second->use_count);
227 /* stats z (debug and memory info) */
230 stats.AddRow(249, "Users: "+ConvToStr(ServerInstance->Users->GetUsers().size()));
231 stats.AddRow(249, "Channels: "+ConvToStr(ServerInstance->GetChans().size()));
232 stats.AddRow(249, "Commands: "+ConvToStr(ServerInstance->Parser.GetCommands().size()));
234 float kbitpersec_in, kbitpersec_out, kbitpersec_total;
235 SocketEngine::GetStats().GetBandwidth(kbitpersec_in, kbitpersec_out, kbitpersec_total);
237 stats.AddRow(249, InspIRCd::Format("Bandwidth total: %03.5f kilobits/sec", kbitpersec_total));
238 stats.AddRow(249, InspIRCd::Format("Bandwidth out: %03.5f kilobits/sec", kbitpersec_out));
239 stats.AddRow(249, InspIRCd::Format("Bandwidth in: %03.5f kilobits/sec", kbitpersec_in));
242 /* Moved this down here so all the not-windows stuff (look w00tie, I didn't say win32!) is in one ifndef.
243 * Also cuts out some identical code in both branches of the ifndef. -- Om
247 /* Not sure why we were doing '0' with a RUSAGE_SELF comment rather than just using RUSAGE_SELF -- Om */
248 if (!getrusage(RUSAGE_SELF,&R)) /* RUSAGE_SELF */
250 stats.AddRow(249, "Total allocation: "+ConvToStr(R.ru_maxrss)+"K");
251 stats.AddRow(249, "Signals: "+ConvToStr(R.ru_nsignals));
252 stats.AddRow(249, "Page faults: "+ConvToStr(R.ru_majflt));
253 stats.AddRow(249, "Swaps: "+ConvToStr(R.ru_nswap));
254 stats.AddRow(249, "Context Switches: Voluntary; "+ConvToStr(R.ru_nvcsw)+" Involuntary; "+ConvToStr(R.ru_nivcsw));
256 float n_elapsed = (ServerInstance->Time() - ServerInstance->stats.LastSampled.tv_sec) * 1000000
257 + (ServerInstance->Time_ns() - ServerInstance->stats.LastSampled.tv_nsec) / 1000;
258 float n_eaten = ((R.ru_utime.tv_sec - ServerInstance->stats.LastCPU.tv_sec) * 1000000 + R.ru_utime.tv_usec - ServerInstance->stats.LastCPU.tv_usec);
259 float per = (n_eaten / n_elapsed) * 100;
261 stats.AddRow(249, InspIRCd::Format("CPU Use (now): %03.5f%%", per));
263 n_elapsed = ServerInstance->Time() - ServerInstance->startup_time;
264 n_eaten = (float)R.ru_utime.tv_sec + R.ru_utime.tv_usec / 100000.0;
265 per = (n_eaten / n_elapsed) * 100;
267 stats.AddRow(249, InspIRCd::Format("CPU Use (total): %03.5f%%", per));
270 PROCESS_MEMORY_COUNTERS MemCounters;
271 if (GetProcessMemoryInfo(GetCurrentProcess(), &MemCounters, sizeof(MemCounters)))
273 stats.AddRow(249, "Total allocation: "+ConvToStr((MemCounters.WorkingSetSize + MemCounters.PagefileUsage) / 1024)+"K");
274 stats.AddRow(249, "Pagefile usage: "+ConvToStr(MemCounters.PagefileUsage / 1024)+"K");
275 stats.AddRow(249, "Page faults: "+ConvToStr(MemCounters.PageFaultCount));
278 FILETIME CreationTime;
282 LARGE_INTEGER ThisSample;
283 if(GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime) &&
284 QueryPerformanceCounter(&ThisSample))
286 KernelTime.dwHighDateTime += UserTime.dwHighDateTime;
287 KernelTime.dwLowDateTime += UserTime.dwLowDateTime;
288 double n_eaten = (double)( ( (uint64_t)(KernelTime.dwHighDateTime - ServerInstance->stats.LastCPU.dwHighDateTime) << 32 ) + (uint64_t)(KernelTime.dwLowDateTime - ServerInstance->stats.LastCPU.dwLowDateTime) )/100000;
289 double n_elapsed = (double)(ThisSample.QuadPart - ServerInstance->stats.LastSampled.QuadPart) / ServerInstance->stats.QPFrequency.QuadPart;
290 double per = (n_eaten/n_elapsed);
292 stats.AddRow(249, InspIRCd::Format("CPU Use (now): %03.5f%%", per));
294 n_elapsed = ServerInstance->Time() - ServerInstance->startup_time;
295 n_eaten = (double)(( (uint64_t)(KernelTime.dwHighDateTime) << 32 ) + (uint64_t)(KernelTime.dwLowDateTime))/100000;
296 per = (n_eaten / n_elapsed);
298 stats.AddRow(249, InspIRCd::Format("CPU Use (total): %03.5f%%", per));
306 stats.AddRow(249, "accepts "+ConvToStr(ServerInstance->stats.Accept)+" refused "+ConvToStr(ServerInstance->stats.Refused));
307 stats.AddRow(249, "unknown commands "+ConvToStr(ServerInstance->stats.Unknown));
308 stats.AddRow(249, "nick collisions "+ConvToStr(ServerInstance->stats.Collisions));
309 stats.AddRow(249, "dns requests "+ConvToStr(ServerInstance->stats.DnsGood+ServerInstance->stats.DnsBad)+" succeeded "+ConvToStr(ServerInstance->stats.DnsGood)+" failed "+ConvToStr(ServerInstance->stats.DnsBad));
310 stats.AddRow(249, "connection count "+ConvToStr(ServerInstance->stats.Connects));
311 stats.AddRow(249, InspIRCd::Format("bytes sent %5.2fK recv %5.2fK",
312 ServerInstance->stats.Sent / 1024.0, ServerInstance->stats.Recv / 1024.0));
319 ConfigTagList tags = ServerInstance->Config->ConfTags("oper");
320 for(ConfigIter i = tags.first; i != tags.second; ++i)
322 ConfigTag* tag = i->second;
323 stats.AddRow(243, 'O', tag->getString("host"), '*', tag->getString("name"), tag->getString("type"), '0');
329 for (ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->OperTypes.begin(); i != ServerInstance->Config->OperTypes.end(); ++i)
331 OperInfo* tag = i->second;
335 for(char c='A'; c <= 'z'; c++)
337 ModeHandler* mh = ServerInstance->Modes->FindMode(c, MODETYPE_USER);
338 if (mh && mh->NeedsOper() && tag->AllowedUserModes[c - 'A'])
340 mh = ServerInstance->Modes->FindMode(c, MODETYPE_CHANNEL);
341 if (mh && mh->NeedsOper() && tag->AllowedChanModes[c - 'A'])
344 stats.AddRow(243, 'O', tag->name, umodes, cmodes);
349 /* stats l (show user I/O stats) */
351 /* stats L (show user I/O stats with IP addresses) */
353 GenerateStatsLl(stats);
356 /* stats u (show server uptime) */
359 unsigned int up = static_cast<unsigned int>(ServerInstance->Time() - ServerInstance->startup_time);
360 stats.AddRow(242, InspIRCd::Format("Server up %u days, %.2u:%.2u:%.2u",
361 up / 86400, (up / 3600) % 24, (up / 60) % 60, up % 60));
369 stats.AddRow(219, statschar, "End of /STATS report");
370 ServerInstance->SNO->WriteToSnoMask('t',"%s '%c' requested by %s (%s@%s)",
371 (IS_LOCAL(user) ? "Stats" : "Remote stats"), statschar, user->nick.c_str(), user->ident.c_str(), user->host.c_str());
375 CmdResult CommandStats::Handle (const std::vector<std::string>& parameters, User *user)
377 if (parameters.size() > 1 && parameters[1] != ServerInstance->Config->ServerName)
379 // Give extra penalty if a non-oper does /STATS <remoteserver>
380 LocalUser* localuser = IS_LOCAL(user);
381 if ((localuser) && (!user->IsOper()))
382 localuser->CommandFloodPenalty += 2000;
385 Stats::Context stats(user, parameters[0][0]);
387 const std::vector<Stats::Row>& rows = stats.GetRows();
388 for (std::vector<Stats::Row>::const_iterator i = rows.begin(); i != rows.end(); ++i)
390 const Stats::Row& row = *i;
391 user->WriteRemoteNumeric(row);
397 COMMAND_INIT(CommandStats)