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