usr.sbin/ppp/link.h

   1 /*-
   2  * Copyright (c) 1998 Brian Somers <brian@Awfulhak.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/usr.sbin/ppp/link.h,v 1.9.2.1 2000/08/19 09:30:04 brian Exp $
  27  * $DragonFly: src/usr.sbin/ppp/link.h,v 1.2 2003/06/17 04:30:00 dillon Exp $
  28  *
  29  */
  30
  31
  32 #define PHYSICAL_LINK   1
  33 #define LOGICAL_LINK    2
  34
  35 #define NPROTOSTAT 13
  36
  37 struct bundle;
  38 struct prompt;
  39 struct cmdargs;
  40
  41 struct link {
  42   int type;                               /* _LINK type */
  43   const char *name;                       /* Points to datalink::name */
  44   int len;                                /* full size of parent struct */
  45   struct {
  46     unsigned gather : 1;                  /* Gather statistics ourself ? */
  47     struct pppThroughput total;           /* Link throughput statistics */
  48     struct pppThroughput *parent;         /* MP link throughput statistics */
  49   } stats;
  50   struct mqueue Queue[2];                 /* Our output queue of mbufs */
  51
  52   u_long proto_in[NPROTOSTAT];            /* outgoing protocol stats */
  53   u_long proto_out[NPROTOSTAT];           /* incoming protocol stats */
  54
  55   struct lcp lcp;                         /* Our line control FSM */
  56   struct ccp ccp;                         /* Our compression FSM */
  57
  58   struct layer const *layer[LAYER_MAX];   /* i/o layers */
  59   int nlayers;
  60 };
  61
  62 #define LINK_QUEUES(link) (sizeof (link)->Queue / sizeof (link)->Queue[0])
  63 #define LINK_HIGHQ(link) ((link)->Queue + LINK_QUEUES(link) - 1)
  64
  65 extern void link_SequenceQueue(struct link *);
  66 extern void link_DeleteQueue(struct link *);
  67 extern size_t link_QueueLen(struct link *);
  68 extern size_t link_QueueBytes(struct link *);
  69 extern struct mbuf *link_Dequeue(struct link *);
  70
  71 extern void link_PushPacket(struct link *, struct mbuf *, struct bundle *,
  72                             int, u_short);
  73 extern void link_PullPacket(struct link *, char *, size_t, struct bundle *);
  74 extern int link_Stack(struct link *, struct layer *);
  75 extern void link_EmptyStack(struct link *);
  76
  77 #define PROTO_IN  1                       /* third arg to link_ProtocolRecord */
  78 #define PROTO_OUT 2
  79 extern void link_ProtocolRecord(struct link *, u_short, int);
  80 extern void link_ReportProtocolStatus(struct link *, struct prompt *);
  81 extern int link_ShowLayers(struct cmdargs const *);