net/core/gen_stats.c

   1 /*
   2  * net/core/gen_stats.c
   3  *
   4  *             This program is free software; you can redistribute it and/or
   5  *             modify it under the terms of the GNU General Public License
   6  *             as published by the Free Software Foundation; either version
   7  *             2 of the License, or (at your option) any later version.
   8  *
   9  * Authors:  Thomas Graf <tgraf@suug.ch>
  10  *           Jamal Hadi Salim
  11  *           Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
  12  *
  13  * See Documentation/networking/gen_stats.txt
  14  */
  15
  16 #include <linux/types.h>
  17 #include <linux/kernel.h>
  18 #include <linux/module.h>
  19 #include <linux/interrupt.h>
  20 #include <linux/socket.h>
  21 #include <linux/rtnetlink.h>
  22 #include <linux/gen_stats.h>
  23 #include <net/gen_stats.h>
  24
  25
  26 static inline int
  27 gnet_stats_copy(struct gnet_dump *d, int type, void *buf, int size)
  28 {
  29         RTA_PUT(d->skb, type, size, buf);
  30         return 0;
  31
  32 rtattr_failure:
  33         spin_unlock_bh(d->lock);
  34         return -1;
  35 }
  36
  37 /**
  38  * gnet_stats_start_copy_compat - start dumping procedure in compatibility mode
  39  * @skb: socket buffer to put statistics TLVs into
  40  * @type: TLV type for top level statistic TLV
  41  * @tc_stats_type: TLV type for backward compatibility struct tc_stats TLV
  42  * @xstats_type: TLV type for backward compatibility xstats TLV
  43  * @lock: statistics lock
  44  * @d: dumping handle
  45  *
  46  * Initializes the dumping handle, grabs the statistic lock and appends
  47  * an empty TLV header to the socket buffer for use a container for all
  48  * other statistic TLVS.
  49  *
  50  * The dumping handle is marked to be in backward compatibility mode telling
  51  * all gnet_stats_copy_XXX() functions to fill a local copy of struct tc_stats.
  52  *
  53  * Returns 0 on success or -1 if the room in the socket buffer was not sufficient.
  54  */
  55 int
  56 gnet_stats_start_copy_compat(struct sk_buff *skb, int type, int tc_stats_type,
  57         int xstats_type, spinlock_t *lock, struct gnet_dump *d)
  58 {
  59         spin_lock_bh(lock);
  60         d->lock = lock;
  61         d->tail = (struct rtattr *) skb->tail;
  62         d->skb = skb;
  63         d->compat_tc_stats = tc_stats_type;
  64         d->compat_xstats = xstats_type;
  65         d->xstats = NULL;
  66
  67         if (d->compat_tc_stats)
  68                 memset(&d->tc_stats, 0, sizeof(d->tc_stats));
  69
  70         return gnet_stats_copy(d, type, NULL, 0);
  71 }
  72
  73 /**
  74  * gnet_stats_start_copy_compat - start dumping procedure in compatibility mode
  75  * @skb: socket buffer to put statistics TLVs into
  76  * @type: TLV type for top level statistic TLV
  77  * @lock: statistics lock
  78  * @d: dumping handle
  79  *
  80  * Initializes the dumping handle, grabs the statistic lock and appends
  81  * an empty TLV header to the socket buffer for use a container for all
  82  * other statistic TLVS.
  83  *
  84  * Returns 0 on success or -1 if the room in the socket buffer was not sufficient.
  85  */
  86 int
  87 gnet_stats_start_copy(struct sk_buff *skb, int type, spinlock_t *lock,
  88         struct gnet_dump *d)
  89 {
  90         return gnet_stats_start_copy_compat(skb, type, 0, 0, lock, d);
  91 }
  92
  93 /**
  94  * gnet_stats_copy_basic - copy basic statistics into statistic TLV
  95  * @d: dumping handle
  96  * @b: basic statistics
  97  *
  98  * Appends the basic statistics to the top level TLV created by
  99  * gnet_stats_start_copy().
 100  *
 101  * Returns 0 on success or -1 with the statistic lock released
 102  * if the room in the socket buffer was not sufficient.
 103  */
 104 int
 105 gnet_stats_copy_basic(struct gnet_dump *d, struct gnet_stats_basic *b)
 106 {
 107         if (d->compat_tc_stats) {
 108                 d->tc_stats.bytes = b->bytes;
 109                 d->tc_stats.packets = b->packets;
 110         }
 111
 112         return gnet_stats_copy(d, TCA_STATS_BASIC, b, sizeof(*b));
 113 }
 114
 115 /**
 116  * gnet_stats_copy_rate_est - copy rate estimator statistics into statistics TLV
 117  * @d: dumping handle
 118  * @r: rate estimator statistics
 119  *
 120  * Appends the rate estimator statistics to the top level TLV created by
 121  * gnet_stats_start_copy().
 122  *
 123  * Returns 0 on success or -1 with the statistic lock released
 124  * if the room in the socket buffer was not sufficient.
 125  */
 126 int
 127 gnet_stats_copy_rate_est(struct gnet_dump *d, struct gnet_stats_rate_est *r)
 128 {
 129         if (d->compat_tc_stats) {
 130                 d->tc_stats.bps = r->bps;
 131                 d->tc_stats.pps = r->pps;
 132         }
 133
 134         return gnet_stats_copy(d, TCA_STATS_RATE_EST, r, sizeof(*r));
 135 }
 136
 137 /**
 138  * gnet_stats_copy_queue - copy queue statistics into statistics TLV
 139  * @d: dumping handle
 140  * @q: queue statistics
 141  *
 142  * Appends the queue statistics to the top level TLV created by
 143  * gnet_stats_start_copy().
 144  *
 145  * Returns 0 on success or -1 with the statistic lock released
 146  * if the room in the socket buffer was not sufficient.
 147  */
 148 int
 149 gnet_stats_copy_queue(struct gnet_dump *d, struct gnet_stats_queue *q)
 150 {
 151         if (d->compat_tc_stats) {
 152                 d->tc_stats.drops = q->drops;
 153                 d->tc_stats.qlen = q->qlen;
 154                 d->tc_stats.backlog = q->backlog;
 155                 d->tc_stats.overlimits = q->overlimits;
 156         }
 157
 158         return gnet_stats_copy(d, TCA_STATS_QUEUE, q, sizeof(*q));
 159 }
 160
 161 /**
 162  * gnet_stats_copy_app - copy application specific statistics into statistics TLV
 163  * @d: dumping handle
 164  * @st: application specific statistics data
 165  * @len: length of data
 166  *
 167  * Appends the application sepecific statistics to the top level TLV created by
 168  * gnet_stats_start_copy() and remembers the data for XSTATS if the dumping
 169  * handle is in backward compatibility mode.
 170  *
 171  * Returns 0 on success or -1 with the statistic lock released
 172  * if the room in the socket buffer was not sufficient.
 173  */
 174 int
 175 gnet_stats_copy_app(struct gnet_dump *d, void *st, int len)
 176 {
 177         if (d->compat_xstats)
 178                 d->xstats = (struct rtattr *) d->skb->tail;
 179         return gnet_stats_copy(d, TCA_STATS_APP, st, len);
 180 }
 181
 182 /**
 183  * gnet_stats_finish_copy - finish dumping procedure
 184  * @d: dumping handle
 185  *
 186  * Corrects the length of the top level TLV to include all TLVs added
 187  * by gnet_stats_copy_XXX() calls. Adds the backward compatibility TLVs
 188  * if gnet_stats_start_copy_compat() was used and releases the statistics
 189  * lock.
 190  *
 191  * Returns 0 on success or -1 with the statistic lock released
 192  * if the room in the socket buffer was not sufficient.
 193  */
 194 int
 195 gnet_stats_finish_copy(struct gnet_dump *d)
 196 {
 197         d->tail->rta_len = d->skb->tail - (u8 *) d->tail;
 198
 199         if (d->compat_tc_stats)
 200                 if (gnet_stats_copy(d, d->compat_tc_stats, &d->tc_stats,
 201                         sizeof(d->tc_stats)) < 0)
 202                         return -1;
 203
 204         if (d->compat_xstats && d->xstats) {
 205                 if (gnet_stats_copy(d, d->compat_xstats, RTA_DATA(d->xstats),
 206                         RTA_PAYLOAD(d->xstats)) < 0)
 207                         return -1;
 208         }
 209
 210         spin_unlock_bh(d->lock);
 211         return 0;
 212 }
 213
 214
 215 EXPORT_SYMBOL(gnet_stats_start_copy);
 216 EXPORT_SYMBOL(gnet_stats_start_copy_compat);
 217 EXPORT_SYMBOL(gnet_stats_copy_basic);
 218 EXPORT_SYMBOL(gnet_stats_copy_rate_est);
 219 EXPORT_SYMBOL(gnet_stats_copy_queue);
 220 EXPORT_SYMBOL(gnet_stats_copy_app);
 221 EXPORT_SYMBOL(gnet_stats_finish_copy);