usr.sbin/ppp/link.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 1998 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
  32
  33 #define PHYSICAL_LINK   1
  34 #define LOGICAL_LINK    2
  35
  36 #define NPROTOSTAT 13
  37
  38 struct bundle;
  39 struct prompt;
  40 struct cmdargs;
  41
  42 struct link {
  43   int type;                               /* _LINK type */
  44   const char *name;                       /* Points to datalink::name */
  45   int len;                                /* full size of parent struct */
  46   struct {
  47     unsigned gather : 1;                  /* Gather statistics ourself ? */
  48     struct pppThroughput total;           /* Link throughput statistics */
  49     struct pppThroughput *parent;         /* MP link throughput statistics */
  50   } stats;
  51   struct mqueue Queue[2];                 /* Our output queue of mbufs */
  52
  53   u_long proto_in[NPROTOSTAT];            /* outgoing protocol stats */
  54   u_long proto_out[NPROTOSTAT];           /* incoming protocol stats */
  55
  56   struct lcp lcp;                         /* Our line control FSM */
  57   struct ccp ccp;                         /* Our compression FSM */
  58
  59   struct layer const *layer[LAYER_MAX];   /* i/o layers */
  60   int nlayers;
  61 };
  62
  63 #define LINK_QUEUES(link) (sizeof (link)->Queue / sizeof (link)->Queue[0])
  64 #define LINK_HIGHQ(link) ((link)->Queue + LINK_QUEUES(link) - 1)
  65
  66 extern void link_SequenceQueue(struct link *);
  67 extern void link_DeleteQueue(struct link *);
  68 extern size_t link_QueueLen(struct link *);
  69 extern size_t link_QueueBytes(struct link *);
  70 extern void link_PendingLowPriorityData(struct link *, size_t *, size_t *);
  71 extern struct mbuf *link_Dequeue(struct link *);
  72
  73 extern void link_PushPacket(struct link *, struct mbuf *, struct bundle *,
  74                             int, u_short);
  75 extern void link_PullPacket(struct link *, char *, size_t, struct bundle *);
  76 extern int link_Stack(struct link *, struct layer *);
  77 extern void link_EmptyStack(struct link *);
  78
  79 #define PROTO_IN  1                       /* third arg to link_ProtocolRecord */
  80 #define PROTO_OUT 2
  81 extern void link_ProtocolRecord(struct link *, u_short, int);
  82 extern void link_ReportProtocolStatus(struct link *, struct prompt *);
  83 extern int link_ShowLayers(struct cmdargs const *);