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         __acquires(lock)
  59 {
  60         memset(d, 0, sizeof(*d));
  61
  62         spin_lock_bh(lock);
  63         d->lock = lock;
  64         if (type)
  65                 d->tail = (struct rtattr *)skb_tail_pointer(skb);
  66         d->skb = skb;
  67         d->compat_tc_stats = tc_stats_type;
  68         d->compat_xstats = xstats_type;
  69
  70         if (d->tail)
  71                 return gnet_stats_copy(d, type, NULL, 0);
  72
  73         return 0;
  74 }
  75
  76 /**
  77  * gnet_stats_start_copy_compat - start dumping procedure in compatibility mode
  78  * @skb: socket buffer to put statistics TLVs into
  79  * @type: TLV type for top level statistic TLV
  80  * @lock: statistics lock
  81  * @d: dumping handle
  82  *
  83  * Initializes the dumping handle, grabs the statistic lock and appends
  84  * an empty TLV header to the socket buffer for use a container for all
  85  * other statistic TLVS.
  86  *
  87  * Returns 0 on success or -1 if the room in the socket buffer was not sufficient.
  88  */
  89 int
  90 gnet_stats_start_copy(struct sk_buff *skb, int type, spinlock_t *lock,
  91         struct gnet_dump *d)
  92 {
  93         return gnet_stats_start_copy_compat(skb, type, 0, 0, lock, d);
  94 }
  95
  96 /**
  97  * gnet_stats_copy_basic - copy basic statistics into statistic TLV
  98  * @d: dumping handle
  99  * @b: basic statistics
 100  *
 101  * Appends the basic statistics to the top level TLV created by
 102  * gnet_stats_start_copy().
 103  *
 104  * Returns 0 on success or -1 with the statistic lock released
 105  * if the room in the socket buffer was not sufficient.
 106  */
 107 int
 108 gnet_stats_copy_basic(struct gnet_dump *d, struct gnet_stats_basic *b)
 109 {
 110         if (d->compat_tc_stats) {
 111                 d->tc_stats.bytes = b->bytes;
 112                 d->tc_stats.packets = b->packets;
 113         }
 114
 115         if (d->tail)
 116                 return gnet_stats_copy(d, TCA_STATS_BASIC, b, sizeof(*b));
 117
 118         return 0;
 119 }
 120
 121 /**
 122  * gnet_stats_copy_rate_est - copy rate estimator statistics into statistics TLV
 123  * @d: dumping handle
 124  * @r: rate estimator statistics
 125  *
 126  * Appends the rate estimator statistics to the top level TLV created by
 127  * gnet_stats_start_copy().
 128  *
 129  * Returns 0 on success or -1 with the statistic lock released
 130  * if the room in the socket buffer was not sufficient.
 131  */
 132 int
 133 gnet_stats_copy_rate_est(struct gnet_dump *d, struct gnet_stats_rate_est *r)
 134 {
 135         if (d->compat_tc_stats) {
 136                 d->tc_stats.bps = r->bps;
 137                 d->tc_stats.pps = r->pps;
 138         }
 139
 140         if (d->tail)
 141                 return gnet_stats_copy(d, TCA_STATS_RATE_EST, r, sizeof(*r));
 142
 143         return 0;
 144 }
 145
 146 /**
 147  * gnet_stats_copy_queue - copy queue statistics into statistics TLV
 148  * @d: dumping handle
 149  * @q: queue statistics
 150  *
 151  * Appends the queue statistics to the top level TLV created by
 152  * gnet_stats_start_copy().
 153  *
 154  * Returns 0 on success or -1 with the statistic lock released
 155  * if the room in the socket buffer was not sufficient.
 156  */
 157 int
 158 gnet_stats_copy_queue(struct gnet_dump *d, struct gnet_stats_queue *q)
 159 {
 160         if (d->compat_tc_stats) {
 161                 d->tc_stats.drops = q->drops;
 162                 d->tc_stats.qlen = q->qlen;
 163                 d->tc_stats.backlog = q->backlog;
 164                 d->tc_stats.overlimits = q->overlimits;
 165         }
 166
 167         if (d->tail)
 168                 return gnet_stats_copy(d, TCA_STATS_QUEUE, q, sizeof(*q));
 169
 170         return 0;
 171 }
 172
 173 /**
 174  * gnet_stats_copy_app - copy application specific statistics into statistics TLV
 175  * @d: dumping handle
 176  * @st: application specific statistics data
 177  * @len: length of data
 178  *
 179  * Appends the application sepecific statistics to the top level TLV created by
 180  * gnet_stats_start_copy() and remembers the data for XSTATS if the dumping
 181  * handle is in backward compatibility mode.
 182  *
 183  * Returns 0 on success or -1 with the statistic lock released
 184  * if the room in the socket buffer was not sufficient.
 185  */
 186 int
 187 gnet_stats_copy_app(struct gnet_dump *d, void *st, int len)
 188 {
 189         if (d->compat_xstats) {
 190                 d->xstats = st;
 191                 d->xstats_len = len;
 192         }
 193
 194         if (d->tail)
 195                 return gnet_stats_copy(d, TCA_STATS_APP, st, len);
 196
 197         return 0;
 198 }
 199
 200 /**
 201  * gnet_stats_finish_copy - finish dumping procedure
 202  * @d: dumping handle
 203  *
 204  * Corrects the length of the top level TLV to include all TLVs added
 205  * by gnet_stats_copy_XXX() calls. Adds the backward compatibility TLVs
 206  * if gnet_stats_start_copy_compat() was used and releases the statistics
 207  * lock.
 208  *
 209  * Returns 0 on success or -1 with the statistic lock released
 210  * if the room in the socket buffer was not sufficient.
 211  */
 212 int
 213 gnet_stats_finish_copy(struct gnet_dump *d)
 214 {
 215         if (d->tail)
 216                 d->tail->rta_len = skb_tail_pointer(d->skb) - (u8 *)d->tail;
 217
 218         if (d->compat_tc_stats)
 219                 if (gnet_stats_copy(d, d->compat_tc_stats, &d->tc_stats,
 220                         sizeof(d->tc_stats)) < 0)
 221                         return -1;
 222
 223         if (d->compat_xstats && d->xstats) {
 224                 if (gnet_stats_copy(d, d->compat_xstats, d->xstats,
 225                         d->xstats_len) < 0)
 226                         return -1;
 227         }
 228
 229         spin_unlock_bh(d->lock);
 230         return 0;
 231 }
 232
 233
 234 EXPORT_SYMBOL(gnet_stats_start_copy);
 235 EXPORT_SYMBOL(gnet_stats_start_copy_compat);
 236 EXPORT_SYMBOL(gnet_stats_copy_basic);
 237 EXPORT_SYMBOL(gnet_stats_copy_rate_est);
 238 EXPORT_SYMBOL(gnet_stats_copy_queue);
 239 EXPORT_SYMBOL(gnet_stats_copy_app);
 240 EXPORT_SYMBOL(gnet_stats_finish_copy);