bundle.h revision 40622 
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 *	$Id: bundle.h,v 1.14 1998/10/22 02:32:48 brian Exp $
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	0x01
37#define OPT_LOOPBACK	0x02
38#define OPT_PASSWDAUTH	0x04
39#define OPT_PROXY	0x08
40#define OPT_SROUTES	0x10
41#define OPT_THROUGHPUT	0x20
42#define OPT_UTMP	0x40
43#define OPT_IFACEALIAS	0x80
44
45#define MAX_ENDDISC_CLASS 5
46
47#define Enabled(b, o) ((b)->cfg.opt & (o))
48
49struct sockaddr_un;
50struct datalink;
51struct physical;
52struct link;
53struct server;
54struct prompt;
55struct iface;
56
57struct bundle {
58  struct descriptor desc;     /* really all our datalinks */
59  int unit;                   /* The device/interface unit number */
60  const char **argv;          /* From main() */
61
62  struct {
63    char Name[20];            /* The /dev/XXXX name */
64    int fd;                   /* The /dev/XXXX descriptor */
65  } dev;
66
67#if 0
68  struct {
69    int Index;                /* The interface index */
70    char *Name;               /* The interface name */
71  } ifp;
72#endif
73
74  u_long ifSpeed;             /* 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 AliasEnabled : 1;  /* Are we using libalias ? */
87
88  struct fsm_parent fsm;      /* Our callback functions */
89  struct datalink *links;     /* Our data links */
90
91  struct {
92    int idle_timeout;         /* NCP Idle timeout value */
93    struct {
94      char name[50];          /* PAP/CHAP system name */
95      char key[50];           /* PAP/CHAP key */
96    } auth;
97    unsigned opt;             /* Uses OPT_ bits from above */
98    char label[50];           /* last thing `load'ed */
99    u_short mtu;              /* Interface mtu */
100
101    struct {                  /* We need/don't need another link when  */
102      struct {                /* more/less than                        */
103        int packets;          /* this number of packets are queued for */
104        int timeout;          /* this number of seconds                */
105      } max, min;
106    } autoload;
107
108    struct {
109      int timeout;		/* How long to leave the output queue choked */
110    } choked;
111  } cfg;
112
113  struct {
114    struct ipcp ipcp;         /* Our IPCP FSM */
115    struct mp mp;             /* Our MP */
116  } ncp;
117
118  struct {
119    struct filter in;		/* incoming packet filter */
120    struct filter out;		/* outgoing packet filter */
121    struct filter dial;		/* dial-out packet filter */
122    struct filter alive;	/* keep-alive packet filter */
123  } filter;
124
125  struct {
126    struct pppTimer timer;      /* timeout after cfg.idle_timeout */
127    time_t done;
128  } idle;
129
130  struct {
131    int fd;                     /* write status here */
132  } notify;
133
134  struct {
135    struct pppTimer timer;
136    time_t done;
137    unsigned running : 1;
138    unsigned comingup : 1;
139  } autoload;
140
141  struct {
142    struct pppTimer timer;      /* choked output queue timer */
143  } choked;
144};
145
146#define descriptor2bundle(d) \
147  ((d)->type == BUNDLE_DESCRIPTOR ? (struct bundle *)(d) : NULL)
148
149extern struct bundle *bundle_Create(const char *, int, const char **);
150extern void bundle_Destroy(struct bundle *);
151extern const char *bundle_PhaseName(struct bundle *);
152#define bundle_Phase(b) ((b)->phase)
153extern void bundle_NewPhase(struct bundle *, u_int);
154extern void bundle_LinksRemoved(struct bundle *);
155extern int  bundle_LinkIsUp(const struct bundle *);
156extern int bundle_SetRoute(struct bundle *, int, struct in_addr,
157                           struct in_addr, struct in_addr, int, int);
158extern void bundle_Close(struct bundle *, const char *, int);
159extern void bundle_Down(struct bundle *, int);
160extern void bundle_Open(struct bundle *, const char *, int, int);
161extern void bundle_LinkClosed(struct bundle *, struct datalink *);
162
163extern int bundle_FillQueues(struct bundle *);
164extern int bundle_ShowLinks(struct cmdargs const *);
165extern int bundle_ShowStatus(struct cmdargs const *);
166extern void bundle_StartIdleTimer(struct bundle *);
167extern void bundle_SetIdleTimer(struct bundle *, int);
168extern void bundle_StopIdleTimer(struct bundle *);
169extern int bundle_IsDead(struct bundle *);
170extern struct datalink *bundle2datalink(struct bundle *, const char *);
171
172extern void bundle_RegisterDescriptor(struct bundle *, struct descriptor *);
173extern void bundle_UnRegisterDescriptor(struct bundle *, struct descriptor *);
174
175extern void bundle_SetTtyCommandMode(struct bundle *, struct datalink *);
176
177extern int bundle_DatalinkClone(struct bundle *, struct datalink *,
178                                const char *);
179extern void bundle_DatalinkRemove(struct bundle *, struct datalink *);
180extern void bundle_CleanDatalinks(struct bundle *);
181extern void bundle_SetLabel(struct bundle *, const char *);
182extern const char *bundle_GetLabel(struct bundle *);
183extern void bundle_SendDatalink(struct datalink *, int, struct sockaddr_un *);
184extern void bundle_ReceiveDatalink(struct bundle *, int, struct sockaddr_un *);
185extern int bundle_SetMode(struct bundle *, struct datalink *, int);
186extern int bundle_RenameDatalink(struct bundle *, struct datalink *,
187                                 const char *);
188extern void bundle_setsid(struct bundle *, int);
189extern void bundle_LockTun(struct bundle *);
190extern int bundle_HighestState(struct bundle *);
191