bundle.h revision 36928
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.6 1998/06/06 20:50:56 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 81 struct fsm_parent fsm; /* Our callback functions */ 82 struct datalink *links; /* Our data links */ 83 84 struct { 85 int idle_timeout; /* NCP Idle timeout value */ 86 struct { 87 char name[50]; /* PAP/CHAP system name */ 88 char key[50]; /* PAP/CHAP key */ 89 } auth; 90 unsigned opt; /* Uses OPT_ bits from above */ 91 char label[50]; /* last thing `load'ed */ 92 u_short mtu; /* Interface mtu */ 93 94 struct { /* We need/don't need another link when */ 95 struct { /* more/less than */ 96 int packets; /* this number of packets are queued for */ 97 int timeout; /* this number of seconds */ 98 } max, min; 99 } autoload; 100 } cfg; 101 102 struct { 103 struct ipcp ipcp; /* Our IPCP FSM */ 104 struct mp mp; /* Our MP */ 105 } ncp; 106 107 struct { 108 struct filter in; /* incoming packet filter */ 109 struct filter out; /* outgoing packet filter */ 110 struct filter dial; /* dial-out packet filter */ 111 struct filter alive; /* keep-alive packet filter */ 112 } filter; 113 114 struct { 115 struct pppTimer timer; /* timeout after cfg.idle_timeout */ 116 time_t done; 117 } idle; 118 119 struct { 120 int fd; /* write status here */ 121 } notify; 122 123 struct { 124 struct pppTimer timer; 125 time_t done; 126 unsigned running : 1; 127 unsigned comingup : 1; 128 } autoload; 129}; 130 131#define descriptor2bundle(d) \ 132 ((d)->type == BUNDLE_DESCRIPTOR ? (struct bundle *)(d) : NULL) 133 134extern struct bundle *bundle_Create(const char *, int, const char **); 135extern void bundle_Destroy(struct bundle *); 136extern const char *bundle_PhaseName(struct bundle *); 137#define bundle_Phase(b) ((b)->phase) 138extern void bundle_NewPhase(struct bundle *, u_int); 139extern int bundle_LinkIsUp(const struct bundle *); 140extern int bundle_SetRoute(struct bundle *, int, struct in_addr, 141 struct in_addr, struct in_addr, int); 142extern void bundle_Close(struct bundle *, const char *, int); 143extern void bundle_Down(struct bundle *); 144extern void bundle_Open(struct bundle *, const char *, int); 145extern void bundle_LinkClosed(struct bundle *, struct datalink *); 146 147extern int bundle_FillQueues(struct bundle *); 148extern int bundle_ShowLinks(struct cmdargs const *); 149extern int bundle_ShowStatus(struct cmdargs const *); 150extern void bundle_StartIdleTimer(struct bundle *); 151extern void bundle_SetIdleTimer(struct bundle *, int); 152extern void bundle_StopIdleTimer(struct bundle *); 153extern int bundle_IsDead(struct bundle *); 154extern struct datalink *bundle2datalink(struct bundle *, const char *); 155 156extern void bundle_RegisterDescriptor(struct bundle *, struct descriptor *); 157extern void bundle_UnRegisterDescriptor(struct bundle *, struct descriptor *); 158 159extern void bundle_SetTtyCommandMode(struct bundle *, struct datalink *); 160 161extern int bundle_DatalinkClone(struct bundle *, struct datalink *, 162 const char *); 163extern void bundle_DatalinkRemove(struct bundle *, struct datalink *); 164extern void bundle_CleanDatalinks(struct bundle *); 165extern void bundle_SetLabel(struct bundle *, const char *); 166extern const char *bundle_GetLabel(struct bundle *); 167extern void bundle_SendDatalink(struct datalink *, int, struct sockaddr_un *); 168extern void bundle_ReceiveDatalink(struct bundle *, int, struct sockaddr_un *); 169extern int bundle_SetMode(struct bundle *, struct datalink *, int); 170extern int bundle_RenameDatalink(struct bundle *, struct datalink *, 171 const char *); 172extern void bundle_setsid(struct bundle *, int); 173extern void bundle_LockTun(struct bundle *); 174