src/coremods/core_stats.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   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>
   7  *
   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.
  11  *
  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
  15  * details.
  16  *
  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/>.
  19  */
  20
  21
  22 #include "inspircd.h"
  23 #include "xline.h"
  24
  25 #ifdef _WIN32
  26 #include <psapi.h>
  27 #pragma comment(lib, "psapi.lib") // For GetProcessMemoryInfo()
  28 #endif
  29
  30 /** Handle /STATS.
  31  */
  32 class CommandStats : public Command
  33 {
  34         void DoStats(char statschar, User* user, string_list &results);
  35  public:
  36         /** Constructor for stats.
  37          */
  38         CommandStats ( Module* parent) : Command(parent,"STATS",1,2) { syntax = "<stats-symbol> [<servername>]"; }
  39         /** Handle command.
  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.
  43          */
  44         CmdResult Handle(const std::vector<std::string>& parameters, User *user);
  45         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
  46         {
  47                 if (parameters.size() > 1)
  48                         return ROUTE_UNICAST(parameters[1]);
  49                 return ROUTE_LOCALONLY;
  50         }
  51 };
  52
  53 static void GenerateStatsLl(User* user, string_list& results, char c)
  54 {
  55         results.push_back(InspIRCd::Format("211 %s nick[ident@%s] sendq cmds_out bytes_out cmds_in bytes_in time_open", user->nick.c_str(), (c == 'l' ? "host" : "ip")));
  56
  57         const UserManager::LocalList& list = ServerInstance->Users->local_users;
  58         for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
  59         {
  60                 LocalUser* u = *i;
  61                 results.push_back("211 "+user->nick+" "+u->nick+"["+u->ident+"@"+(c == '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->age));
  62         }
  63 }
  64
  65 void CommandStats::DoStats(char statschar, User* user, string_list &results)
  66 {
  67         bool isPublic = ServerInstance->Config->UserStats.find(statschar) != std::string::npos;
  68         bool isRemoteOper = IS_REMOTE(user) && (user->IsOper());
  69         bool isLocalOperWithPrivs = IS_LOCAL(user) && user->HasPrivPermission("servers/auspex");
  70
  71         if (!isPublic && !isRemoteOper && !isLocalOperWithPrivs)
  72         {
  73                 ServerInstance->SNO->WriteToSnoMask('t',
  74                                 "%s '%c' denied for %s (%s@%s)",
  75                                 (IS_LOCAL(user) ? "Stats" : "Remote stats"),
  76                                 statschar, user->nick.c_str(), user->ident.c_str(), user->host.c_str());
  77                 results.push_back("481 " + user->nick + " :Permission Denied - STATS " + statschar + " requires the servers/auspex priv.");
  78                 return;
  79         }
  80
  81         ModResult MOD_RESULT;
  82         FIRST_MOD_RESULT(OnStats, MOD_RESULT, (statschar, user, results));
  83         if (MOD_RESULT == MOD_RES_DENY)
  84         {
  85                 results.push_back("219 "+user->nick+" "+statschar+" :End of /STATS report");
  86                 ServerInstance->SNO->WriteToSnoMask('t',"%s '%c' requested by %s (%s@%s)",
  87                         (IS_LOCAL(user) ? "Stats" : "Remote stats"), statschar, user->nick.c_str(), user->ident.c_str(), user->host.c_str());
  88                 return;
  89         }
  90
  91         switch (statschar)
  92         {
  93                 /* stats p (show listening ports) */
  94                 case 'p':
  95                 {
  96                         for (std::vector<ListenSocket*>::const_iterator i = ServerInstance->ports.begin(); i != ServerInstance->ports.end(); ++i)
  97                         {
  98                                 ListenSocket* ls = *i;
  99                                 std::string ip = ls->bind_addr;
 100                                 if (ip.empty())
 101                                         ip.assign("*");
 102                                 std::string type = ls->bind_tag->getString("type", "clients");
 103                                 std::string hook = ls->bind_tag->getString("ssl", "plaintext");
 104
 105                                 results.push_back("249 "+user->nick+" :"+ ip + ":"+ConvToStr(ls->bind_port)+
 106                                         " (" + type + ", " + hook + ")");
 107                         }
 108                 }
 109                 break;
 110
 111                 /* These stats symbols must be handled by a linking module */
 112                 case 'n':
 113                 case 'c':
 114                 break;
 115
 116                 case 'i':
 117                 {
 118                         for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
 119                         {
 120                                 ConnectClass* c = *i;
 121                                 std::stringstream res;
 122                                 res << "215 " << user->nick << " I " << c->name << ' ';
 123                                 if (c->type == CC_ALLOW)
 124                                         res << '+';
 125                                 if (c->type == CC_DENY)
 126                                         res << '-';
 127
 128                                 if (c->type == CC_NAMED)
 129                                         res << '*';
 130                                 else
 131                                         res << c->host;
 132
 133                                 res << ' ' << c->config->getString("port", "*") << ' ';
 134
 135                                 res << c->GetRecvqMax() << ' ' << c->GetSendqSoftMax() << ' ' << c->GetSendqHardMax()
 136                                         << ' ' << c->GetCommandRate() << ' ' << c->GetPenaltyThreshold();
 137                                 if (c->fakelag)
 138                                         res << '*';
 139                                 results.push_back(res.str());
 140                         }
 141                 }
 142                 break;
 143
 144                 case 'Y':
 145                 {
 146                         int idx = 0;
 147                         for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); i++)
 148                         {
 149                                 ConnectClass* c = *i;
 150                                 results.push_back("215 "+user->nick+" i NOMATCH * "+c->GetHost()+" "+ConvToStr(c->limit ? c->limit : SocketEngine::GetMaxFds())+" "+ConvToStr(idx)+" "+ServerInstance->Config->ServerName+" *");
 151                                 results.push_back("218 "+user->nick+" Y "+ConvToStr(idx)+" "+ConvToStr(c->GetPingTime())+" 0 "+ConvToStr(c->GetSendqHardMax())+" :"+
 152                                                 ConvToStr(c->GetRecvqMax())+" "+ConvToStr(c->GetRegTimeout()));
 153                                 idx++;
 154                         }
 155                 }
 156                 break;
 157
 158                 case 'P':
 159                 {
 160                         unsigned int idx = 0;
 161                         const UserManager::OperList& opers = ServerInstance->Users->all_opers;
 162                         for (UserManager::OperList::const_iterator i = opers.begin(); i != opers.end(); ++i)
 163                         {
 164                                 User* oper = *i;
 165                                 if (!oper->server->IsULine())
 166                                 {
 167                                         LocalUser* lu = IS_LOCAL(oper);
 168                                         results.push_back("249 " + user->nick + " :" + oper->nick + " (" + oper->ident + "@" + oper->dhost + ") Idle: " +
 169                                                         (lu ? ConvToStr(ServerInstance->Time() - lu->idle_lastmsg) + " secs" : "unavailable"));
 170                                         idx++;
 171                                 }
 172                         }
 173                         results.push_back("249 "+user->nick+" :"+ConvToStr(idx)+" OPER(s)");
 174                 }
 175                 break;
 176
 177                 case 'k':
 178                         ServerInstance->XLines->InvokeStats("K",216,user,results);
 179                 break;
 180                 case 'g':
 181                         ServerInstance->XLines->InvokeStats("G",223,user,results);
 182                 break;
 183                 case 'q':
 184                         ServerInstance->XLines->InvokeStats("Q",217,user,results);
 185                 break;
 186                 case 'Z':
 187                         ServerInstance->XLines->InvokeStats("Z",223,user,results);
 188                 break;
 189                 case 'e':
 190                         ServerInstance->XLines->InvokeStats("E",223,user,results);
 191                 break;
 192                 case 'E':
 193                 {
 194                         const SocketEngine::Statistics& stats = SocketEngine::GetStats();
 195                         results.push_back("249 "+user->nick+" :Total events: "+ConvToStr(stats.TotalEvents));
 196                         results.push_back("249 "+user->nick+" :Read events:  "+ConvToStr(stats.ReadEvents));
 197                         results.push_back("249 "+user->nick+" :Write events: "+ConvToStr(stats.WriteEvents));
 198                         results.push_back("249 "+user->nick+" :Error events: "+ConvToStr(stats.ErrorEvents));
 199                         break;
 200                 }
 201
 202                 /* stats m (list number of times each command has been used, plus bytecount) */
 203                 case 'm':
 204                 {
 205                         const CommandParser::CommandMap& commands = ServerInstance->Parser.GetCommands();
 206                         for (CommandParser::CommandMap::const_iterator i = commands.begin(); i != commands.end(); ++i)
 207                         {
 208                                 if (i->second->use_count)
 209                                 {
 210                                         /* RPL_STATSCOMMANDS */
 211                                         results.push_back("212 "+user->nick+" "+i->second->name+" "+ConvToStr(i->second->use_count));
 212                                 }
 213                         }
 214                 }
 215                 break;
 216
 217                 /* stats z (debug and memory info) */
 218                 case 'z':
 219                 {
 220                         results.push_back("249 "+user->nick+" :Users: "+ConvToStr(ServerInstance->Users->GetUsers().size()));
 221                         results.push_back("249 "+user->nick+" :Channels: "+ConvToStr(ServerInstance->GetChans().size()));
 222                         results.push_back("249 "+user->nick+" :Commands: "+ConvToStr(ServerInstance->Parser.GetCommands().size()));
 223
 224                         float kbitpersec_in, kbitpersec_out, kbitpersec_total;
 225                         char kbitpersec_in_s[30], kbitpersec_out_s[30], kbitpersec_total_s[30];
 226
 227                         SocketEngine::GetStats().GetBandwidth(kbitpersec_in, kbitpersec_out, kbitpersec_total);
 228
 229                         snprintf(kbitpersec_total_s, 30, "%03.5f", kbitpersec_total);
 230                         snprintf(kbitpersec_out_s, 30, "%03.5f", kbitpersec_out);
 231                         snprintf(kbitpersec_in_s, 30, "%03.5f", kbitpersec_in);
 232
 233                         results.push_back("249 "+user->nick+" :Bandwidth total:  "+ConvToStr(kbitpersec_total_s)+" kilobits/sec");
 234                         results.push_back("249 "+user->nick+" :Bandwidth out:    "+ConvToStr(kbitpersec_out_s)+" kilobits/sec");
 235                         results.push_back("249 "+user->nick+" :Bandwidth in:     "+ConvToStr(kbitpersec_in_s)+" kilobits/sec");
 236
 237 #ifndef _WIN32
 238                         /* Moved this down here so all the not-windows stuff (look w00tie, I didn't say win32!) is in one ifndef.
 239                          * Also cuts out some identical code in both branches of the ifndef. -- Om
 240                          */
 241                         rusage R;
 242
 243                         /* Not sure why we were doing '0' with a RUSAGE_SELF comment rather than just using RUSAGE_SELF -- Om */
 244                         if (!getrusage(RUSAGE_SELF,&R)) /* RUSAGE_SELF */
 245                         {
 246                                 results.push_back("249 "+user->nick+" :Total allocation: "+ConvToStr(R.ru_maxrss)+"K");
 247                                 results.push_back("249 "+user->nick+" :Signals:          "+ConvToStr(R.ru_nsignals));
 248                                 results.push_back("249 "+user->nick+" :Page faults:      "+ConvToStr(R.ru_majflt));
 249                                 results.push_back("249 "+user->nick+" :Swaps:            "+ConvToStr(R.ru_nswap));
 250                                 results.push_back("249 "+user->nick+" :Context Switches: Voluntary; "+ConvToStr(R.ru_nvcsw)+" Involuntary; "+ConvToStr(R.ru_nivcsw));
 251
 252                                 char percent[30];
 253
 254                                 float n_elapsed = (ServerInstance->Time() - ServerInstance->stats.LastSampled.tv_sec) * 1000000
 255                                         + (ServerInstance->Time_ns() - ServerInstance->stats.LastSampled.tv_nsec) / 1000;
 256                                 float n_eaten = ((R.ru_utime.tv_sec - ServerInstance->stats.LastCPU.tv_sec) * 1000000 + R.ru_utime.tv_usec - ServerInstance->stats.LastCPU.tv_usec);
 257                                 float per = (n_eaten / n_elapsed) * 100;
 258
 259                                 snprintf(percent, 30, "%03.5f%%", per);
 260                                 results.push_back("249 "+user->nick+" :CPU Use (now):    "+percent);
 261
 262                                 n_elapsed = ServerInstance->Time() - ServerInstance->startup_time;
 263                                 n_eaten = (float)R.ru_utime.tv_sec + R.ru_utime.tv_usec / 100000.0;
 264                                 per = (n_eaten / n_elapsed) * 100;
 265                                 snprintf(percent, 30, "%03.5f%%", per);
 266                                 results.push_back("249 "+user->nick+" :CPU Use (total):  "+percent);
 267                         }
 268 #else
 269                         PROCESS_MEMORY_COUNTERS MemCounters;
 270                         if (GetProcessMemoryInfo(GetCurrentProcess(), &MemCounters, sizeof(MemCounters)))
 271                         {
 272                                 results.push_back("249 "+user->nick+" :Total allocation: "+ConvToStr((MemCounters.WorkingSetSize + MemCounters.PagefileUsage) / 1024)+"K");
 273                                 results.push_back("249 "+user->nick+" :Pagefile usage:   "+ConvToStr(MemCounters.PagefileUsage / 1024)+"K");
 274                                 results.push_back("249 "+user->nick+" :Page faults:      "+ConvToStr(MemCounters.PageFaultCount));
 275                         }
 276
 277                         FILETIME CreationTime;
 278                         FILETIME ExitTime;
 279                         FILETIME KernelTime;
 280                         FILETIME UserTime;
 281                         LARGE_INTEGER ThisSample;
 282                         if(GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime) &&
 283                                 QueryPerformanceCounter(&ThisSample))
 284                         {
 285                                 KernelTime.dwHighDateTime += UserTime.dwHighDateTime;
 286                                 KernelTime.dwLowDateTime += UserTime.dwLowDateTime;
 287                                 double n_eaten = (double)( ( (uint64_t)(KernelTime.dwHighDateTime - ServerInstance->stats.LastCPU.dwHighDateTime) << 32 ) + (uint64_t)(KernelTime.dwLowDateTime - ServerInstance->stats.LastCPU.dwLowDateTime) )/100000;
 288                                 double n_elapsed = (double)(ThisSample.QuadPart - ServerInstance->stats.LastSampled.QuadPart) / ServerInstance->stats.QPFrequency.QuadPart;
 289                                 double per = (n_eaten/n_elapsed);
 290
 291                                 char percent[30];
 292
 293                                 snprintf(percent, 30, "%03.5f%%", per);
 294                                 results.push_back("249 "+user->nick+" :CPU Use (now):    "+percent);
 295
 296                                 n_elapsed = ServerInstance->Time() - ServerInstance->startup_time;
 297                                 n_eaten = (double)(( (uint64_t)(KernelTime.dwHighDateTime) << 32 ) + (uint64_t)(KernelTime.dwLowDateTime))/100000;
 298                                 per = (n_eaten / n_elapsed);
 299                                 snprintf(percent, 30, "%03.5f%%", per);
 300                                 results.push_back("249 "+user->nick+" :CPU Use (total):  "+percent);
 301                         }
 302 #endif
 303                 }
 304                 break;
 305
 306                 case 'T':
 307                 {
 308                         results.push_back("249 "+user->nick+" :accepts "+ConvToStr(ServerInstance->stats.Accept)+" refused "+ConvToStr(ServerInstance->stats.Refused));
 309                         results.push_back("249 "+user->nick+" :unknown commands "+ConvToStr(ServerInstance->stats.Unknown));
 310                         results.push_back("249 "+user->nick+" :nick collisions "+ConvToStr(ServerInstance->stats.Collisions));
 311                         results.push_back("249 "+user->nick+" :dns requests "+ConvToStr(ServerInstance->stats.DnsGood+ServerInstance->stats.DnsBad)+" succeeded "+ConvToStr(ServerInstance->stats.DnsGood)+" failed "+ConvToStr(ServerInstance->stats.DnsBad));
 312                         results.push_back("249 "+user->nick+" :connection count "+ConvToStr(ServerInstance->stats.Connects));
 313                         results.push_back(InspIRCd::Format("249 %s :bytes sent %5.2fK recv %5.2fK", user->nick.c_str(),
 314                                 ServerInstance->stats.Sent / 1024.0, ServerInstance->stats.Recv / 1024.0));
 315                 }
 316                 break;
 317
 318                 /* stats o */
 319                 case 'o':
 320                 {
 321                         ConfigTagList tags = ServerInstance->Config->ConfTags("oper");
 322                         for(ConfigIter i = tags.first; i != tags.second; ++i)
 323                         {
 324                                 ConfigTag* tag = i->second;
 325                                 results.push_back("243 "+user->nick+" O "+tag->getString("host")+" * "+
 326                                         tag->getString("name") + " " + tag->getString("type")+" 0");
 327                         }
 328                 }
 329                 break;
 330                 case 'O':
 331                 {
 332                         for (ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->OperTypes.begin(); i != ServerInstance->Config->OperTypes.end(); ++i)
 333                         {
 334                                 OperInfo* tag = i->second;
 335                                 tag->init();
 336                                 std::string umodes;
 337                                 std::string cmodes;
 338                                 for(char c='A'; c < 'z'; c++)
 339                                 {
 340                                         ModeHandler* mh = ServerInstance->Modes->FindMode(c, MODETYPE_USER);
 341                                         if (mh && mh->NeedsOper() && tag->AllowedUserModes[c - 'A'])
 342                                                 umodes.push_back(c);
 343                                         mh = ServerInstance->Modes->FindMode(c, MODETYPE_CHANNEL);
 344                                         if (mh && mh->NeedsOper() && tag->AllowedChanModes[c - 'A'])
 345                                                 cmodes.push_back(c);
 346                                 }
 347                                 results.push_back("243 "+user->nick+" O "+tag->name.c_str() + " " + umodes + " " + cmodes);
 348                         }
 349                 }
 350                 break;
 351
 352                 /* stats l (show user I/O stats) */
 353                 case 'l':
 354                 /* stats L (show user I/O stats with IP addresses) */
 355                 case 'L':
 356                         GenerateStatsLl(user, results, statschar);
 357                 break;
 358
 359                 /* stats u (show server uptime) */
 360                 case 'u':
 361                 {
 362                         unsigned int up = static_cast<unsigned int>(ServerInstance->Time() - ServerInstance->startup_time);
 363                         results.push_back(InspIRCd::Format("242 %s :Server up %u days, %.2u:%.2u:%.2u", user->nick.c_str(),
 364                                 up / 86400, (up / 3600) % 24, (up / 60) % 60, up % 60));
 365                 }
 366                 break;
 367
 368                 default:
 369                 break;
 370         }
 371
 372         results.push_back("219 "+user->nick+" "+statschar+" :End of /STATS report");
 373         ServerInstance->SNO->WriteToSnoMask('t',"%s '%c' requested by %s (%s@%s)",
 374                 (IS_LOCAL(user) ? "Stats" : "Remote stats"), statschar, user->nick.c_str(), user->ident.c_str(), user->host.c_str());
 375         return;
 376 }
 377
 378 CmdResult CommandStats::Handle (const std::vector<std::string>& parameters, User *user)
 379 {
 380         if (parameters.size() > 1 && parameters[1] != ServerInstance->Config->ServerName)
 381                 return CMD_SUCCESS;
 382         string_list values;
 383         char search = parameters[0][0];
 384         DoStats(search, user, values);
 385
 386         const std::string p = ":" + ServerInstance->Config->ServerName + " ";
 387         for (size_t i = 0; i < values.size(); i++)
 388                 user->SendText(p + values[i]);
 389
 390         return CMD_SUCCESS;
 391 }
 392
 393 COMMAND_INIT(CommandStats)