usr.sbin/ppp/throughput.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 1997 Brian Somers <brian@Awfulhak.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #define SAMPLE_PERIOD 5         /* Default sample period */
  32
  33 #define THROUGHPUT_OVERALL 0x0001
  34 #define THROUGHPUT_CURRENT 0x0002
  35 #define THROUGHPUT_PEAK    0x0004
  36 #define THROUGHPUT_ALL     0x0007
  37
  38 struct pppThroughput {
  39   time_t uptime, downtime;
  40   unsigned long long OctetsIn;
  41   unsigned long long OctetsOut;
  42   unsigned long long PacketsIn;
  43   unsigned long long PacketsOut;
  44   int SamplePeriod;
  45   struct {
  46     unsigned long long *SampleOctets;
  47     unsigned long long OctetsPerSecond;
  48   } in, out;
  49   unsigned long long BestOctetsPerSecond;
  50   time_t BestOctetsPerSecondTime;
  51   int nSample;
  52   unsigned rolling : 1;
  53   struct pppTimer Timer;
  54   struct {
  55     void *data;
  56     void (*fn)(void *v);
  57   } callback;
  58 };
  59
  60 extern void throughput_init(struct pppThroughput *, int);
  61 extern void throughput_destroy(struct pppThroughput *);
  62 extern void throughput_disp(struct pppThroughput *, struct prompt *);
  63 extern void throughput_log(struct pppThroughput *, int, const char *);
  64 extern void throughput_start(struct pppThroughput *, const char *, int);
  65 extern void throughput_restart(struct pppThroughput *, const char *, int);
  66 extern void throughput_stop(struct pppThroughput *);
  67 extern void throughput_addin(struct pppThroughput *, long long);
  68 extern void throughput_addout(struct pppThroughput *, long long);
  69 extern void throughput_clear(struct pppThroughput *, int, struct prompt *);
  70 extern void throughput_callback(struct pppThroughput *, void (*)(void *),
  71                                 void *);
  72 extern int throughput_uptime(struct pppThroughput *);