added gnutls backend and moved backend code into new files
[ircu2.10.12-pk.git] / ircd / s_debug.c
index bfa98281c4d99eb16eb2378554a72b30c36ea274..53338c225d43e5a7e9bb26302c36a2a2b32560ac 100644 (file)
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id$
- *
  */
+/** @file
+ * @brief Debug support for the ircd.
+ * @version $Id$
+ */
+#include "config.h"
+
 #include "s_debug.h"
 #include "channel.h"
 #include "class.h"
 #include "client.h"
+#include "gline.h"
 #include "hash.h"
 #include "ircd_alloc.h"
+#include "ircd_features.h"
+#include "ircd_log.h"
 #include "ircd_osdep.h"
 #include "ircd_reply.h"
 #include "ircd.h"
+#include "jupe.h"
 #include "list.h"
+#include "listener.h"
+#include "motd.h"
+#include "msgq.h"
 #include "numeric.h"
 #include "numnicks.h"
 #include "res.h"
 #include "s_bsd.h"
 #include "s_conf.h"
+#include "s_user.h"
+#include "s_stats.h"
 #include "send.h"
 #include "struct.h"
 #include "sys.h"
 #include "whowas.h"
 
-#include <assert.h>
+/* #include <assert.h> -- Now using assert in ircd_log.h */
 #include <errno.h>
 #include <fcntl.h>
 #include <stdarg.h>
 #include <string.h>
 #include <unistd.h>
 
-/* *INDENT-OFF* */
-
 /*
  * Option string.  Must be before #ifdef DEBUGMODE.
  */
-char serveropts[] = {
-#if BUFFERPOOL < 1000000
-    'b',
-#if BUFFERPOOL > 99999
-    (char)('0' + (BUFFERPOOL/100000)),
-#endif
-#if BUFFERPOOL > 9999
-    (char)('0' + (BUFFERPOOL/10000) % 10),
-#endif
-    (char)('0' + (BUFFERPOOL/1000) % 10),
-#else
-    'B',
-#if BUFFERPOOL > 99999999
-    (char)('0' + (BUFFERPOOL/100000000)),
-#endif
-#if BUFFERPOOL > 9999999
-    (char)('0' + (BUFFERPOOL/10000000) % 10),
-#endif
-    (char)('0' + (BUFFERPOOL/1000000) % 10),
-#endif
-#ifdef  CHROOTDIR
-    'c',
-#endif
-#ifdef  CMDLINE_CONFIG
-    'C',
-#endif
-#ifdef  DO_ID
-    'd',
+static char serveropts[256]; /* should be large enough for anything */
+
+/** Return a string describing important configuration information.
+ * @return Pointer to a static buffer.
+ */
+const char* debug_serveropts(void)
+{
+  int bp;
+  int i = 0;
+#define AddC(c)        serveropts[i++] = (c)
+
+  bp = feature_int(FEAT_BUFFERPOOL);
+  if (bp < 1000000) {
+    AddC('b');
+    if (bp > 99999)
+      AddC((char)('0' + (bp / 100000)));
+    if (bp > 9999)
+      AddC((char)('0' + (bp / 10000) % 10));
+    AddC((char)('0' + (bp / 1000) % 10));
+  } else {
+    AddC('B');
+    if (bp > 99999999)
+      AddC((char)('0' + (bp / 100000000)));
+    if (bp > 9999999)
+      AddC((char)('0' + (bp / 10000000) % 10));
+    AddC((char)('0' + (bp / 1000000) % 10));
+  }
+
+#ifndef NDEBUG
+  AddC('A');
 #endif
 #ifdef  DEBUGMODE
-    'D',
-#endif
-#ifdef  LOCOP_REHASH
-    'e',
-#endif
-#ifdef  OPER_REHASH
-    'E',
-#endif
-#ifdef OPER_NO_CHAN_LIMIT
-    'F',
-#endif
-#ifdef OPER_MODE_LCHAN
-    'f',
-#endif
-#ifdef  HUB
-    'H',
-#endif
-#if defined(SHOW_INVISIBLE_USERS) ||  defined(SHOW_ALL_INVISIBLE_USERS)
-#ifdef  SHOW_ALL_INVISIBLE_USERS
-    'I',
-#else
-    'i',
-#endif
-#endif
-#ifdef  OPER_KILL
-#ifdef  LOCAL_KILL_ONLY
-    'k',
-#else
-    'K',
-#endif
-#endif
-#ifdef  LEAST_IDLE
-    'L',
-#endif
-#ifdef OPER_WALK_THROUGH_LMODES
-    'l',
-#endif
-#ifdef  IDLE_FROM_MSG
-    'M',
-#endif
-#ifdef  USEONE
-    'O',
-#endif
-#ifdef NO_OPER_DEOP_LCHAN
-    'o',
-#endif
-#ifdef  CRYPT_OPER_PASSWORD
-    'p',
-#endif
-#ifdef  CRYPT_LINK_PASSWORD
-    'P',
-#endif
-#ifdef  DEBUGMALLOC
-#ifdef  MEMLEAKSTATS
-    'Q',
-#else
-    'q',
-#endif
-#endif
-#ifdef  RELIABLE_CLOCK
-    'R',
-#endif
-#ifdef  LOCOP_RESTART
-    's',
-#endif
-#ifdef  OPER_RESTART
-    'S',
-#endif
-#ifdef  OPER_REMOTE
-    't',
+  AddC('D');
 #endif
+
+  if (feature_bool(FEAT_HUB))
+    AddC('H');
+
+  if (feature_bool(FEAT_IDLE_FROM_MSG))
+    AddC('M');
+
+  if (feature_bool(FEAT_RELIABLE_CLOCK))
+    AddC('R');
+
 #if defined(USE_POLL) && defined(HAVE_POLL_H)
-    'U',
+  AddC('U');
 #endif
-#ifdef  VIRTUAL_HOST
-    'v',
+#ifdef  IPV6
+  AddC('6');
 #endif
-#ifdef BADCHAN
-    'W',
-#ifdef LOCAL_BADCHAN
-    'x',
-#endif
-#endif
-#ifdef  USE_SYSLOG
-    'Y',
-#endif
-    '\0'
-};
 
-/* *INDENT-ON* */
+  serveropts[i] = '\0';
 
+  return serveropts;
+}
 
-/*
- * debug_init
- *
+/** Initialize debugging.
  * If the -t option is not given on the command line when the server is
  * started, all debugging output is sent to the file set by LPATH in config.h
  * Here we just open that file and make sure it is opened to fd 2 so that
- * any fprintf's to stderr also goto the logfile.  If the debuglevel is not
+ * any fprintf's to stderr also go to the logfile.  If the debuglevel is not
  * set from the command line by -x, use /dev/null as the dummy logfile as long
- * as DEBUGMODE has been defined, else dont waste the fd.
+ * as DEBUGMODE has been defined, else don't waste the fd.
+ * @param use_tty Passed to log_debug_init().
  */
 void debug_init(int use_tty)
 {
 #ifdef  DEBUGMODE
   if (debuglevel >= 0) {
-    printf("isatty = %d ttyname = %#x\n", isatty(2), (unsigned int)ttyname(2));
-    if (!use_tty) {
-      int fd;
-      /* 
-       * leave debugging output on fd 2
-       */
-      if ((fd = open(LOGFILE, O_CREAT | O_WRONLY | O_APPEND, 0600)) < 0) {
-        if ((fd = open("/dev/null", O_WRONLY)) < 0)
-          exit(-1);
-      }
-      if (fd != 2) {
-        dup2(fd, 2);
-        close(fd);
-      }
-    }
+    printf("isatty = %d ttyname = %s\n", isatty(2), ttyname(2));
+    log_debug_init(use_tty);
   }
 #endif
 }
 
 #ifdef DEBUGMODE
-static char debugbuf[1024];
-
+/** Log a debug message using a va_list.
+ * If the current #debuglevel is less than \a level, do not display.
+ * @param level Debug level for message.
+ * @param form Format string, passed to log_vwrite().
+ * @param vl Varargs argument list for format string.
+ */
 void vdebug(int level, const char *form, va_list vl)
 {
+  static int loop = 0;
   int err = errno;
 
-  if ((debuglevel >= 0) && (level <= debuglevel))
+  if (!loop && (debuglevel >= 0) && (level <= debuglevel))
   {
-    vsprintf(debugbuf, form, vl);
-    fprintf(stderr, "%s\n", debugbuf);
+    loop = 1;
+    log_vwrite(LS_DEBUG, L_DEBUG, 0, form, vl);
+    loop = 0;
   }
   errno = err;
 }
 
+/** Log a debug message using a variable number of arguments.
+ * This is a simple wrapper around debug(\a level, \a form, vl).
+ * @param level Debug level for message.
+ * @param form Format string of message.
+ */
 void debug(int level, const char *form, ...)
 {
   va_list vl;
@@ -232,114 +173,129 @@ void debug(int level, const char *form, ...)
   va_end(vl);
 }
 
+/** Send a literal RPL_STATSDEBUG message to a user.
+ * @param cptr Client to receive the message.
+ * @param msg Text message to send to user.
+ */
 static void debug_enumerator(struct Client* cptr, const char* msg)
 {
   assert(0 != cptr);
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG, ":%s", msg);
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":%s", msg);
 }
 
-/*
- * This is part of the STATS replies. There is no offical numeric for this
- * since this isnt an official command, in much the same way as HASH isnt.
- * It is also possible that some systems wont support this call or have
- * different field names for "struct rusage".
- * -avalon
+/** Send resource usage statistics to a client.
+ * @param cptr Client to send data to.
+ * @param sd StatDesc that generated the stats request (ignored).
+ * @param param Extra parameter from user (ignored).
  */
-void send_usage(struct Client *cptr, char *nick)
+void send_usage(struct Client *cptr, const struct StatDesc *sd,
+                char *param)
 {
-  os_get_rusage(cptr, CurrentTime - me.since, debug_enumerator);
+  os_get_rusage(cptr, CurrentTime - cli_since(&me), debug_enumerator);
 
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG, ":DBUF alloc %d used %d",
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":DBUF alloc %d used %d",
             DBufAllocCount, DBufUsedCount);
 }
 #endif /* DEBUGMODE */
 
-void count_memory(struct Client *cptr, char *nick)
+/** Report memory usage statistics to a client.
+ * @param cptr Client to send data to.
+ * @param sd StatDesc that generated the stats request (ignored).
+ * @param param Extra parameter from user (ignored).
+ */
+void count_memory(struct Client *cptr, const struct StatDesc *sd,
+                  char *param)
 {
   struct Client *acptr;
   struct SLink *link;
+  struct Ban *ban;
   struct Channel *chptr;
   struct ConfItem *aconf;
-  struct ConfClass *cltmp;
+  const struct ConnectionClass* cltmp;
   struct Membership* member;
 
-  int lc = 0,                   /* local clients */
+  int acc = 0,                  /* accounts */
+      c = 0,                    /* clients */
+      cn = 0,                   /* connections */
       ch = 0,                   /* channels */
       lcc = 0,                  /* local client conf links */
-      rc = 0,                   /* remote clients */
-      us = 0,                   /* user structs */
       chi = 0,                  /* channel invites */
       chb = 0,                  /* channel bans */
       wwu = 0,                  /* whowas users */
       cl = 0,                   /* classes */
       co = 0,                   /* conf lines */
+      listeners = 0,            /* listeners */
       memberships = 0;          /* channel memberships */
 
   int usi = 0,                  /* users invited */
       aw = 0,                   /* aways set */
-      wwa = 0;                  /* whowas aways */
+      wwa = 0,                  /* whowas aways */
+      gl = 0,                   /* glines */
+      ju = 0;                   /* jupes */
 
   size_t chm = 0,               /* memory used by channels */
       chbm = 0,                 /* memory used by channel bans */
-      lcm = 0,                  /* memory used by local clients */
-      rcm = 0,                  /* memory used by remote clients */
+      cm = 0,                   /* memory used by clients */
+      cnm = 0,                  /* memory used by connections */
+      us = 0,                   /* user structs */
+      usm = 0,                  /* memory used by user structs */
       awm = 0,                  /* memory used by aways */
       wwam = 0,                 /* whowas away memory used */
       wwm = 0,                  /* whowas array memory used */
+      glm = 0,                  /* memory used by glines */
+      jum = 0,                  /* memory used by jupes */
       com = 0,                  /* memory used by conf lines */
       dbufs_allocated = 0,      /* memory used by dbufs */
       dbufs_used = 0,           /* memory used by dbufs */
+      msg_allocated = 0,       /* memory used by struct Msg */
+      msgbuf_allocated = 0,    /* memory used by struct MsgBuf */
+      listenersm = 0,           /* memory used by listetners */
       rm = 0,                   /* res memory used */
       totcl = 0, totch = 0, totww = 0, tot = 0;
 
   count_whowas_memory(&wwu, &wwm, &wwa, &wwam);
-  wwm += sizeof(struct Whowas) * NICKNAMEHISTORYLENGTH;
+  wwm += sizeof(struct Whowas) * feature_int(FEAT_NICKNAMEHISTORYLENGTH);
   wwm += sizeof(struct Whowas *) * WW_MAX;
 
-  for (acptr = GlobalClientList; acptr; acptr = acptr->next)
+  for (acptr = GlobalClientList; acptr; acptr = cli_next(acptr))
   {
+    c++;
     if (MyConnect(acptr))
     {
-      lc++;
-      for (link = acptr->confs; link; link = link->next)
+      cn++;
+      for (link = cli_confs(acptr); link; link = link->next)
         lcc++;
     }
-    else
-      rc++;
-    if (acptr->user)
+    if (cli_user(acptr))
     {
-      us++;
-      for (link = acptr->user->invited; link; link = link->next)
+      for (link = cli_user(acptr)->invited; link; link = link->next)
         usi++;
-      for (member = acptr->user->channel; member; member = member->next_channel)
+      for (member = cli_user(acptr)->channel; member; member = member->next_channel)
         ++memberships;
-      if (acptr->user->away)
+      if (cli_user(acptr)->away)
       {
         aw++;
-        awm += (strlen(acptr->user->away) + 1);
+        awm += (strlen(cli_user(acptr)->away) + 1);
       }
     }
+
+    if (IsAccount(acptr))
+      acc++;
   }
-  lcm = lc * CLIENT_LOCAL_SIZE;
-  rcm = rc * CLIENT_REMOTE_SIZE;
+  cm = c * sizeof(struct Client);
+  cnm = cn * sizeof(struct Connection);
+  user_count_memory(&us, &usm);
 
   for (chptr = GlobalChannelList; chptr; chptr = chptr->next)
   {
     ch++;
     chm += (strlen(chptr->chname) + sizeof(struct Channel));
-#if 0
-    /*
-     * XXX - Members already counted in clients, don't count twice
-     */
-    for (member = chptr->members; member; member = member->next_member)
-      chu++;
-#endif
     for (link = chptr->invites; link; link = link->next)
       chi++;
-    for (link = chptr->banlist; link; link = link->next)
+    for (ban = chptr->banlist; ban; ban = ban->next)
     {
       chb++;
-      chbm += (strlen(link->value.cp) + 1 + sizeof(struct SLink));
+      chbm += strlen(ban->who) + strlen(ban->banstr) + 2 + sizeof(*ban);
     }
   }
 
@@ -352,50 +308,56 @@ void count_memory(struct Client *cptr, char *nick)
     com += sizeof(struct ConfItem);
   }
 
-  for (cltmp = classes; cltmp; cltmp = cltmp->next)
+  for (cltmp = get_class_list(); cltmp; cltmp = cltmp->next)
     cl++;
 
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG,
-            ":Client Local %d(%zu) Remote %d(%zu)", lc, lcm, rc, rcm);
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG,
-            ":Users %d(%zu) Invites %d(%zu)", us, us * sizeof(struct User),
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
+            ":Clients %d(%zu) Connections %d(%zu)", c, cm, cn, cnm);
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
+            ":Users %zu(%zu) Accounts %d(%zu) Invites %d(%zu)",
+             us, usm, acc, acc * (ACCOUNTLEN + 1),
             usi, usi * sizeof(struct SLink));
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG,
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
             ":User channels %d(%zu) Aways %d(%zu)", memberships,
             memberships * sizeof(struct Membership), aw, awm);
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG, ":Attached confs %d(%zu)",
-            lcc, lcc * sizeof(struct SLink));
 
-  totcl = lcm + rcm + us * sizeof(struct User) + memberships * sizeof(struct Membership) + awm;
+  totcl = cm + cnm + us * sizeof(struct User) + memberships * sizeof(struct Membership) + awm;
   totcl += lcc * sizeof(struct SLink) + usi * sizeof(struct SLink);
 
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG, ":Conflines %d(%zu)", co,
-            com);
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":Conflines %d(%zu) Attached %d(%zu) Classes %d(%zu)",
+             co, com, lcc, lcc * sizeof(struct SLink),
+             cl, cl * sizeof(struct ConnectionClass));
 
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG, ":Classes %d(%zu)", cl,
-            cl * sizeof(struct ConfClass));
-
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG,
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
             ":Channels %d(%zu) Bans %d(%zu)", ch, chm, chb, chbm);
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG,
-            ":Channel membrs %d(%zu) invite %d(%zu)", memberships,
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
+            ":Channel Members %d(%zu) Invites %d(%zu)", memberships,
             memberships * sizeof(struct Membership), chi,
             chi * sizeof(struct SLink));
 
   totch = chm + chbm + chi * sizeof(struct SLink);
 
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG,
-            ":Whowas users %d(%zu) away %d(%zu)", wwu,
-            wwu * sizeof(struct User), wwa, wwam);
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG, ":Whowas array %d(%zu)",
-            NICKNAMEHISTORYLENGTH, wwm);
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
+            ":Whowas Users %d(%zu) Away %d(%zu) Array %d(%zu)",
+             wwu, wwu * sizeof(struct User), wwa, wwam,
+             feature_int(FEAT_NICKNAMEHISTORYLENGTH), wwm);
 
   totww = wwu * sizeof(struct User) + wwam + wwm;
 
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG,
+  motd_memory_count(cptr);
+
+  gl = gline_memory_count(&glm);
+  ju = jupe_memory_count(&jum);
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
+            ":Glines %d(%zu) Jupes %d(%zu)", gl, glm, ju, jum);
+
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
             ":Hash: client %d(%zu), chan is the same", HASHSIZE,
             sizeof(void *) * HASHSIZE);
 
+  count_listener_memory(&listeners, &listenersm);
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
+             ":Listeners allocated %d(%zu)", listeners, listenersm);
   /*
    * NOTE: this count will be accurate only for the exact instant that this
    * message is being sent, so the count is affected by the dbufs that
@@ -405,24 +367,29 @@ void count_memory(struct Client *cptr, char *nick)
    * are sent.
    */
   dbuf_count_memory(&dbufs_allocated, &dbufs_used);
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG,
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
             ":DBufs allocated %d(%zu) used %d(%zu)", DBufAllocCount,
             dbufs_allocated, DBufUsedCount, dbufs_used);
 
+  /* The DBuf caveats now count for this, but this routine now sends
+   * replies all on its own.
+   */
+  msgq_count_memory(cptr, &msg_allocated, &msgbuf_allocated);
+
   rm = cres_mem(cptr);
 
   tot =
-      totww + totch + totcl + com + cl * sizeof(struct ConfClass) + dbufs_allocated +
-      rm;
+      totww + totch + totcl + com + cl * sizeof(struct ConnectionClass) +
+      dbufs_allocated + msg_allocated + msgbuf_allocated + rm;
   tot += sizeof(void *) * HASHSIZE * 3;
 
-#if !defined(NDEBUG)
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG, ":Allocations: %zu(%zu)",
+#if defined(MDEBUG)
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":Allocations: %zu(%zu)",
             fda_get_block_count(), fda_get_byte_count());
 #endif
 
-  send_reply(cptr, RPL_EXPLICIT | RPL_STATSDEBUG,
-            ":Total: ww %zu ch %zu cl %zu co %zu db %zu", totww, totch,
-            totcl, com, dbufs_allocated);
+  send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
+            ":Total: ww %zu ch %zu cl %zu co %zu db %zu ms %zu mb %zu",
+            totww, totch, totcl, com, dbufs_allocated, msg_allocated,
+            msgbuf_allocated);
 }
-