bundle.h revision 53684 
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: head/usr.sbin/ppp/bundle.h 53684 1999-11-25 02:47:04Z brian $
27 */
28
29#define	PHASE_DEAD		0	/* Link is dead */
30#define	PHASE_ESTABLISH		1	/* Establishing link */
31#define	PHASE_AUTHENTICATE	2	/* Being authenticated */
32#define	PHASE_NETWORK		3	/* We're alive ! */
33#define	PHASE_TERMINATE		4	/* Terminating link */
34
35/* cfg.opt bit settings */
36#define OPT_IDCHECK	0x0001
37#define OPT_IFACEALIAS	0x0002
38#define OPT_KEEPSESSION	0x0004
39#define OPT_LOOPBACK	0x0008
40#define OPT_PASSWDAUTH	0x0010
41#define OPT_PROXY	0x0020
42#define OPT_PROXYALL	0x0040
43#define OPT_SROUTES	0x0080
44#define OPT_THROUGHPUT	0x0100
45#define OPT_UTMP	0x0200
46
47#define MAX_ENDDISC_CLASS 5
48
49#define Enabled(b, o) ((b)->cfg.opt & (o))
50
51/* AutoAdjust() values */
52#define AUTO_UP		1
53#define AUTO_DOWN	2
54
55struct sockaddr_un;
56struct datalink;
57struct physical;
58struct link;
59struct server;
60struct prompt;
61struct iface;
62
63struct bundle {
64  struct descriptor desc;     /* really all our datalinks */
65  int unit;                   /* The device/interface unit number */
66
67  struct {
68    char Name[20];            /* The /dev/XXXX name */
69    int fd;                   /* The /dev/XXXX descriptor */
70  } dev;
71
72  u_long bandwidth;           /* struct tuninfo speed */
73  struct iface *iface;        /* Interface information */
74
75  int routing_seq;            /* The current routing sequence number */
76  u_int phase;                /* Curent phase */
77
78  struct {
79    int all;                  /* Union of all physical::type's */
80    int open;                 /* Union of all open physical::type's */
81  } phys_type;
82
83  unsigned CleaningUp : 1;    /* Going to exit.... */
84  unsigned NatEnabled : 1;    /* Are we using libalias ? */
85
86  struct fsm_parent fsm;      /* Our callback functions */
87  struct datalink *links;     /* Our data links */
88
89  time_t upat;                /* When the link came up */
90
91  struct {
92    struct {
93      int timeout;              /* NCP Idle timeout value */
94      int min_timeout;          /* Don't idle out before this */
95    } idle;
96    struct {
97      char name[AUTHLEN];     /* PAP/CHAP system name */
98      char key[AUTHLEN];      /* PAP/CHAP key */
99    } auth;
100    unsigned opt;             /* Uses OPT_ bits from above */
101    char label[50];           /* last thing `load'ed */
102    u_short mtu;              /* Interface mtu */
103
104    struct {
105      int timeout;            /* How long to leave the output queue choked */
106    } choked;
107  } cfg;
108
109  struct {
110    struct ipcp ipcp;         /* Our IPCP FSM */
111    struct mp mp;             /* Our MP */
112  } ncp;
113
114  struct {
115    struct filter in;         /* incoming packet filter */
116    struct filter out;        /* outgoing packet filter */
117    struct filter dial;       /* dial-out packet filter */
118    struct filter alive;      /* keep-alive packet filter */
119  } filter;
120
121  struct {
122    struct pppTimer timer;    /* timeout after cfg.idle_timeout */
123    time_t done;
124  } idle;
125
126  struct {
127    int fd;                   /* write status here */
128  } notify;
129
130  struct {
131    struct pppTimer timer;    /* choked output queue timer */
132  } choked;
133
134#ifndef NORADIUS
135  struct radius radius;       /* Info retrieved from radius server */
136#endif
137};
138
139#define descriptor2bundle(d) \
140  ((d)->type == BUNDLE_DESCRIPTOR ? (struct bundle *)(d) : NULL)
141
142extern struct bundle *bundle_Create(const char *, int, int);
143extern void bundle_Destroy(struct bundle *);
144extern const char *bundle_PhaseName(struct bundle *);
145#define bundle_Phase(b) ((b)->phase)
146extern void bundle_NewPhase(struct bundle *, u_int);
147extern void bundle_LinksRemoved(struct bundle *);
148extern int  bundle_LinkIsUp(const struct bundle *);
149extern int bundle_SetRoute(struct bundle *, int, struct in_addr,
150                           struct in_addr, struct in_addr, int, int);
151extern void bundle_Close(struct bundle *, const char *, int);
152extern void bundle_Down(struct bundle *, int);
153extern void bundle_Open(struct bundle *, const char *, int, int);
154extern void bundle_LinkClosed(struct bundle *, struct datalink *);
155
156extern int bundle_FillQueues(struct bundle *);
157extern int bundle_ShowLinks(struct cmdargs const *);
158extern int bundle_ShowStatus(struct cmdargs const *);
159extern void bundle_StartIdleTimer(struct bundle *);
160extern void bundle_SetIdleTimer(struct bundle *, int, int);
161extern void bundle_StopIdleTimer(struct bundle *);
162extern int bundle_IsDead(struct bundle *);
163extern struct datalink *bundle2datalink(struct bundle *, const char *);
164
165extern void bundle_RegisterDescriptor(struct bundle *, struct descriptor *);
166extern void bundle_UnRegisterDescriptor(struct bundle *, struct descriptor *);
167
168extern void bundle_SetTtyCommandMode(struct bundle *, struct datalink *);
169
170extern int bundle_DatalinkClone(struct bundle *, struct datalink *,
171                                const char *);
172extern void bundle_DatalinkRemove(struct bundle *, struct datalink *);
173extern void bundle_CleanDatalinks(struct bundle *);
174extern void bundle_SetLabel(struct bundle *, const char *);
175extern const char *bundle_GetLabel(struct bundle *);
176extern void bundle_SendDatalink(struct datalink *, int, struct sockaddr_un *);
177extern int bundle_LinkSize(void);
178extern void bundle_ReceiveDatalink(struct bundle *, int);
179extern int bundle_SetMode(struct bundle *, struct datalink *, int);
180extern int bundle_RenameDatalink(struct bundle *, struct datalink *,
181                                 const char *);
182extern void bundle_setsid(struct bundle *, int);
183extern void bundle_LockTun(struct bundle *);
184extern int bundle_HighestState(struct bundle *);
185extern int bundle_Exception(struct bundle *, int);
186extern void bundle_AdjustFilters(struct bundle *, struct in_addr *,
187                                 struct in_addr *);
188extern void bundle_CalculateBandwidth(struct bundle *);
189extern void bundle_AutoAdjust(struct bundle *, int, int);
190extern int bundle_WantAutoloadTimer(struct bundle *);
191