2 * IRC - Internet Relay Chat, ircd/s_stats.c
3 * Copyright (C) 2000 Joseph Bongaarts
5 * See file AUTHORS in IRC package for additional names of
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 1, or (at your option)
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29 #include "ircd_chattr.h"
30 #include "ircd_events.h"
31 #include "ircd_features.h"
32 #include "ircd_crypt.h"
34 #include "ircd_reply.h"
35 #include "ircd_string.h"
44 #include "querycmds.h"
63 * @brief Report configuration lines and other statistics from this
67 * Note: The info is reported in the order the server uses
68 * it--not reversed as in ircd.conf!
71 /* The statsinfo array should only be used in this file, but just TRY
72 * telling the compiler that you want to forward declare a static
73 * array without specifying a length, and see how it responds. So we
74 * forward declare it "extern".
76 extern struct StatDesc statsinfo[];
78 /** Report items from #GlobalConfList.
79 * Uses sd->sd_funcdata as a filter for ConfItem::status.
80 * @param[in] sptr Client requesting statistics.
81 * @param[in] sd Stats descriptor for request.
82 * @param[in] param Extra parameter from user (ignored).
85 stats_configured_links(struct Client *sptr, const struct StatDesc* sd,
88 static char null[] = "<NULL>";
90 unsigned short int port;
92 char *host, *pass, *name, *username, *hub_limit;
94 for (tmp = GlobalConfList; tmp; tmp = tmp->next)
96 if ((tmp->status & sd->sd_funcdata))
98 host = BadPtr(tmp->host) ? null : tmp->host;
99 pass = BadPtr(tmp->passwd) ? null : tmp->passwd;
100 name = BadPtr(tmp->name) ? null : tmp->name;
101 username = BadPtr(tmp->username) ? null : tmp->username;
102 hub_limit = BadPtr(tmp->hub_limit) ? null : tmp->hub_limit;
103 maximum = tmp->maximum;
104 port = tmp->address.port;
106 if (tmp->status & CONF_UWORLD)
107 send_reply(sptr, RPL_STATSULINE, host);
108 else if (tmp->status & CONF_SERVER)
109 send_reply(sptr, RPL_STATSCLINE, name, "", "*", port, maximum, hub_limit, get_conf_class(tmp));
110 else if (tmp->status & CONF_CLIENT)
111 send_reply(sptr, RPL_STATSILINE,
112 (tmp->host ? tmp->host : "*"), maximum,
113 (name[0] == ':' ? "0" : ""), (tmp->name ? tmp->name : "*"),
114 port, get_conf_class(tmp));
115 else if (tmp->status & CONF_OPERATOR)
116 send_reply(sptr, RPL_STATSOLINE, username, host, name, get_conf_class(tmp));
121 /** Report connection rules from conf_get_crule_list().
122 * Uses sd->sd_funcdata as a filter for CRuleConf::type.
123 * @param[in] to Client requesting statistics.
124 * @param[in] sd Stats descriptor for request.
125 * @param[in] param Extra parameter from user (ignored).
128 stats_crule_list(struct Client* to, const struct StatDesc *sd,
131 const struct CRuleConf* p = conf_get_crule_list();
133 for ( ; p; p = p->next)
135 if (p->type & sd->sd_funcdata)
136 send_reply(to, RPL_STATSDLINE, sd->sd_c, p->hostmask, p->rule);
140 /** Report active event engine name.
141 * @param[in] to Client requesting statistics.
142 * @param[in] sd Stats descriptor for request (ignored).
143 * @param[in] param Extra parameter from user (ignored).
146 stats_engine(struct Client *to, const struct StatDesc *sd, char *param)
148 send_reply(to, RPL_STATSENGINE, engine_name());
151 /** Report client access lists.
152 * @param[in] to Client requesting statistics.
153 * @param[in] sd Stats descriptor for request.
154 * @param[in] param Filter for hostname or IP (NULL to show all).
157 stats_access(struct Client *to, const struct StatDesc *sd, char *param)
159 struct ConfItem *aconf;
165 stats_configured_links(to, sd, param);
169 wilds = string_has_wildcards(param);
171 for (aconf = GlobalConfList; aconf; aconf = aconf->next)
173 if (aconf->status != CONF_CLIENT)
175 if (wilds ? ((aconf->host && !mmatch(aconf->host, param))
176 || (aconf->name && !mmatch(aconf->name, param)))
177 : ((aconf->host && !match(param, aconf->host))
178 || (aconf->name && !match(param, aconf->name))))
180 send_reply(to, RPL_STATSILINE,
181 (aconf->host ? aconf->host : "*"), aconf->maximum,
182 (aconf->name && aconf->name[0] == ':' ? "0":""),
183 aconf->name ? aconf->name : "*",
184 aconf->address.port, get_conf_class(aconf));
192 /** Report DenyConf entries.
193 * @param[in] to Client requesting list.
196 report_deny_list(struct Client* to)
198 const struct DenyConf* p = conf_get_deny_list();
199 for ( ; p; p = p->next)
200 send_reply(to, RPL_STATSKLINE, p->bits > 0 ? 'k' : 'K',
201 p->usermask ? p->usermask : "*",
202 p->hostmask ? p->hostmask : "*",
203 p->message ? p->message : "(none)",
204 p->realmask ? p->realmask : "*");
207 /** Report K/k-lines to a user.
208 * @param[in] sptr Client requesting statistics.
209 * @param[in] sd Stats descriptor for request (ignored).
210 * @param[in] mask Filter for hostmasks to show.
213 stats_klines(struct Client *sptr, const struct StatDesc *sd, char *mask)
220 const struct DenyConf* conf;
228 need_more_params(sptr, "STATS K");
230 report_deny_list(sptr);
236 wilds = string_has_wildcards(mask);
239 if ((host = strchr(mask, '@')))
247 for (conf = conf_get_deny_list(); conf; conf = conf->next)
249 if ((!wilds && ((user || conf->hostmask) &&
250 !match(conf->hostmask, host) &&
251 (!user || !match(conf->usermask, user)))) ||
252 (wilds && !mmatch(host, conf->hostmask) &&
253 (!user || !mmatch(user, conf->usermask))))
255 send_reply(sptr, RPL_STATSKLINE, conf->bits > 0 ? 'k' : 'K',
256 conf->usermask ? conf->usermask : "*",
257 conf->hostmask ? conf->hostmask : "*",
258 conf->message ? conf->message : "(none)",
259 conf->realmask ? conf->realmask : "*");
266 /** Report on servers and/or clients connected to the network.
267 * @param[in] sptr Client requesting statistics.
268 * @param[in] sd Stats descriptor for request (ignored).
269 * @param[in] name Filter for client names to show.
272 stats_links(struct Client* sptr, const struct StatDesc* sd, char* name)
274 struct Client *acptr;
279 wilds = string_has_wildcards(name);
282 * Send info about connections which match, or all if the
283 * mask matches me.name. Only restrictions are on those who
284 * are invisible not being visible to 'foreigners' who use
285 * a wild card based search to list it.
287 send_reply(sptr, SND_EXPLICIT | RPL_STATSLINKINFO, "Connection SendQ "
288 "SendM SendKBytes RcveM RcveKBytes :Open since");
289 for (i = 0; i <= HighestFd; i++)
291 if (!(acptr = LocalClientArray[i]))
293 /* Don't return clients when this is a request for `all' */
294 if (!name && IsUser(acptr))
296 /* Don't show invisible people to non opers unless they know the nick */
297 if (IsInvisible(acptr) && (!name || wilds) && !IsAnOper(acptr) &&
300 /* Only show the ones that match the given mask - if any */
301 if (name && wilds && match(name, cli_name(acptr)))
303 /* Skip all that do not match the specific query */
304 if (!(!name || wilds) && 0 != ircd_strcmp(name, cli_name(acptr)))
306 send_reply(sptr, SND_EXPLICIT | RPL_STATSLINKINFO,
307 "%s %u %u %Lu %u %Lu :%Tu",
308 (*(cli_name(acptr))) ? cli_name(acptr) : "<unregistered>",
309 (int)MsgQLength(&(cli_sendQ(acptr))), (int)cli_sendM(acptr),
310 (cli_sendB(acptr) >> 10), (int)cli_receiveM(acptr),
311 (cli_receiveB(acptr) >> 10), CurrentTime - cli_firsttime(acptr));
315 /** Report on loaded modules.
316 * @param[in] to Client requesting statistics.
317 * @param[in] sd Stats descriptor for request (ignored).
318 * @param[in] param Extra parameter from user (ignored).
321 stats_modules(struct Client* to, const struct StatDesc* sd, char* param)
323 crypt_mechs_t* mechs;
325 send_reply(to, SND_EXPLICIT | RPL_STATSLLINE,
326 "Module Description Entry Point");
328 /* atm the only "modules" we have are the crypto mechanisms,
329 eventualy they'll be part of a global dl module list, for now
330 i'll just output data about them -- hikari */
332 if(crypt_mechs_root == NULL)
335 mechs = crypt_mechs_root->next;
342 send_reply(to, SND_EXPLICIT | RPL_STATSLLINE,
344 mechs->mech->shortname, mechs->mech->description,
345 mechs->mech->crypt_function);
352 /** Report how many times each command has been used.
353 * @param[in] to Client requesting statistics.
354 * @param[in] sd Stats descriptor for request (ignored).
355 * @param[in] param Extra parameter from user (ignored).
358 stats_commands(struct Client* to, const struct StatDesc* sd, char* param)
360 struct Message *mptr;
362 for (mptr = msgtab; mptr->cmd; mptr++)
364 send_reply(to, RPL_STATSCOMMANDS, mptr->cmd, mptr->count, mptr->bytes);
367 /** List channel quarantines.
368 * @param[in] to Client requesting statistics.
369 * @param[in] sd Stats descriptor for request (ignored).
370 * @param[in] param Filter for quarantined channel names.
373 stats_quarantine(struct Client* to, const struct StatDesc* sd, char* param)
377 for (qline = GlobalQuarantineList; qline; qline = qline->next)
379 if (param && match(param, qline->chname)) /* narrow search */
381 send_reply(to, RPL_STATSQLINE, qline->chname, qline->reason);
385 /** List service pseudo-command mappings.
386 * @param[in] to Client requesting statistics.
387 * @param[in] sd Stats descriptor for request (ignored).
388 * @param[in] param Extra parameter from user (ignored).
391 stats_mapping(struct Client *to, const struct StatDesc* sd, char* param)
395 send_reply(to, RPL_STATSRLINE, "Command", "Name", "Prepend", "Target");
396 for (map = GlobalServiceMapList; map; map = map->next) {
397 struct nick_host *nh;
398 for (nh = map->services; nh; nh = nh->next) {
399 send_reply(to, RPL_STATSRLINE, map->command, map->name,
400 (map->prepend ? map->prepend : "*"), nh->nick);
405 /** Report server uptime and maximum connection/client counts.
406 * @param[in] to Client requesting statistics.
407 * @param[in] sd Stats descriptor for request (ignored).
408 * @param[in] param Extra parameter from user (ignored).
411 stats_uptime(struct Client* to, const struct StatDesc* sd, char* param)
415 nowr = CurrentTime - cli_since(&me);
416 send_reply(to, RPL_STATSUPTIME, nowr / 86400, (nowr / 3600) % 24,
417 (nowr / 60) % 60, nowr % 60);
418 send_reply(to, RPL_STATSCONN, max_connection_count, max_client_count);
421 /** Verbosely report on servers connected to the network.
422 * If sd->sd_funcdata != 0, then display in a more human-friendly format.
423 * @param[in] sptr Client requesting statistics.
424 * @param[in] sd Stats descriptor for request.
425 * @param[in] param Filter for server names to display.
428 stats_servers_verbose(struct Client* sptr, const struct StatDesc* sd,
431 struct Client *acptr;
435 * lowercase 'v' is for human-readable,
436 * uppercase 'V' is for machine-readable
438 if (sd->sd_funcdata) {
439 send_reply(sptr, SND_EXPLICIT | RPL_STATSVERBOSE,
440 "%-20s %-20s Flags Hops Numeric Lag RTT Up Down "
441 "Clients/Max Proto %-10s :Info", "Servername", "Uplink",
443 fmt = "%-20s %-20s %c%c%c%c %4i %s %-4i %5i %4i %4i %4i %5i %5i P%-2i %Tu :%s";
445 fmt = "%s %s %c%c%c%c %i %s %i %i %i %i %i %i %i P%i %Tu :%s";
448 for (acptr = GlobalClientList; acptr; acptr = cli_next(acptr))
450 if (!IsServer(acptr) && !IsMe(acptr))
453 if (param && match(param, cli_name(acptr)))
455 send_reply(sptr, SND_EXPLICIT | RPL_STATSVERBOSE, fmt,
457 cli_name(cli_serv(acptr)->up),
458 IsBurst(acptr) ? 'B' : '-',
459 IsBurstAck(acptr) ? 'A' : '-',
460 IsHub(acptr) ? 'H' : '-',
461 IsService(acptr) ? 'S' : '-',
464 base64toint(cli_yxx(acptr)),
465 cli_serv(acptr)->lag,
466 cli_serv(acptr)->asll_rtt,
467 cli_serv(acptr)->asll_to,
468 cli_serv(acptr)->asll_from,
469 (acptr == &me ? UserStats.local_clients : cli_serv(acptr)->clients),
470 cli_serv(acptr)->nn_mask,
471 cli_serv(acptr)->prot,
472 cli_serv(acptr)->timestamp,
478 /** Display objects allocated (and total memory used by them) for
479 * several types of structures.
480 * @param[in] to Client requesting statistics.
481 * @param[in] sd Stats descriptor for request (ignored).
482 * @param[in] param Extra parameter from user (ignored).
485 stats_meminfo(struct Client* to, const struct StatDesc* sd, char* param)
487 class_send_meminfo(to);
488 send_listinfo(to, 0);
492 /** Send a list of available statistics.
493 * @param[in] to Client requesting statistics.
494 * @param[in] sd Stats descriptor for request.
495 * @param[in] param Extra parameter from user (ignored).
498 stats_help(struct Client* to, const struct StatDesc* sd, char* param)
500 struct StatDesc *asd;
502 /* only if it's my user */
504 for (asd = statsinfo; asd->sd_name; asd++)
505 if (asd != sd) /* don't send the help for us */
506 sendcmdto_one(&me, CMD_NOTICE, to, "%C :%c (%s) - %s", to, asd->sd_c,
507 asd->sd_name, asd->sd_desc);
510 /** Contains information about all statistics. */
511 struct StatDesc statsinfo[] = {
512 { 'a', "nameservers", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_a,
513 report_dns_servers, 0,
515 { 'c', "connect", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_c,
516 stats_configured_links, CONF_SERVER,
517 "Remote server connection lines." },
518 { 'd', "maskrules", (STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS), FEAT_HIS_STATS_d,
519 stats_crule_list, CRULE_MASK,
520 "Dynamic routing configuration." },
521 { 'D', "crules", (STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS), FEAT_HIS_STATS_d,
522 stats_crule_list, CRULE_ALL,
523 "Dynamic routing configuration." },
524 { 'e', "engine", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_e,
526 "Report server event loop engine." },
527 { 'f', "features", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_f,
529 "Feature settings." },
530 { 'g', "glines", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_g,
532 "Global bans (G-lines)." },
533 { 'i', "access", (STAT_FLAG_OPERFEAT | STAT_FLAG_VARPARAM), FEAT_HIS_STATS_i,
534 stats_access, CONF_CLIENT,
535 "Connection authorization lines." },
536 { 'j', "histogram", (STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS), FEAT_HIS_STATS_j,
538 "Message length histogram." },
539 { 'J', "jupes", (STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS), FEAT_HIS_STATS_J,
542 { 'k', "klines", (STAT_FLAG_OPERFEAT | STAT_FLAG_VARPARAM), FEAT_HIS_STATS_k,
544 "Local bans (K-Lines)." },
545 { 'l', "links", (STAT_FLAG_OPERFEAT | STAT_FLAG_VARPARAM | STAT_FLAG_CASESENS),
548 "Current connections information." },
549 { 'L', "modules", (STAT_FLAG_OPERFEAT | STAT_FLAG_VARPARAM | STAT_FLAG_CASESENS),
552 "Dynamically loaded modules." },
553 { 'm', "commands", (STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS), FEAT_HIS_STATS_m,
555 "Message usage information." },
556 { 'o', "operators", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_o,
557 stats_configured_links, CONF_OPERATOR,
558 "Operator information." },
559 { 'p', "ports", (STAT_FLAG_OPERFEAT | STAT_FLAG_VARPARAM), FEAT_HIS_STATS_p,
561 "Listening ports." },
562 { 'q', "quarantines", (STAT_FLAG_OPERONLY | STAT_FLAG_VARPARAM), FEAT_HIS_STATS_q,
564 "Quarantined channels list." },
565 { 'R', "mappings", (STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS), FEAT_HIS_STATS_R,
567 "Service mappings." },
569 { 'r', "usage", (STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS), FEAT_HIS_STATS_r,
571 "System resource usage (Debug only)." },
573 { 'T', "motds", (STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS), FEAT_HIS_STATS_T,
575 "Configured Message Of The Day files." },
576 { 't', "locals", (STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS), FEAT_HIS_STATS_t,
578 "Local connection statistics (Total SND/RCV, etc)." },
579 { 'U', "uworld", (STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS), FEAT_HIS_STATS_U,
580 stats_configured_links, CONF_UWORLD,
581 "Service server information." },
582 { 'u', "uptime", (STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS), FEAT_HIS_STATS_u,
584 "Current uptime & highest connection count." },
585 { 'v', "vservers", (STAT_FLAG_OPERFEAT | STAT_FLAG_VARPARAM | STAT_FLAG_CASESENS), FEAT_HIS_STATS_v,
586 stats_servers_verbose, 1,
587 "Verbose server information." },
588 { 'V', "vserversmach", (STAT_FLAG_OPERFEAT | STAT_FLAG_VARPARAM | STAT_FLAG_CASESENS), FEAT_HIS_STATS_v,
589 stats_servers_verbose, 0,
590 "Verbose server information." },
591 { 'w', "userload", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_w,
593 "Userload statistics." },
595 { 'x', "memusage", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_x,
597 "List usage information (Debug only)." },
599 { 'y', "classes", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_y,
601 "Connection classes." },
602 { 'z', "memory", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_z,
604 "Memory/Structure allocation information." },
605 { '*', "help", (STAT_FLAG_CASESENS | STAT_FLAG_VARPARAM), FEAT_LAST_F,
607 "Send help for stats." },
608 { '\0', 0, FEAT_LAST_F, 0, 0, 0 }
611 /** Maps from characters to statistics descriptors.
612 * Statistics descriptors with no single-character alias are not included.
614 static struct StatDesc *statsmap[256];
615 /** Number of statistics descriptors. */
616 static int statscount;
618 /** Compare two StatDesc structures by long name (StatDesc::sd_name).
619 * @param[in] a_ Pointer to a StatDesc.
620 * @param[in] b_ Pointer to a StatDesc.
621 * @return Less than, equal to, or greater than zero if \a a_ is
622 * lexicographically less than, equal to, or greater than \a b_.
625 stats_cmp(const void *a_, const void *b_)
627 const struct StatDesc *a = a_;
628 const struct StatDesc *b = b_;
629 return ircd_strcmp(a->sd_name, b->sd_name);
632 /** Compare a StatDesc's name against a string.
633 * @param[in] key Pointer to a null-terminated string.
634 * @param[in] sd_ Pointer to a StatDesc.
635 * @return Less than, equal to, or greater than zero if \a key is
636 * lexicographically less than, equal to, or greater than \a
640 stats_search(const void *key, const void *sd_)
642 const struct StatDesc *sd = sd_;
643 return ircd_strcmp(key, sd->sd_name);
646 /** Look up a stats handler. If name_or_char is just one character
647 * long, use that as a character index; otherwise, look it up by name
649 * @param[in] name_or_char Null-terminated string to look up.
650 * @return The statistics descriptor for \a name_or_char (NULL if none).
652 const struct StatDesc *
653 stats_find(const char *name_or_char)
655 if (!name_or_char[1])
656 return statsmap[(int)name_or_char[0]];
658 return bsearch(name_or_char, statsinfo, statscount, sizeof(statsinfo[0]), stats_search);
661 /** Build statsmap from the statsinfo array. */
668 /* Make darn sure the statsmap array is initialized to all zeros */
669 for (i = 0; i < 256; i++)
672 /* Count number of stats entries and sort them. */
673 for (statscount = 0, sd = statsinfo; sd->sd_name; sd++, statscount++) {}
674 qsort(statsinfo, statscount, sizeof(statsinfo[0]), stats_cmp);
676 /* Build the mapping */
677 for (sd = statsinfo; sd->sd_name; sd++)
681 else if (sd->sd_flags & STAT_FLAG_CASESENS)
682 /* case sensitive character... */
683 statsmap[(int)sd->sd_c] = sd;
686 /* case insensitive--make sure to put in two entries */
687 statsmap[(int)ToLower((int)sd->sd_c)] = sd;
688 statsmap[(int)ToUpper((int)sd->sd_c)] = sd;