net/sctp/objcnt.c

   1 /* SCTP kernel reference Implementation
   2  * (C) Copyright IBM Corp. 2001, 2004
   3  *
   4  * This file is part of the SCTP kernel reference Implementation
   5  *
   6  * Support for memory object debugging.  This allows one to monitor the
   7  * object allocations/deallocations for types instrumented for this
   8  * via the proc fs.
   9  *
  10  * The SCTP reference implementation is free software;
  11  * you can redistribute it and/or modify it under the terms of
  12  * the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2, or (at your option)
  14  * any later version.
  15  *
  16  * The SCTP reference implementation is distributed in the hope that it
  17  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  18  *                 ************************
  19  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  20  * See the GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with GNU CC; see the file COPYING.  If not, write to
  24  * the Free Software Foundation, 59 Temple Place - Suite 330,
  25  * Boston, MA 02111-1307, USA.
  26  *
  27  * Please send any bug reports or fixes you make to the
  28  * email address(es):
  29  *    lksctp developers <lksctp-developers@lists.sourceforge.net>
  30  *
  31  * Or submit a bug report through the following website:
  32  *    http://www.sf.net/projects/lksctp
  33  *
  34  * Written or modified by:
  35  *    Jon Grimm             <jgrimm@us.ibm.com>
  36  *
  37  * Any bugs reported given to us we will try to fix... any fixes shared will
  38  * be incorporated into the next SCTP release.
  39  */
  40
  41 #include <linux/kernel.h>
  42 #include <net/sctp/sctp.h>
  43
  44 /*
  45  * Global counters to count raw object allocation counts.
  46  * To add new counters, choose a unique suffix for the variable
  47  * name as the helper macros key off this suffix to make
  48  * life easier for the programmer.
  49  */
  50
  51 SCTP_DBG_OBJCNT(sock);
  52 SCTP_DBG_OBJCNT(ep);
  53 SCTP_DBG_OBJCNT(transport);
  54 SCTP_DBG_OBJCNT(assoc);
  55 SCTP_DBG_OBJCNT(bind_addr);
  56 SCTP_DBG_OBJCNT(bind_bucket);
  57 SCTP_DBG_OBJCNT(chunk);
  58 SCTP_DBG_OBJCNT(addr);
  59 SCTP_DBG_OBJCNT(ssnmap);
  60 SCTP_DBG_OBJCNT(datamsg);
  61
  62 /* An array to make it easy to pretty print the debug information
  63  * to the proc fs.
  64  */
  65 static sctp_dbg_objcnt_entry_t sctp_dbg_objcnt[] = {
  66         SCTP_DBG_OBJCNT_ENTRY(sock),
  67         SCTP_DBG_OBJCNT_ENTRY(ep),
  68         SCTP_DBG_OBJCNT_ENTRY(assoc),
  69         SCTP_DBG_OBJCNT_ENTRY(transport),
  70         SCTP_DBG_OBJCNT_ENTRY(chunk),
  71         SCTP_DBG_OBJCNT_ENTRY(bind_addr),
  72         SCTP_DBG_OBJCNT_ENTRY(bind_bucket),
  73         SCTP_DBG_OBJCNT_ENTRY(addr),
  74         SCTP_DBG_OBJCNT_ENTRY(ssnmap),
  75         SCTP_DBG_OBJCNT_ENTRY(datamsg),
  76 };
  77
  78 /* Callback from procfs to read out objcount information.
  79  * Walk through the entries in the sctp_dbg_objcnt array, dumping
  80  * the raw object counts for each monitored type.
  81  *
  82  * This code was modified from similar code in route.c
  83  */
  84 static int sctp_dbg_objcnt_read(char *buffer, char **start, off_t offset,
  85                                 int length, int *eof, void *data)
  86 {
  87         int len = 0;
  88         off_t pos = 0;
  89         int entries;
  90         int i;
  91         char temp[128];
  92
  93         /* How many entries? */
  94         entries = ARRAY_SIZE(sctp_dbg_objcnt);
  95
  96         /* Walk the entries and print out the debug information
  97          * for proc fs.
  98          */
  99         for (i = 0; i < entries; i++) {
 100                 pos += 128;
 101
 102                 /* Skip ahead. */
 103                 if (pos <= offset) {
 104                         len = 0;
 105                         continue;
 106                 }
 107                 /* Print out each entry. */
 108                 sprintf(temp, "%s: %d",
 109                         sctp_dbg_objcnt[i].label,
 110                         atomic_read(sctp_dbg_objcnt[i].counter));
 111
 112                 sprintf(buffer + len, "%-127s\n", temp);
 113                 len += 128;
 114                 if (pos >= offset+length)
 115                         goto done;
 116         }
 117
 118 done:
 119         *start = buffer + len - (pos - offset);
 120         len = pos - offset;
 121         if (len > length)
 122                 len = length;
 123
 124         return len;
 125 }
 126
 127 /* Initialize the objcount in the proc filesystem.  */
 128 void sctp_dbg_objcnt_init(void)
 129 {
 130         struct proc_dir_entry *ent;
 131         ent = create_proc_read_entry("sctp_dbg_objcnt", 0, proc_net_sctp,
 132                                sctp_dbg_objcnt_read, NULL);
 133         if (!ent)
 134                 printk(KERN_WARNING
 135                         "sctp_dbg_objcnt: Unable to create /proc entry.\n");
 136 }
 137
 138 /* Cleanup the objcount entry in the proc filesystem.  */
 139 void sctp_dbg_objcnt_exit(void)
 140 {
 141         remove_proc_entry("sctp_dbg_objcnt", proc_net_sctp);
 142 }
 143
 144