xref: /freebsd/usr.sbin/ppp/link.h (revision fcb560670601b2a4d87bb31d7531c8dcc37ee71b)
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$
27  *
28  */
29 
30 
31 #define PHYSICAL_LINK	1
32 #define LOGICAL_LINK	2
33 
34 #define NPROTOSTAT 13
35 
36 struct bundle;
37 struct prompt;
38 struct cmdargs;
39 
40 struct link {
41   int type;                               /* _LINK type */
42   const char *name;                       /* Points to datalink::name */
43   int len;                                /* full size of parent struct */
44   struct {
45     unsigned gather : 1;                  /* Gather statistics ourself ? */
46     struct pppThroughput total;           /* Link throughput statistics */
47     struct pppThroughput *parent;         /* MP link throughput statistics */
48   } stats;
49   struct mqueue Queue[2];                 /* Our output queue of mbufs */
50 
51   u_long proto_in[NPROTOSTAT];            /* outgoing protocol stats */
52   u_long proto_out[NPROTOSTAT];           /* incoming protocol stats */
53 
54   struct lcp lcp;                         /* Our line control FSM */
55   struct ccp ccp;                         /* Our compression FSM */
56 
57   struct layer const *layer[LAYER_MAX];   /* i/o layers */
58   int nlayers;
59 };
60 
61 #define LINK_QUEUES(link) (sizeof (link)->Queue / sizeof (link)->Queue[0])
62 #define LINK_HIGHQ(link) ((link)->Queue + LINK_QUEUES(link) - 1)
63 
64 extern void link_SequenceQueue(struct link *);
65 extern void link_DeleteQueue(struct link *);
66 extern size_t link_QueueLen(struct link *);
67 extern size_t link_QueueBytes(struct link *);
68 extern void link_PendingLowPriorityData(struct link *, size_t *, size_t *);
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 *);
82