bundle.h revision 40666
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.16 1998/10/26 19:07:38 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 0x0001 37#define OPT_IFACEALIAS 0x0002 38#define OPT_LOOPBACK 0x0004 39#define OPT_PASSWDAUTH 0x0008 40#define OPT_PROXY 0x0010 41#define OPT_PROXYALL 0x0020 42#define OPT_SROUTES 0x0040 43#define OPT_THROUGHPUT 0x0080 44#define OPT_UTMP 0x0100 45 46#define MAX_ENDDISC_CLASS 5 47 48#define Enabled(b, o) ((b)->cfg.opt & (o)) 49 50struct sockaddr_un; 51struct datalink; 52struct physical; 53struct link; 54struct server; 55struct prompt; 56struct iface; 57 58struct bundle { 59 struct descriptor desc; /* really all our datalinks */ 60 int unit; /* The device/interface unit number */ 61 const char **argv; /* From main() */ 62 63 struct { 64 char Name[20]; /* The /dev/XXXX name */ 65 int fd; /* The /dev/XXXX descriptor */ 66 } dev; 67 68#if 0 69 struct { 70 int Index; /* The interface index */ 71 char *Name; /* The interface name */ 72 } ifp; 73#endif 74 75 u_long ifSpeed; /* struct tuninfo speed */ 76 struct iface *iface; /* Interface information */ 77 78 int routing_seq; /* The current routing sequence number */ 79 u_int phase; /* Curent phase */ 80 81 struct { 82 int all; /* Union of all physical::type's */ 83 int open; /* Union of all open physical::type's */ 84 } phys_type; 85 86 unsigned CleaningUp : 1; /* Going to exit.... */ 87 unsigned AliasEnabled : 1; /* Are we using libalias ? */ 88 89 struct fsm_parent fsm; /* Our callback functions */ 90 struct datalink *links; /* Our data links */ 91 92 struct { 93 int idle_timeout; /* NCP Idle timeout value */ 94 struct { 95 char name[50]; /* PAP/CHAP system name */ 96 char key[50]; /* PAP/CHAP key */ 97 } auth; 98 unsigned opt; /* Uses OPT_ bits from above */ 99 char label[50]; /* last thing `load'ed */ 100 u_short mtu; /* Interface mtu */ 101 102 struct { /* We need/don't need another link when */ 103 struct { /* more/less than */ 104 int packets; /* this number of packets are queued for */ 105 int timeout; /* this number of seconds */ 106 } max, min; 107 } autoload; 108 109 struct { 110 int timeout; /* How long to leave the output queue choked */ 111 } choked; 112 } cfg; 113 114 struct { 115 struct ipcp ipcp; /* Our IPCP FSM */ 116 struct mp mp; /* Our MP */ 117 } 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 struct { 132 int fd; /* write status here */ 133 } notify; 134 135 struct { 136 struct pppTimer timer; 137 time_t done; 138 unsigned running : 1; 139 unsigned comingup : 1; 140 } autoload; 141 142 struct { 143 struct pppTimer timer; /* choked output queue timer */ 144 } choked; 145}; 146 147#define descriptor2bundle(d) \ 148 ((d)->type == BUNDLE_DESCRIPTOR ? (struct bundle *)(d) : NULL) 149 150extern struct bundle *bundle_Create(const char *, int, const char **); 151extern void bundle_Destroy(struct bundle *); 152extern const char *bundle_PhaseName(struct bundle *); 153#define bundle_Phase(b) ((b)->phase) 154extern void bundle_NewPhase(struct bundle *, u_int); 155extern void bundle_LinksRemoved(struct bundle *); 156extern int bundle_LinkIsUp(const struct bundle *); 157extern int bundle_SetRoute(struct bundle *, int, struct in_addr, 158 struct in_addr, struct in_addr, int, int); 159extern void bundle_Close(struct bundle *, const char *, int); 160extern void bundle_Down(struct bundle *, int); 161extern void bundle_Open(struct bundle *, const char *, int, int); 162extern void bundle_LinkClosed(struct bundle *, struct datalink *); 163 164extern int bundle_FillQueues(struct bundle *); 165extern int bundle_ShowLinks(struct cmdargs const *); 166extern int bundle_ShowStatus(struct cmdargs const *); 167extern void bundle_StartIdleTimer(struct bundle *); 168extern void bundle_SetIdleTimer(struct bundle *, int); 169extern void bundle_StopIdleTimer(struct bundle *); 170extern int bundle_IsDead(struct bundle *); 171extern struct datalink *bundle2datalink(struct bundle *, const char *); 172 173extern void bundle_RegisterDescriptor(struct bundle *, struct descriptor *); 174extern void bundle_UnRegisterDescriptor(struct bundle *, struct descriptor *); 175 176extern void bundle_SetTtyCommandMode(struct bundle *, struct datalink *); 177 178extern int bundle_DatalinkClone(struct bundle *, struct datalink *, 179 const char *); 180extern void bundle_DatalinkRemove(struct bundle *, struct datalink *); 181extern void bundle_CleanDatalinks(struct bundle *); 182extern void bundle_SetLabel(struct bundle *, const char *); 183extern const char *bundle_GetLabel(struct bundle *); 184extern void bundle_SendDatalink(struct datalink *, int, struct sockaddr_un *); 185extern void bundle_ReceiveDatalink(struct bundle *, int, struct sockaddr_un *); 186extern int bundle_SetMode(struct bundle *, struct datalink *, int); 187extern int bundle_RenameDatalink(struct bundle *, struct datalink *, 188 const char *); 189extern void bundle_setsid(struct bundle *, int); 190extern void bundle_LockTun(struct bundle *); 191extern int bundle_HighestState(struct bundle *); 192