bundle.h revision 116588 
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 116588 2003-06-19 18:55:49Z ume $
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_FILTERDECAP		0x0001
37#define OPT_FORCE_SCRIPTS	0x0002 /* force chat scripts */
38#define OPT_IDCHECK		0x0004
39#define OPT_IFACEALIAS		0x0008
40#ifndef NOINET6
41#define OPT_IPCP		0x0010
42#define OPT_IPV6CP		0x0020
43#endif
44#define OPT_KEEPSESSION		0x0040
45#define OPT_LOOPBACK		0x0080
46#define OPT_PASSWDAUTH		0x0100
47#define OPT_PROXY		0x0200
48#define OPT_PROXYALL		0x0400
49#define OPT_SROUTES		0x0800
50#define OPT_TCPMSSFIXUP		0x1000
51#define OPT_THROUGHPUT		0x2000
52#define OPT_UTMP		0x4000
53
54#define MAX_ENDDISC_CLASS 5
55
56#define Enabled(b, o) ((b)->cfg.opt & (o))
57
58/* AutoAdjust() values */
59#define AUTO_UP		1
60#define AUTO_DOWN	2
61
62struct sockaddr_un;
63struct datalink;
64struct physical;
65struct link;
66struct server;
67struct prompt;
68struct iface;
69
70struct bundle {
71  struct fdescriptor desc;    /* really all our datalinks */
72  int unit;                   /* The device/interface unit number */
73
74  struct {
75    char Name[20];            /* The /dev/XXXX name */
76    int fd;                   /* The /dev/XXXX descriptor */
77    unsigned header : 1;      /* Family header sent & received ? */
78  } dev;
79
80  u_long bandwidth;           /* struct tuninfo speed */
81  struct iface *iface;        /* Interface information */
82
83  int routing_seq;            /* The current routing sequence number */
84  u_int phase;                /* Curent phase */
85
86  struct {
87    int all;                  /* Union of all physical::type's */
88    int open;                 /* Union of all open physical::type's */
89  } phys_type;
90
91  unsigned CleaningUp : 1;    /* Going to exit.... */
92  unsigned NatEnabled : 1;    /* Are we using libalias ? */
93
94  struct fsm_parent fsm;      /* Our callback functions */
95  struct datalink *links;     /* Our data links */
96
97  time_t upat;                /* When the link came up */
98
99  struct {
100    struct {
101      int timeout;              /* NCP Idle timeout value */
102      int min_timeout;          /* Don't idle out before this */
103    } idle;
104    struct {
105      char name[AUTHLEN];     /* PAP/CHAP system name */
106      char key[AUTHLEN];      /* PAP/CHAP key */
107    } auth;
108    unsigned opt;             /* Uses OPT_ bits from above */
109    char label[50];           /* last thing `load'ed */
110    u_short ifqueue;          /* Interface queue size */
111
112    struct {
113      int timeout;            /* How long to leave the output queue choked */
114    } choked;
115  } cfg;
116
117  struct ncp ncp;
118
119  struct {
120    struct filter in;         /* incoming packet filter */
121    struct filter out;        /* outgoing packet filter */
122    struct filter dial;       /* dial-out packet filter */
123    struct filter alive;      /* keep-alive packet filter */
124  } filter;
125
126  struct {
127    struct pppTimer timer;    /* timeout after cfg.idle_timeout */
128    time_t done;
129  } idle;
130
131#ifndef NORADIUS
132  struct {
133    struct pppTimer timer;
134    time_t done;
135  } session;
136#endif
137
138  struct {
139    int fd;                   /* write status here */
140  } notify;
141
142  struct {
143    struct pppTimer timer;    /* choked output queue timer */
144  } choked;
145
146#ifndef NORADIUS
147  struct radius radius;       /* Info retrieved from radius server */
148  struct radacct radacct;
149#ifndef NOINET6
150  struct radacct radacct6;
151#endif
152#endif
153};
154
155#define descriptor2bundle(d) \
156  ((d)->type == BUNDLE_DESCRIPTOR ? (struct bundle *)(d) : NULL)
157
158extern struct bundle *bundle_Create(const char *, int, int);
159extern void bundle_Destroy(struct bundle *);
160extern const char *bundle_PhaseName(struct bundle *);
161#define bundle_Phase(b) ((b)->phase)
162extern void bundle_NewPhase(struct bundle *, u_int);
163extern void bundle_LinksRemoved(struct bundle *);
164extern void bundle_Close(struct bundle *, const char *, int);
165extern void bundle_Down(struct bundle *, int);
166extern void bundle_Open(struct bundle *, const char *, int, int);
167extern void bundle_LinkClosed(struct bundle *, struct datalink *);
168
169extern int bundle_ShowLinks(struct cmdargs const *);
170extern int bundle_ShowStatus(struct cmdargs const *);
171extern void bundle_StartIdleTimer(struct bundle *, unsigned secs);
172extern void bundle_SetIdleTimer(struct bundle *, int, int);
173extern void bundle_StopIdleTimer(struct bundle *);
174extern int bundle_IsDead(struct bundle *);
175extern struct datalink *bundle2datalink(struct bundle *, const char *);
176
177#ifndef NORADIUS
178extern void bundle_StartSessionTimer(struct bundle *, unsigned secs);
179extern void bundle_StopSessionTimer(struct bundle *);
180#endif
181
182extern void bundle_RegisterDescriptor(struct bundle *, struct fdescriptor *);
183extern void bundle_UnRegisterDescriptor(struct bundle *, struct fdescriptor *);
184
185extern void bundle_SetTtyCommandMode(struct bundle *, struct datalink *);
186
187extern int bundle_DatalinkClone(struct bundle *, struct datalink *,
188                                const char *);
189extern void bundle_DatalinkRemove(struct bundle *, struct datalink *);
190extern void bundle_CleanDatalinks(struct bundle *);
191extern void bundle_SetLabel(struct bundle *, const char *);
192extern const char *bundle_GetLabel(struct bundle *);
193extern void bundle_SendDatalink(struct datalink *, int, struct sockaddr_un *);
194extern int bundle_LinkSize(void);
195extern void bundle_ReceiveDatalink(struct bundle *, int);
196extern int bundle_SetMode(struct bundle *, struct datalink *, int);
197extern int bundle_RenameDatalink(struct bundle *, struct datalink *,
198                                 const char *);
199extern void bundle_setsid(struct bundle *, int);
200extern void bundle_LockTun(struct bundle *);
201extern int bundle_HighestState(struct bundle *);
202extern int bundle_Exception(struct bundle *, int);
203extern void bundle_AdjustFilters(struct bundle *, struct ncpaddr *,
204                                 struct ncpaddr *);
205extern void bundle_AdjustDNS(struct bundle *);
206extern void bundle_CalculateBandwidth(struct bundle *);
207extern void bundle_AutoAdjust(struct bundle *, int, int);
208extern int bundle_WantAutoloadTimer(struct bundle *);
209extern void bundle_ChangedPID(struct bundle *);
210extern void bundle_Notify(struct bundle *, char);
211extern int bundle_Uptime(struct bundle *);
212