bundle.h revision 38544 
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.12 1998/08/07 18:42:47 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
44#define MAX_ENDDISC_CLASS 5
45
46#define Enabled(b, o) ((b)->cfg.opt & (o))
47
48struct sockaddr_un;
49struct datalink;
50struct physical;
51struct link;
52struct server;
53struct prompt;
54
55struct bundle {
56  struct descriptor desc;     /* really all our datalinks */
57  int unit;                   /* The device/interface unit number */
58  const char **argv;          /* From main() */
59
60  struct {
61    char Name[20];            /* The /dev/XXXX name */
62    int fd;                   /* The /dev/XXXX descriptor */
63  } dev;
64
65  struct {
66    u_long Speed;             /* struct tuninfo speed */
67    int Index;                /* The interface index */
68    char *Name;               /* The interface name */
69  } ifp;
70
71  int routing_seq;            /* The current routing sequence number */
72  u_int phase;                /* Curent phase */
73
74  struct {
75    int all;                  /* Union of all physical::type's */
76    int open;                 /* Union of all open physical::type's */
77  } phys_type;
78
79  unsigned CleaningUp : 1;    /* Going to exit.... */
80  unsigned AliasEnabled : 1;  /* Are we using libalias ? */
81
82  struct fsm_parent fsm;      /* Our callback functions */
83  struct datalink *links;     /* Our data links */
84
85  struct {
86    int idle_timeout;         /* NCP Idle timeout value */
87    struct {
88      char name[50];          /* PAP/CHAP system name */
89      char key[50];           /* PAP/CHAP key */
90    } auth;
91    unsigned opt;             /* Uses OPT_ bits from above */
92    char label[50];           /* last thing `load'ed */
93    u_short mtu;              /* Interface mtu */
94
95    struct {                  /* We need/don't need another link when  */
96      struct {                /* more/less than                        */
97        int packets;          /* this number of packets are queued for */
98        int timeout;          /* this number of seconds                */
99      } max, min;
100    } autoload;
101
102    struct {
103      int timeout;		/* How long to leave the output queue choked */
104    } choked;
105  } cfg;
106
107  struct {
108    struct ipcp ipcp;         /* Our IPCP FSM */
109    struct mp mp;             /* Our MP */
110  } ncp;
111
112  struct {
113    struct filter in;		/* incoming packet filter */
114    struct filter out;		/* outgoing packet filter */
115    struct filter dial;		/* dial-out packet filter */
116    struct filter alive;	/* keep-alive packet filter */
117  } filter;
118
119  struct {
120    struct pppTimer timer;      /* timeout after cfg.idle_timeout */
121    time_t done;
122  } idle;
123
124  struct {
125    int fd;                     /* write status here */
126  } notify;
127
128  struct {
129    struct pppTimer timer;
130    time_t done;
131    unsigned running : 1;
132    unsigned comingup : 1;
133  } autoload;
134
135  struct {
136    struct pppTimer timer;      /* choked output queue timer */
137  } choked;
138};
139
140#define descriptor2bundle(d) \
141  ((d)->type == BUNDLE_DESCRIPTOR ? (struct bundle *)(d) : NULL)
142
143extern struct bundle *bundle_Create(const char *, int, const char **);
144extern void bundle_Destroy(struct bundle *);
145extern const char *bundle_PhaseName(struct bundle *);
146#define bundle_Phase(b) ((b)->phase)
147extern void bundle_NewPhase(struct bundle *, u_int);
148extern void bundle_LinksRemoved(struct bundle *);
149extern int  bundle_LinkIsUp(const struct bundle *);
150extern int bundle_SetRoute(struct bundle *, int, struct in_addr,
151                           struct in_addr, struct in_addr, int, int);
152extern void bundle_Close(struct bundle *, const char *, int);
153extern void bundle_Down(struct bundle *, int);
154extern void bundle_Open(struct bundle *, const char *, int, int);
155extern void bundle_LinkClosed(struct bundle *, struct datalink *);
156
157extern int bundle_FillQueues(struct bundle *);
158extern int bundle_ShowLinks(struct cmdargs const *);
159extern int bundle_ShowStatus(struct cmdargs const *);
160extern void bundle_StartIdleTimer(struct bundle *);
161extern void bundle_SetIdleTimer(struct bundle *, int);
162extern void bundle_StopIdleTimer(struct bundle *);
163extern int bundle_IsDead(struct bundle *);
164extern struct datalink *bundle2datalink(struct bundle *, const char *);
165
166extern void bundle_RegisterDescriptor(struct bundle *, struct descriptor *);
167extern void bundle_UnRegisterDescriptor(struct bundle *, struct descriptor *);
168
169extern void bundle_SetTtyCommandMode(struct bundle *, struct datalink *);
170
171extern int bundle_DatalinkClone(struct bundle *, struct datalink *,
172                                const char *);
173extern void bundle_DatalinkRemove(struct bundle *, struct datalink *);
174extern void bundle_CleanDatalinks(struct bundle *);
175extern void bundle_SetLabel(struct bundle *, const char *);
176extern const char *bundle_GetLabel(struct bundle *);
177extern void bundle_SendDatalink(struct datalink *, int, struct sockaddr_un *);
178extern void bundle_ReceiveDatalink(struct bundle *, int, struct sockaddr_un *);
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 *);
184