Fix SF bug #1640796; add a test for it.
[ircu2.10.12-pk.git] / ircd / gline.c
index 7201b96933a62d2876639f0e2d47e83ff4b2db79..89f79f077bf691838a6e43dd562999bd467f97c3 100644 (file)
@@ -5,7 +5,7 @@
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 1, or (at your option)
+ * the Free Software Foundation; either version 2, or (at your option)
  * any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * 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 Implementation of Gline manipulation functions.
+ * @version $Id$
  */
 #include "config.h"
 
 #include "s_stats.h"
 #include "send.h"
 #include "struct.h"
-#include "support.h"
 #include "msg.h"
 #include "numnicks.h"
 #include "numeric.h"
-#include "sys.h"    /* FALSE bleah */
 #include "whocmds.h"
 
-#include <assert.h>
+/* #include <assert.h> -- Now using assert in ircd_log.h */
 #include <string.h>
 #include <stdio.h>
 #include <stdlib.h>
-#include <arpa/inet.h> /* for inet_ntoa */
 
-#define CHECK_APPROVED    0    /* Mask is acceptable */
-#define CHECK_OVERRIDABLE  1   /* Mask is acceptable, but not by default */
-#define CHECK_REJECTED    2    /* Mask is totally unacceptable */
+#define CHECK_APPROVED    0    /**< Mask is acceptable */
+#define CHECK_OVERRIDABLE  1   /**< Mask is acceptable, but not by default */
+#define CHECK_REJECTED    2    /**< Mask is totally unacceptable */
 
-#define MASK_WILD_0    0x01    /* Wildcards in the last position */
-#define MASK_WILD_1    0x02    /* Wildcards in the next-to-last position */
+#define MASK_WILD_0    0x01    /**< Wildcards in the last position */
+#define MASK_WILD_1    0x02    /**< Wildcards in the next-to-last position */
 
-#define MASK_WILD_MASK 0x03    /* Mask out the positional wildcards */
+#define MASK_WILD_MASK 0x03    /**< Mask out the positional wildcards */
 
-#define MASK_WILDS     0x10    /* Mask contains wildcards */
-#define MASK_IP                0x20    /* Mask is an IP address */
-#define MASK_HALT      0x40    /* Finished processing mask */
+#define MASK_WILDS     0x10    /**< Mask contains wildcards */
+#define MASK_IP                0x20    /**< Mask is an IP address */
+#define MASK_HALT      0x40    /**< Finished processing mask */
 
+/** List of user G-lines. */
 struct Gline* GlobalGlineList  = 0;
+/** List of BadChan G-lines. */
 struct Gline* BadChanGlineList = 0;
 
+/** Find canonical user and host for a string.
+ * If \a userhost starts with '$', assign \a userhost to *user_p and NULL to *host_p.
+ * Otherwise, if \a userhost contains '@', assign the earlier part of it to *user_p and the rest to *host_p.
+ * Otherwise, assign \a def_user to *user_p and \a userhost to *host_p.
+ *
+ * @param[in] userhost Input string from user.
+ * @param[out] user_p Gets pointer to user (or channel/realname) part of hostmask.
+ * @param[out] host_p Gets point to host part of hostmask (may be assigned NULL).
+ * @param[in] def_user Default value for user part.
+ */
 static void
 canon_userhost(char *userhost, char **user_p, char **host_p, char *def_user)
 {
@@ -88,6 +99,15 @@ canon_userhost(char *userhost, char **user_p, char **host_p, char *def_user)
   }
 }
 
+/** Create a Gline structure.
+ * @param[in] user User part of mask.
+ * @param[in] host Host part of mask (NULL if not applicable).
+ * @param[in] reason Reason for G-line.
+ * @param[in] expire Expiration timestamp.
+ * @param[in] lastmod Last modification timestamp.
+ * @param[in] flags Bitwise combination of GLINE_* bits.
+ * @return Newly allocated G-line.
+ */
 static struct Gline *
 make_gline(char *user, char *host, char *reason, time_t expire, time_t lastmod,
           unsigned int flags)
@@ -141,45 +161,8 @@ make_gline(char *user, char *host, char *reason, time_t expire, time_t lastmod,
     else
       gline->gl_host = NULL;
 
-    if (*user != '$' && check_if_ipmask(host)) { /* mark if it's an IP mask */
-      int c_class;
-      char ipname[16];
-      int ad[4] = { 0 };
-      int bits2 = 0;
-      char *ch;
-      int seenwild;
-      int badmask=0;
-      
-      /* Sanity check for dodgy IP masks 
-       * Any mask featuring a digit after a wildcard will 
-       * not behave as expected. */
-      for (seenwild=0,ch=host;*ch;ch++) {
-        if (*ch=='*' || *ch=='?') 
-          seenwild=1;
-        if (IsDigit(*ch) && seenwild) {
-          badmask=1;
-          break;
-        }
-      }
-      
-      if (badmask) {
-        /* It's bad - let's make it match 0.0.0.0/32 */
-        gline->bits=32;
-        gline->ipnum.s_addr=0;
-      } else {
-        c_class = sscanf(host,"%d.%d.%d.%d/%d",
-                         &ad[0],&ad[1],&ad[2],&ad[3], &bits2);
-        if (c_class!=5)
-          gline->bits=c_class*8;
-        else
-          gline->bits=bits2;
-        ircd_snprintf(0, ipname, sizeof(ipname), "%d.%d.%d.%d", ad[0], ad[1],
-                      ad[2], ad[3]);
-        gline->ipnum.s_addr = inet_addr(ipname);
-      }
-      Debug((DEBUG_DEBUG,"IP gline: %08x/%i",gline->ipnum.s_addr,gline->bits));
+    if (*user != '$' && ipmask_parse(host, &gline->gl_addr, &gline->gl_bits))
       gline->gl_flags |= GLINE_IPMASK;
-    }
 
     if (after) {
       gline->gl_next = after->gl_next;
@@ -199,12 +182,22 @@ make_gline(char *user, char *host, char *reason, time_t expire, time_t lastmod,
   return gline;
 }
 
+/** Check local clients against a new G-line.
+ * If the G-line is inactive or a badchan, return immediately.
+ * Otherwise, if any users match it, disconnect them.
+ * @param[in] cptr Peer connect that sent the G-line.
+ * @param[in] sptr Client that originated the G-line.
+ * @param[in] gline New G-line to check.
+ * @return Zero, unless \a sptr G-lined himself, in which case CPTR_KILLED.
+ */
 static int
 do_gline(struct Client *cptr, struct Client *sptr, struct Gline *gline)
 {
   struct Client *acptr;
   int fd, retval = 0, tval;
 
+  if (GlineIsBadChan(gline)) /* no action taken on badchan glines */
+    return 0;
   if (!GlineIsActive(gline)) /* no action taken on inactive glines */
     return 0;
 
@@ -215,7 +208,7 @@ do_gline(struct Client *cptr, struct Client *sptr, struct Gline *gline)
     if ((acptr = LocalClientArray[fd])) {
       if (!cli_user(acptr))
        continue;
-       
+
       if (GlineIsRealName(gline)) { /* Realname Gline */
        Debug((DEBUG_DEBUG,"Realname Gline: %s %s",(cli_info(acptr)),
                                        gline->gl_user+2));
@@ -223,13 +216,12 @@ do_gline(struct Client *cptr, struct Client *sptr, struct Gline *gline)
             continue;
         Debug((DEBUG_DEBUG,"Matched!"));
       } else { /* Host/IP gline */
-        if (cli_user(acptr)->username && 
+        if (cli_user(acptr)->username &&
             match(gline->gl_user, (cli_user(acptr))->username) != 0)
-            continue;
-          
+          continue;
+
         if (GlineIsIpMask(gline)) {
-          Debug((DEBUG_DEBUG,"IP gline: %08x %08x/%i",(cli_ip(cptr)).s_addr,gline->ipnum.s_addr,gline->bits));
-          if (((cli_ip(acptr)).s_addr & NETMASK(gline->bits)) != gline->ipnum.s_addr)
+          if (!ipmask_check(&cli_ip(acptr), &gline->gl_addr, gline->gl_bits))
             continue;
         }
         else {
@@ -244,7 +236,7 @@ do_gline(struct Client *cptr, struct Client *sptr, struct Gline *gline)
 
       /* let the ops know about it */
       sendto_opmask_butone(0, SNO_GLINE, "G-line active for %s",
-                    get_client_name(acptr, TRUE));
+                           get_client_name(acptr, SHOW_IP));
 
       /* and get rid of him */
       if ((tval = exit_client_msg(cptr, acptr, &me, "G-lined (%s)",
@@ -255,12 +247,14 @@ do_gline(struct Client *cptr, struct Client *sptr, struct Gline *gline)
   return retval;
 }
 
-/*
- * This routine implements the mask checking applied to local
- * G-lines.  Basically, host masks must have a minimum of two non-wild
- * domain fields, and IP masks must have a minimum of 16 bits.  If the
- * mask has even one wild-card, OVERRIDABLE is returned, assuming the
- * other check doesn't fail.
+/**
+ * Implements the mask checking applied to local G-lines.
+ * Basically, host masks must have a minimum of two non-wild domain
+ * fields, and IP masks must have a minimum of 16 bits.  If the mask
+ * has even one wild-card, OVERRIDABLE is returned, assuming the other
+ * check doesn't fail.
+ * @param[in] mask G-line mask to check.
+ * @return One of CHECK_REJECTED, CHECK_OVERRIDABLE, or CHECK_APPROVED.
  */
 static int
 gline_checkmask(char *mask)
@@ -282,17 +276,24 @@ gline_checkmask(char *mask)
       ++mask;
       ipmask = strtoul(mask, &mask, 10);
 
-      if (*mask || dots != 3 || ipmask > 32 || /* sanity-check to date */
-         (flags & (MASK_WILDS | MASK_IP)) != MASK_IP)
-       return CHECK_REJECTED; /* how strange... */
-
-      if (ipmask < 32) /* it's a masked address; mark wilds */
-       flags |= MASK_WILDS;
+      /* sanity-check to date */
+      if (*mask || (flags & (MASK_WILDS | MASK_IP)) != MASK_IP)
+       return CHECK_REJECTED;
+      if (!dots) {
+        if (ipmask > 128)
+          return CHECK_REJECTED;
+        if (ipmask < 128)
+          flags |= MASK_WILDS;
+      } else {
+        if (dots != 3 || ipmask > 32)
+          return CHECK_REJECTED;
+        if (ipmask < 32)
+         flags |= MASK_WILDS;
+      }
 
       flags |= MASK_HALT; /* Halt the ipmask calculation */
-
       break; /* get out of the loop */
-    } else if (!IsDigit(*mask)) {
+    } else if (!IsIP6Char(*mask)) {
       flags &= ~MASK_IP; /* not an IP anymore! */
       ipmask = 0;
     }
@@ -318,6 +319,12 @@ gline_checkmask(char *mask)
   return flags & MASK_WILDS ? CHECK_OVERRIDABLE : CHECK_APPROVED;
 }
 
+/** Forward a G-line to other servers.
+ * @param[in] cptr Client that sent us the G-line.
+ * @param[in] sptr Client that originated the G-line.
+ * @param[in] gline G-line to forward.
+ * @return Zero.
+ */
 int
 gline_propagate(struct Client *cptr, struct Client *sptr, struct Gline *gline)
 {
@@ -343,7 +350,23 @@ gline_propagate(struct Client *cptr, struct Client *sptr, struct Gline *gline)
   return 0;
 }
 
-int 
+/** Create a new G-line and add it to global lists.
+ * \a userhost may be in one of four forms:
+ * \li A channel name, to add a BadChan.
+ * \li A string starting with $R and followed by a mask to match against their realname.
+ * \li A user\@IP mask (user\@ part optional) to create an IP-based ban.
+ * \li A user\@host mask (user\@ part optional) to create a hostname ban.
+ *
+ * @param[in] cptr Client that sent us the G-line.
+ * @param[in] sptr Client that originated the G-line.
+ * @param[in] userhost Text mask for the G-line.
+ * @param[in] reason Reason for G-line.
+ * @param[in] expire Duration of G-line in seconds.
+ * @param[in] lastmod Last modification time of G-line.
+ * @param[in] flags Bitwise combination of GLINE_* flags.
+ * @return Zero or CPTR_KILLED, depending on whether \a sptr is suicidal.
+ */
+int
 gline_add(struct Client *cptr, struct Client *sptr, char *userhost,
          char *reason, time_t expire, time_t lastmod, unsigned int flags)
 {
@@ -355,35 +378,26 @@ gline_add(struct Client *cptr, struct Client *sptr, char *userhost,
   assert(0 != userhost);
   assert(0 != reason);
 
-  /* NO_OLD_GLINE allows *@#channel to work correctly */
-  if (*userhost == '#' || *userhost == '&'
-# ifndef NO_OLD_GLINE
-      || ((userhost[2] == '#' || userhost[2] == '&') && (userhost[1] == '@'))
-# endif /* OLD_GLINE */
-      ) {
+  if (*userhost == '#' || *userhost == '&') {
     if ((flags & GLINE_LOCAL) && !HasPriv(sptr, PRIV_LOCAL_BADCHAN))
       return send_reply(sptr, ERR_NOPRIVILEGES);
 
     flags |= GLINE_BADCHAN;
-# ifndef NO_OLD_GLINE
-    if ((userhost[2] == '#' || userhost[2] == '&') && (userhost[1] == '@'))
-      user = userhost + 2;
-    else
-# endif /* OLD_GLINE */
-      user = userhost;
+    user = userhost;
     host = 0;
-  } else if (*userhost == '$' 
-# ifndef NO_OLD_GLINE
-  || userhost[2] == '$'
-# endif /* OLD_GLINE */
-  ) {
+  } else if (*userhost == '$') {
     switch (*userhost == '$' ? userhost[1] : userhost[3]) {
       case 'R': flags |= GLINE_REALNAME; break;
       default:
         /* uh, what to do here? */
         /* The answer, my dear Watson, is we throw a protocol_violation()
            -- hikari */
-        return protocol_violation(sptr,"%s has been smoking the sweet leaf and sent me a whacky gline",cli_name(sptr));
+        if (IsServer(cptr))
+          return protocol_violation(sptr,"%s has been smoking the sweet leaf and sent me a whacky gline",cli_name(sptr));
+        else {
+         sendto_opmask_butone(NULL, SNO_GLINE, "%s has been smoking the sweet leaf and sent me a whacky gline", cli_name(sptr));
+         return 0;
+        }
         break;
     }
      user = (*userhost =='$' ? userhost : userhost+2);
@@ -437,9 +451,11 @@ gline_add(struct Client *cptr, struct Client *sptr, char *userhost,
 
   /* and log it */
   log_write(LS_GLINE, L_INFO, LOG_NOSNOTICE,
-           "%#C adding %s %s for %s, expiring at %Tu: %s", sptr,
+           "%#C adding %s %s for %s%s%s, expiring at %Tu: %s", sptr,
            flags & GLINE_LOCAL ? "local" : "global",
-           flags & GLINE_BADCHAN ? "BADCHAN" : "GLINE", userhost,
+           flags & GLINE_BADCHAN ? "BADCHAN" : "GLINE", user,
+           flags & (GLINE_BADCHAN|GLINE_REALNAME) ? "" : "@",
+           flags & (GLINE_BADCHAN|GLINE_REALNAME) ? "" : host,
            expire + TSoffset, reason);
 
   /* make the gline */
@@ -450,12 +466,17 @@ gline_add(struct Client *cptr, struct Client *sptr, char *userhost,
 
   gline_propagate(cptr, sptr, agline);
 
-  if (GlineIsBadChan(agline))
-    return 0;
-
   return do_gline(cptr, sptr, agline); /* knock off users if necessary */
 }
 
+/** Activate a currently inactive G-line.
+ * @param[in] cptr Peer that told us to activate the G-line.
+ * @param[in] sptr Client that originally thought it was a good idea.
+ * @param[in] gline G-line to activate.
+ * @param[in] lastmod New value for last modification timestamp.
+ * @param[in] flags 0 if the activation should be propagated, GLINE_LOCAL if not.
+ * @return Zero, unless \a sptr had a death wish (in which case CPTR_KILLED).
+ */
 int
 gline_activate(struct Client *cptr, struct Client *sptr, struct Gline *gline,
               time_t lastmod, unsigned int flags)
@@ -503,9 +524,17 @@ gline_activate(struct Client *cptr, struct Client *sptr, struct Gline *gline,
   if (!(flags & GLINE_LOCAL)) /* don't propagate local changes */
     gline_propagate(cptr, sptr, gline);
 
-  return GlineIsBadChan(gline) ? 0 : do_gline(cptr, sptr, gline);
+  return do_gline(cptr, sptr, gline);
 }
 
+/** Deactivate a G-line.
+ * @param[in] cptr Peer that gave us the message.
+ * @param[in] sptr Client that initiated the deactivation.
+ * @param[in] gline G-line to deactivate.
+ * @param[in] lastmod New value for G-line last modification timestamp.
+ * @param[in] flags GLINE_LOCAL to only deactivate locally, 0 to propagate.
+ * @return Zero.
+ */
 int
 gline_deactivate(struct Client *cptr, struct Client *sptr, struct Gline *gline,
                 time_t lastmod, unsigned int flags)
@@ -570,6 +599,20 @@ gline_deactivate(struct Client *cptr, struct Client *sptr, struct Gline *gline,
   return 0;
 }
 
+/** Find a G-line for a particular mask, guided by certain flags.
+ * Certain bits in \a flags are interpreted specially:
+ * <dl>
+ * <dt>GLINE_ANY</dt><dd>Search both BadChans and user G-lines.</dd>
+ * <dt>GLINE_BADCHAN</dt><dd>Search BadChans.</dd>
+ * <dt>GLINE_GLOBAL</dt><dd>Only match global G-lines.</dd>
+ * <dt>GLINE_LASTMOD</dt><dd>Only match G-lines with a last modification time.</dd>
+ * <dt>GLINE_EXACT</dt><dd>Require an exact match of G-line mask.</dd>
+ * <dt>anything else</dt><dd>Search user G-lines.</dd>
+ * </dl>
+ * @param[in] userhost Mask to search for.
+ * @param[in] flags Bitwise combination of GLINE_* flags.
+ * @return First matching G-line, or NULL if none are found.
+ */
 struct Gline *
 gline_find(char *userhost, unsigned int flags)
 {
@@ -593,18 +636,11 @@ gline_find(char *userhost, unsigned int flags)
   }
 
   if ((flags & (GLINE_BADCHAN | GLINE_ANY)) == GLINE_BADCHAN ||
-      *userhost == '#' || *userhost == '&'
-#ifndef NO_OLD_GLINE
-      || userhost[2] == '#' || userhost[2] == '&'
-#endif /* NO_OLD_GLINE */
-      )
+      *userhost == '#' || *userhost == '&')
     return 0;
 
   DupString(t_uh, userhost);
-  canon_userhost(t_uh, &user, &host, 0);
-
-  if (BadPtr(user))
-    return 0;
+  canon_userhost(t_uh, &user, &host, "*");
 
   for (gline = GlobalGlineList; gline; gline = sgline) {
     sgline = gline->gl_next;
@@ -617,14 +653,12 @@ gline_find(char *userhost, unsigned int flags)
     else if (flags & GLINE_EXACT) {
       if (((gline->gl_host && host && ircd_strcmp(gline->gl_host, host) == 0)
            || (!gline->gl_host && !host)) &&
-          ((!user && ircd_strcmp(gline->gl_user, "*") == 0) ||
-          ircd_strcmp(gline->gl_user, user) == 0))
+          (ircd_strcmp(gline->gl_user, user) == 0))
        break;
     } else {
-      if (((gline->gl_host && host && ircd_strcmp(gline->gl_host, host) == 0)
+      if (((gline->gl_host && host && match(gline->gl_host, host) == 0)
            || (!gline->gl_host && !host)) &&
-         ((!user && ircd_strcmp(gline->gl_user, "*") == 0) ||
-          match(gline->gl_user, user) == 0))
+         (match(gline->gl_user, user) == 0))
       break;
     }
   }
@@ -634,6 +668,12 @@ gline_find(char *userhost, unsigned int flags)
   return gline;
 }
 
+/** Find a matching G-line for a user.
+ * @param[in] cptr Client to compare against.
+ * @param[in] flags Bitwise combination of GLINE_GLOBAL and/or
+ * GLINE_LASTMOD to limit matches.
+ * @return Matching G-line, or NULL if none are found.
+ */
 struct Gline *
 gline_lookup(struct Client *cptr, unsigned int flags)
 {
@@ -647,7 +687,7 @@ gline_lookup(struct Client *cptr, unsigned int flags)
       gline_free(gline);
       continue;
     }
-    
+
     if ((flags & GLINE_GLOBAL && gline->gl_flags & GLINE_LOCAL) ||
         (flags & GLINE_LASTMOD && !gline->gl_lastmod))
       continue;
@@ -656,21 +696,17 @@ gline_lookup(struct Client *cptr, unsigned int flags)
       Debug((DEBUG_DEBUG,"realname gline: '%s' '%s'",gline->gl_user,cli_info(cptr)));
       if (match(gline->gl_user+2, cli_info(cptr)) != 0)
         continue;
-      if (!GlineIsActive(gline))
-        continue;
-      return gline;
     }
     else {
       if (match(gline->gl_user, (cli_user(cptr))->username) != 0)
         continue;
-        
+
       if (GlineIsIpMask(gline)) {
-        Debug((DEBUG_DEBUG,"IP gline: %08x %08x/%i",(cli_ip(cptr)).s_addr,gline->ipnum.s_addr,gline->bits));
-        if (((cli_ip(cptr)).s_addr & NETMASK(gline->bits)) != gline->ipnum.s_addr)
+        if (!ipmask_check(&cli_ip(cptr), &gline->gl_addr, gline->gl_bits))
           continue;
       }
       else {
-        if (match(gline->gl_host, (cli_user(cptr))->realhost) != 0) 
+        if (match(gline->gl_host, (cli_user(cptr))->realhost) != 0)
           continue;
       }
     }
@@ -683,6 +719,9 @@ gline_lookup(struct Client *cptr, unsigned int flags)
   return 0;
 }
 
+/** Delink and free a G-line.
+ * @param[in] gline G-line to free.
+ */
 void
 gline_free(struct Gline *gline)
 {
@@ -699,6 +738,9 @@ gline_free(struct Gline *gline)
   MyFree(gline);
 }
 
+/** Burst all known global G-lines to another server.
+ * @param[in] cptr Destination of burst.
+ */
 void
 gline_burst(struct Client *cptr)
 {
@@ -732,6 +774,11 @@ gline_burst(struct Client *cptr)
   }
 }
 
+/** Send a G-line to another server.
+ * @param[in] cptr Who to inform of the G-line.
+ * @param[in] gline G-line to send.
+ * @return Zero.
+ */
 int
 gline_resend(struct Client *cptr, struct Gline *gline)
 {
@@ -748,6 +795,13 @@ gline_resend(struct Client *cptr, struct Gline *gline)
   return 0;
 }
 
+/** Display one or all G-lines to a user.
+ * If \a userhost is not NULL, only send the first matching G-line.
+ * Otherwise send the whole list.
+ * @param[in] sptr User asking for G-line list.
+ * @param[in] userhost G-line mask to search for (or NULL).
+ * @return Zero.
+ */
 int
 gline_list(struct Client *sptr, char *userhost)
 {
@@ -797,8 +851,13 @@ gline_list(struct Client *sptr, char *userhost)
   return send_reply(sptr, RPL_ENDOFGLIST);
 }
 
+/** Statistics callback to list G-lines.
+ * @param[in] sptr Client requesting statistics.
+ * @param[in] sd Stats descriptor for request (ignored).
+ * @param[in] param Extra parameter from user (ignored).
+ */
 void
-gline_stats(struct Client *sptr, struct StatDesc *sd, int stat,
+gline_stats(struct Client *sptr, const struct StatDesc *sd,
             char *param)
 {
   struct Gline *gline;
@@ -813,16 +872,22 @@ gline_stats(struct Client *sptr, struct StatDesc *sd, int stat,
       send_reply(sptr, RPL_STATSGLINE, 'G', gline->gl_user,
                  gline->gl_host ? "@" : "",
                  gline->gl_host ? gline->gl_host : "",
-                gline->gl_expire + TSoffset, gline->gl_reason);
+                gline->gl_expire + TSoffset,
+                 GlineIsActive(gline) ? '+' : '-',
+                 gline->gl_reason);
   }
 }
 
+/** Calculate memory used by G-lines.
+ * @param[out] gl_size Number of bytes used by G-lines.
+ * @return Number of G-lines in use.
+ */
 int
 gline_memory_count(size_t *gl_size)
 {
   struct Gline *gline;
   unsigned int gl = 0;
-  
+
   for (gline = GlobalGlineList; gline; gline = gline->gl_next)
   {
     gl++;
@@ -833,4 +898,3 @@ gline_memory_count(size_t *gl_size)
   }
   return gl;
 }
-