xref: /dragonfly/usr.sbin/ppp/mp.h (revision 007d6852)
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/mp.h,v 1.9.2.2 2002/09/01 02:12:29 brian Exp $
27  * $DragonFly: src/usr.sbin/ppp/mp.h,v 1.2 2003/06/17 04:30:00 dillon Exp $
28  */
29 
30 struct mbuf;
31 struct physical;
32 struct bundle;
33 struct cmdargs;
34 struct datalink;
35 
36 #define ENDDISC_NULL	0
37 #define ENDDISC_LOCAL	1
38 #define ENDDISC_IP	2
39 #define ENDDISC_MAC	3
40 #define ENDDISC_MAGIC	4
41 #define ENDDISC_PSN	5
42 
43 #define MP_LINKSENT	0	/* We attached the link to another ppp */
44 #define MP_UP		1	/* We've started MP */
45 #define MP_ADDED	2	/* We've added the link to our MP */
46 #define MP_FAILED	3	/* No go */
47 
48 #define MPSERVER_CONNECTED	0
49 #define MPSERVER_LISTENING	1
50 #define MPSERVER_FAILED		2
51 
52 struct enddisc {
53   u_char class;
54   char address[50];
55   int len;
56 };
57 
58 struct peerid {
59   struct enddisc enddisc;	/* Peers endpoint discriminator */
60   char authname[AUTHLEN];	/* Peers name (authenticated) */
61 };
62 
63 struct mpserver {
64   struct fdescriptor desc;
65   int fd;			/* listen()ing or connect()ing here */
66   struct sockaddr_un socket;	/* On this socket */
67 
68   struct {
69     struct datalink *dl;	/* Send this datalink */
70   } send;			/* (in UpdateSet()) */
71 };
72 
73 struct mp {
74   struct link link;
75 
76   unsigned active : 1;
77   unsigned peer_is12bit : 1;	/* 12/24bit seq nos */
78   unsigned local_is12bit : 1;
79   u_short peer_mrru;
80   u_short local_mrru;
81 
82   struct peerid peer;		/* Who are we talking to */
83   struct mpserver server;	/* Our ``sharing'' socket */
84 
85   struct {
86     u_int32_t seq;		/* next outgoing seq */
87     int link;			/* Next link to send on */
88     int af;			/* Next address family to send */
89   } out;
90 
91   struct {
92     u_int32_t min_in;		/* minimum received incoming seq */
93     u_int32_t next_in;		/* next incoming seq to process */
94   } seq;
95 
96   struct {
97     u_short mrru;		/* Max Reconstructed Receive Unit */
98     unsigned shortseq : 2;	/* I want short Sequence Numbers */
99     unsigned negenddisc : 2;	/* I want an endpoint discriminator */
100     struct enddisc enddisc;	/* endpoint discriminator */
101     struct {
102       int min;			/* Lowest percent of bundle->bandwidth */
103       int max;			/* Highest percent of bundle->bandwidth out */
104       int period;		/* link->throughput sample period */
105     } autoload;
106   } cfg;
107 
108   struct mbuf *inbufs;		/* Received fragments */
109   struct fsm_parent fsmp;	/* Our callback functions */
110   struct bundle *bundle;	/* Parent */
111 };
112 
113 struct mp_link {
114   u_int32_t seq;		/* 12 or 24 bit incoming seq */
115   unsigned bandwidth;		/* Our link bandwidth (or zero) */
116 };
117 
118 struct mp_header {
119   unsigned begin : 1;
120   unsigned end : 1;
121   u_int32_t seq;
122 };
123 
124 #define descriptor2mpserver(d) \
125   ((d)->type == MPSERVER_DESCRIPTOR ? (struct mpserver *)(d) : NULL)
126 #define mpserver_IsOpen(s) ((s)->fd != -1)
127 
128 extern void peerid_Init(struct peerid *);
129 extern int peerid_Equal(const struct peerid *, const struct peerid *);
130 extern void mpserver_Init(struct mpserver *);
131 extern int mpserver_Open(struct mpserver *, struct peerid *);
132 extern void mpserver_Close(struct mpserver *);
133 extern void mp_Init(struct mp *, struct bundle *);
134 extern void mp_linkInit(struct mp_link *);
135 extern int mp_Up(struct mp *, struct datalink *);
136 extern void mp_Down(struct mp *);
137 extern struct mbuf *mp_Input(struct bundle *, struct link *, struct mbuf *);
138 extern int mp_FillPhysicalQueues(struct bundle *);
139 extern int mp_SetDatalinkBandwidth(struct cmdargs const *);
140 extern int mp_ShowStatus(struct cmdargs const *);
141 extern const char *mp_Enddisc(u_char, const char *, size_t);
142 extern int mp_SetEnddisc(struct cmdargs const *);
143 extern void mp_LinkLost(struct mp *, struct datalink *);
144 extern void mp_RestartAutoloadTimer(struct mp *);
145 extern void mp_CheckAutoloadTimer(struct mp *);
146 extern void mp_StopAutoloadTimer(struct mp *);
147 extern size_t mp_QueueLen(struct mp *);
148