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/netlink.h>
  24 #include <net/gen_stats.h>
  25
  26
  27 static inline int
  28 gnet_stats_copy(struct gnet_dump *d, int type, void *buf, int size, int padattr)
  29 {
  30         if (nla_put_64bit(d->skb, type, size, buf, padattr))
  31                 goto nla_put_failure;
  32         return 0;
  33
  34 nla_put_failure:
  35         if (d->lock)
  36                 spin_unlock_bh(d->lock);
  37         kfree(d->xstats);
  38         d->xstats = NULL;
  39         d->xstats_len = 0;
  40         return -1;
  41 }
  42
  43 /**
  44  * gnet_stats_start_copy_compat - start dumping procedure in compatibility mode
  45  * @skb: socket buffer to put statistics TLVs into
  46  * @type: TLV type for top level statistic TLV
  47  * @tc_stats_type: TLV type for backward compatibility struct tc_stats TLV
  48  * @xstats_type: TLV type for backward compatibility xstats TLV
  49  * @lock: statistics lock
  50  * @d: dumping handle
  51  * @padattr: padding attribute
  52  *
  53  * Initializes the dumping handle, grabs the statistic lock and appends
  54  * an empty TLV header to the socket buffer for use a container for all
  55  * other statistic TLVS.
  56  *
  57  * The dumping handle is marked to be in backward compatibility mode telling
  58  * all gnet_stats_copy_XXX() functions to fill a local copy of struct tc_stats.
  59  *
  60  * Returns 0 on success or -1 if the room in the socket buffer was not sufficient.
  61  */
  62 int
  63 gnet_stats_start_copy_compat(struct sk_buff *skb, int type, int tc_stats_type,
  64                              int xstats_type, spinlock_t *lock,
  65                              struct gnet_dump *d, int padattr)
  66         __acquires(lock)
  67 {
  68         memset(d, 0, sizeof(*d));
  69
  70         if (type)
  71                 d->tail = (struct nlattr *)skb_tail_pointer(skb);
  72         d->skb = skb;
  73         d->compat_tc_stats = tc_stats_type;
  74         d->compat_xstats = xstats_type;
  75         d->padattr = padattr;
  76         if (lock) {
  77                 d->lock = lock;
  78                 spin_lock_bh(lock);
  79         }
  80         if (d->tail) {
  81                 int ret = gnet_stats_copy(d, type, NULL, 0, padattr);
  82
  83                 /* The initial attribute added in gnet_stats_copy() may be
  84                  * preceded by a padding attribute, in which case d->tail will
  85                  * end up pointing at the padding instead of the real attribute.
  86                  * Fix this so gnet_stats_finish_copy() adjusts the length of
  87                  * the right attribute.
  88                  */
  89                 if (ret == 0 && d->tail->nla_type == padattr)
  90                         d->tail = (struct nlattr *)((char *)d->tail +
  91                                                     NLA_ALIGN(d->tail->nla_len));
  92                 return ret;
  93         }
  94
  95         return 0;
  96 }
  97 EXPORT_SYMBOL(gnet_stats_start_copy_compat);
  98
  99 /**
 100  * gnet_stats_start_copy - start dumping procedure in compatibility mode
 101  * @skb: socket buffer to put statistics TLVs into
 102  * @type: TLV type for top level statistic TLV
 103  * @lock: statistics lock
 104  * @d: dumping handle
 105  * @padattr: padding attribute
 106  *
 107  * Initializes the dumping handle, grabs the statistic lock and appends
 108  * an empty TLV header to the socket buffer for use a container for all
 109  * other statistic TLVS.
 110  *
 111  * Returns 0 on success or -1 if the room in the socket buffer was not sufficient.
 112  */
 113 int
 114 gnet_stats_start_copy(struct sk_buff *skb, int type, spinlock_t *lock,
 115                       struct gnet_dump *d, int padattr)
 116 {
 117         return gnet_stats_start_copy_compat(skb, type, 0, 0, lock, d, padattr);
 118 }
 119 EXPORT_SYMBOL(gnet_stats_start_copy);
 120
 121 static void
 122 __gnet_stats_copy_basic_cpu(struct gnet_stats_basic_packed *bstats,
 123                             struct gnet_stats_basic_cpu __percpu *cpu)
 124 {
 125         int i;
 126
 127         for_each_possible_cpu(i) {
 128                 struct gnet_stats_basic_cpu *bcpu = per_cpu_ptr(cpu, i);
 129                 unsigned int start;
 130                 u64 bytes;
 131                 u32 packets;
 132
 133                 do {
 134                         start = u64_stats_fetch_begin_irq(&bcpu->syncp);
 135                         bytes = bcpu->bstats.bytes;
 136                         packets = bcpu->bstats.packets;
 137                 } while (u64_stats_fetch_retry_irq(&bcpu->syncp, start));
 138
 139                 bstats->bytes += bytes;
 140                 bstats->packets += packets;
 141         }
 142 }
 143
 144 void
 145 __gnet_stats_copy_basic(const seqcount_t *running,
 146                         struct gnet_stats_basic_packed *bstats,
 147                         struct gnet_stats_basic_cpu __percpu *cpu,
 148                         struct gnet_stats_basic_packed *b)
 149 {
 150         unsigned int seq;
 151
 152         if (cpu) {
 153                 __gnet_stats_copy_basic_cpu(bstats, cpu);
 154                 return;
 155         }
 156         do {
 157                 if (running)
 158                         seq = read_seqcount_begin(running);
 159                 bstats->bytes = b->bytes;
 160                 bstats->packets = b->packets;
 161         } while (running && read_seqcount_retry(running, seq));
 162 }
 163 EXPORT_SYMBOL(__gnet_stats_copy_basic);
 164
 165 static int
 166 ___gnet_stats_copy_basic(const seqcount_t *running,
 167                          struct gnet_dump *d,
 168                          struct gnet_stats_basic_cpu __percpu *cpu,
 169                          struct gnet_stats_basic_packed *b,
 170                          int type)
 171 {
 172         struct gnet_stats_basic_packed bstats = {0};
 173
 174         __gnet_stats_copy_basic(running, &bstats, cpu, b);
 175
 176         if (d->compat_tc_stats && type == TCA_STATS_BASIC) {
 177                 d->tc_stats.bytes = bstats.bytes;
 178                 d->tc_stats.packets = bstats.packets;
 179         }
 180
 181         if (d->tail) {
 182                 struct gnet_stats_basic sb;
 183
 184                 memset(&sb, 0, sizeof(sb));
 185                 sb.bytes = bstats.bytes;
 186                 sb.packets = bstats.packets;
 187                 return gnet_stats_copy(d, type, &sb, sizeof(sb),
 188                                        TCA_STATS_PAD);
 189         }
 190         return 0;
 191 }
 192
 193 /**
 194  * gnet_stats_copy_basic - copy basic statistics into statistic TLV
 195  * @running: seqcount_t pointer
 196  * @d: dumping handle
 197  * @cpu: copy statistic per cpu
 198  * @b: basic statistics
 199  *
 200  * Appends the basic statistics to the top level TLV created by
 201  * gnet_stats_start_copy().
 202  *
 203  * Returns 0 on success or -1 with the statistic lock released
 204  * if the room in the socket buffer was not sufficient.
 205  */
 206 int
 207 gnet_stats_copy_basic(const seqcount_t *running,
 208                       struct gnet_dump *d,
 209                       struct gnet_stats_basic_cpu __percpu *cpu,
 210                       struct gnet_stats_basic_packed *b)
 211 {
 212         return ___gnet_stats_copy_basic(running, d, cpu, b,
 213                                         TCA_STATS_BASIC);
 214 }
 215 EXPORT_SYMBOL(gnet_stats_copy_basic);
 216
 217 /**
 218  * gnet_stats_copy_basic_hw - copy basic hw statistics into statistic TLV
 219  * @running: seqcount_t pointer
 220  * @d: dumping handle
 221  * @cpu: copy statistic per cpu
 222  * @b: basic statistics
 223  *
 224  * Appends the basic statistics to the top level TLV created by
 225  * gnet_stats_start_copy().
 226  *
 227  * Returns 0 on success or -1 with the statistic lock released
 228  * if the room in the socket buffer was not sufficient.
 229  */
 230 int
 231 gnet_stats_copy_basic_hw(const seqcount_t *running,
 232                          struct gnet_dump *d,
 233                          struct gnet_stats_basic_cpu __percpu *cpu,
 234                          struct gnet_stats_basic_packed *b)
 235 {
 236         return ___gnet_stats_copy_basic(running, d, cpu, b,
 237                                         TCA_STATS_BASIC_HW);
 238 }
 239 EXPORT_SYMBOL(gnet_stats_copy_basic_hw);
 240
 241 /**
 242  * gnet_stats_copy_rate_est - copy rate estimator statistics into statistics TLV
 243  * @d: dumping handle
 244  * @rate_est: rate estimator
 245  *
 246  * Appends the rate estimator statistics to the top level TLV created by
 247  * gnet_stats_start_copy().
 248  *
 249  * Returns 0 on success or -1 with the statistic lock released
 250  * if the room in the socket buffer was not sufficient.
 251  */
 252 int
 253 gnet_stats_copy_rate_est(struct gnet_dump *d,
 254                          struct net_rate_estimator __rcu **rate_est)
 255 {
 256         struct gnet_stats_rate_est64 sample;
 257         struct gnet_stats_rate_est est;
 258         int res;
 259
 260         if (!gen_estimator_read(rate_est, &sample))
 261                 return 0;
 262         est.bps = min_t(u64, UINT_MAX, sample.bps);
 263         /* we have some time before reaching 2^32 packets per second */
 264         est.pps = sample.pps;
 265
 266         if (d->compat_tc_stats) {
 267                 d->tc_stats.bps = est.bps;
 268                 d->tc_stats.pps = est.pps;
 269         }
 270
 271         if (d->tail) {
 272                 res = gnet_stats_copy(d, TCA_STATS_RATE_EST, &est, sizeof(est),
 273                                       TCA_STATS_PAD);
 274                 if (res < 0 || est.bps == sample.bps)
 275                         return res;
 276                 /* emit 64bit stats only if needed */
 277                 return gnet_stats_copy(d, TCA_STATS_RATE_EST64, &sample,
 278                                        sizeof(sample), TCA_STATS_PAD);
 279         }
 280
 281         return 0;
 282 }
 283 EXPORT_SYMBOL(gnet_stats_copy_rate_est);
 284
 285 static void
 286 __gnet_stats_copy_queue_cpu(struct gnet_stats_queue *qstats,
 287                             const struct gnet_stats_queue __percpu *q)
 288 {
 289         int i;
 290
 291         for_each_possible_cpu(i) {
 292                 const struct gnet_stats_queue *qcpu = per_cpu_ptr(q, i);
 293
 294                 qstats->backlog += qcpu->backlog;
 295                 qstats->drops += qcpu->drops;
 296                 qstats->requeues += qcpu->requeues;
 297                 qstats->overlimits += qcpu->overlimits;
 298         }
 299 }
 300
 301 void __gnet_stats_copy_queue(struct gnet_stats_queue *qstats,
 302                              const struct gnet_stats_queue __percpu *cpu,
 303                              const struct gnet_stats_queue *q,
 304                              __u32 qlen)
 305 {
 306         if (cpu) {
 307                 __gnet_stats_copy_queue_cpu(qstats, cpu);
 308         } else {
 309                 qstats->backlog = q->backlog;
 310                 qstats->drops = q->drops;
 311                 qstats->requeues = q->requeues;
 312                 qstats->overlimits = q->overlimits;
 313         }
 314
 315         qstats->qlen = qlen;
 316 }
 317 EXPORT_SYMBOL(__gnet_stats_copy_queue);
 318
 319 /**
 320  * gnet_stats_copy_queue - copy queue statistics into statistics TLV
 321  * @d: dumping handle
 322  * @cpu_q: per cpu queue statistics
 323  * @q: queue statistics
 324  * @qlen: queue length statistics
 325  *
 326  * Appends the queue statistics to the top level TLV created by
 327  * gnet_stats_start_copy(). Using per cpu queue statistics if
 328  * they are available.
 329  *
 330  * Returns 0 on success or -1 with the statistic lock released
 331  * if the room in the socket buffer was not sufficient.
 332  */
 333 int
 334 gnet_stats_copy_queue(struct gnet_dump *d,
 335                       struct gnet_stats_queue __percpu *cpu_q,
 336                       struct gnet_stats_queue *q, __u32 qlen)
 337 {
 338         struct gnet_stats_queue qstats = {0};
 339
 340         __gnet_stats_copy_queue(&qstats, cpu_q, q, qlen);
 341
 342         if (d->compat_tc_stats) {
 343                 d->tc_stats.drops = qstats.drops;
 344                 d->tc_stats.qlen = qstats.qlen;
 345                 d->tc_stats.backlog = qstats.backlog;
 346                 d->tc_stats.overlimits = qstats.overlimits;
 347         }
 348
 349         if (d->tail)
 350                 return gnet_stats_copy(d, TCA_STATS_QUEUE,
 351                                        &qstats, sizeof(qstats),
 352                                        TCA_STATS_PAD);
 353
 354         return 0;
 355 }
 356 EXPORT_SYMBOL(gnet_stats_copy_queue);
 357
 358 /**
 359  * gnet_stats_copy_app - copy application specific statistics into statistics TLV
 360  * @d: dumping handle
 361  * @st: application specific statistics data
 362  * @len: length of data
 363  *
 364  * Appends the application specific statistics to the top level TLV created by
 365  * gnet_stats_start_copy() and remembers the data for XSTATS if the dumping
 366  * handle is in backward compatibility mode.
 367  *
 368  * Returns 0 on success or -1 with the statistic lock released
 369  * if the room in the socket buffer was not sufficient.
 370  */
 371 int
 372 gnet_stats_copy_app(struct gnet_dump *d, void *st, int len)
 373 {
 374         if (d->compat_xstats) {
 375                 d->xstats = kmemdup(st, len, GFP_ATOMIC);
 376                 if (!d->xstats)
 377                         goto err_out;
 378                 d->xstats_len = len;
 379         }
 380
 381         if (d->tail)
 382                 return gnet_stats_copy(d, TCA_STATS_APP, st, len,
 383                                        TCA_STATS_PAD);
 384
 385         return 0;
 386
 387 err_out:
 388         if (d->lock)
 389                 spin_unlock_bh(d->lock);
 390         d->xstats_len = 0;
 391         return -1;
 392 }
 393 EXPORT_SYMBOL(gnet_stats_copy_app);
 394
 395 /**
 396  * gnet_stats_finish_copy - finish dumping procedure
 397  * @d: dumping handle
 398  *
 399  * Corrects the length of the top level TLV to include all TLVs added
 400  * by gnet_stats_copy_XXX() calls. Adds the backward compatibility TLVs
 401  * if gnet_stats_start_copy_compat() was used and releases the statistics
 402  * lock.
 403  *
 404  * Returns 0 on success or -1 with the statistic lock released
 405  * if the room in the socket buffer was not sufficient.
 406  */
 407 int
 408 gnet_stats_finish_copy(struct gnet_dump *d)
 409 {
 410         if (d->tail)
 411                 d->tail->nla_len = skb_tail_pointer(d->skb) - (u8 *)d->tail;
 412
 413         if (d->compat_tc_stats)
 414                 if (gnet_stats_copy(d, d->compat_tc_stats, &d->tc_stats,
 415                                     sizeof(d->tc_stats), d->padattr) < 0)
 416                         return -1;
 417
 418         if (d->compat_xstats && d->xstats) {
 419                 if (gnet_stats_copy(d, d->compat_xstats, d->xstats,
 420                                     d->xstats_len, d->padattr) < 0)
 421                         return -1;
 422         }
 423
 424         if (d->lock)
 425                 spin_unlock_bh(d->lock);
 426         kfree(d->xstats);
 427         d->xstats = NULL;
 428         d->xstats_len = 0;
 429         return 0;
 430 }
 431 EXPORT_SYMBOL(gnet_stats_finish_copy);