bundle.h revision 36928
136285Sbrian/*- 236285Sbrian * Copyright (c) 1998 Brian Somers <brian@Awfulhak.org> 336285Sbrian * All rights reserved. 436285Sbrian * 536285Sbrian * Redistribution and use in source and binary forms, with or without 636285Sbrian * modification, are permitted provided that the following conditions 736285Sbrian * are met: 836285Sbrian * 1. Redistributions of source code must retain the above copyright 936285Sbrian * notice, this list of conditions and the following disclaimer. 1036285Sbrian * 2. Redistributions in binary form must reproduce the above copyright 1136285Sbrian * notice, this list of conditions and the following disclaimer in the 1236285Sbrian * documentation and/or other materials provided with the distribution. 1336285Sbrian * 1436285Sbrian * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1536285Sbrian * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1636285Sbrian * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1736285Sbrian * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1836285Sbrian * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1936285Sbrian * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2036285Sbrian * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2136285Sbrian * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2236285Sbrian * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2336285Sbrian * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2436285Sbrian * SUCH DAMAGE. 2536285Sbrian * 2636928Sbrian * $Id: bundle.h,v 1.6 1998/06/06 20:50:56 brian Exp $ 2736285Sbrian */ 2836285Sbrian 2936285Sbrian#define PHASE_DEAD 0 /* Link is dead */ 3036285Sbrian#define PHASE_ESTABLISH 1 /* Establishing link */ 3136285Sbrian#define PHASE_AUTHENTICATE 2 /* Being authenticated */ 3236285Sbrian#define PHASE_NETWORK 3 /* We're alive ! */ 3336285Sbrian#define PHASE_TERMINATE 4 /* Terminating link */ 3436285Sbrian 3536285Sbrian/* cfg.opt bit settings */ 3636285Sbrian#define OPT_IDCHECK 0x01 3736285Sbrian#define OPT_LOOPBACK 0x02 3836285Sbrian#define OPT_PASSWDAUTH 0x04 3936285Sbrian#define OPT_PROXY 0x08 4036285Sbrian#define OPT_SROUTES 0x10 4136285Sbrian#define OPT_THROUGHPUT 0x20 4236285Sbrian#define OPT_UTMP 0x40 4336285Sbrian 4436285Sbrian#define MAX_ENDDISC_CLASS 5 4536285Sbrian 4636285Sbrian#define Enabled(b, o) ((b)->cfg.opt & (o)) 4736285Sbrian 4836285Sbrianstruct sockaddr_un; 4936285Sbrianstruct datalink; 5036285Sbrianstruct physical; 5136285Sbrianstruct link; 5236285Sbrianstruct server; 5336285Sbrianstruct prompt; 5436285Sbrian 5536285Sbrianstruct bundle { 5636285Sbrian struct descriptor desc; /* really all our datalinks */ 5736285Sbrian int unit; /* The device/interface unit number */ 5836467Sbrian const char **argv; /* From main() */ 5936285Sbrian 6036285Sbrian struct { 6136285Sbrian char Name[20]; /* The /dev/XXXX name */ 6236285Sbrian int fd; /* The /dev/XXXX descriptor */ 6336285Sbrian } dev; 6436285Sbrian 6536285Sbrian struct { 6636285Sbrian u_long Speed; /* struct tuninfo speed */ 6736285Sbrian int Index; /* The interface index */ 6836285Sbrian char *Name; /* The interface name */ 6936285Sbrian } ifp; 7036285Sbrian 7136285Sbrian int routing_seq; /* The current routing sequence number */ 7236285Sbrian u_int phase; /* Curent phase */ 7336285Sbrian 7436928Sbrian struct { 7536928Sbrian int all; /* Union of all physical::type's */ 7636928Sbrian int open; /* Union of all open physical::type's */ 7736928Sbrian } phys_type; 7836928Sbrian 7936285Sbrian unsigned CleaningUp : 1; /* Going to exit.... */ 8036285Sbrian 8136285Sbrian struct fsm_parent fsm; /* Our callback functions */ 8236285Sbrian struct datalink *links; /* Our data links */ 8336285Sbrian 8436285Sbrian struct { 8536285Sbrian int idle_timeout; /* NCP Idle timeout value */ 8636285Sbrian struct { 8736285Sbrian char name[50]; /* PAP/CHAP system name */ 8836285Sbrian char key[50]; /* PAP/CHAP key */ 8936285Sbrian } auth; 9036285Sbrian unsigned opt; /* Uses OPT_ bits from above */ 9136285Sbrian char label[50]; /* last thing `load'ed */ 9236285Sbrian u_short mtu; /* Interface mtu */ 9336285Sbrian 9436285Sbrian struct { /* We need/don't need another link when */ 9536285Sbrian struct { /* more/less than */ 9636285Sbrian int packets; /* this number of packets are queued for */ 9736285Sbrian int timeout; /* this number of seconds */ 9836285Sbrian } max, min; 9936285Sbrian } autoload; 10036285Sbrian } cfg; 10136285Sbrian 10236285Sbrian struct { 10336285Sbrian struct ipcp ipcp; /* Our IPCP FSM */ 10436285Sbrian struct mp mp; /* Our MP */ 10536285Sbrian } ncp; 10636285Sbrian 10736285Sbrian struct { 10836285Sbrian struct filter in; /* incoming packet filter */ 10936285Sbrian struct filter out; /* outgoing packet filter */ 11036285Sbrian struct filter dial; /* dial-out packet filter */ 11136285Sbrian struct filter alive; /* keep-alive packet filter */ 11236285Sbrian } filter; 11336285Sbrian 11436285Sbrian struct { 11536285Sbrian struct pppTimer timer; /* timeout after cfg.idle_timeout */ 11636285Sbrian time_t done; 11736285Sbrian } idle; 11836285Sbrian 11936285Sbrian struct { 12036285Sbrian int fd; /* write status here */ 12136285Sbrian } notify; 12236285Sbrian 12336285Sbrian struct { 12436285Sbrian struct pppTimer timer; 12536285Sbrian time_t done; 12636285Sbrian unsigned running : 1; 12736285Sbrian unsigned comingup : 1; 12836285Sbrian } autoload; 12936285Sbrian}; 13036285Sbrian 13136285Sbrian#define descriptor2bundle(d) \ 13236285Sbrian ((d)->type == BUNDLE_DESCRIPTOR ? (struct bundle *)(d) : NULL) 13336285Sbrian 13436467Sbrianextern struct bundle *bundle_Create(const char *, int, const char **); 13536285Sbrianextern void bundle_Destroy(struct bundle *); 13636285Sbrianextern const char *bundle_PhaseName(struct bundle *); 13736285Sbrian#define bundle_Phase(b) ((b)->phase) 13836285Sbrianextern void bundle_NewPhase(struct bundle *, u_int); 13936285Sbrianextern int bundle_LinkIsUp(const struct bundle *); 14036285Sbrianextern int bundle_SetRoute(struct bundle *, int, struct in_addr, 14136285Sbrian struct in_addr, struct in_addr, int); 14236285Sbrianextern void bundle_Close(struct bundle *, const char *, int); 14336285Sbrianextern void bundle_Down(struct bundle *); 14436285Sbrianextern void bundle_Open(struct bundle *, const char *, int); 14536285Sbrianextern void bundle_LinkClosed(struct bundle *, struct datalink *); 14636285Sbrian 14736285Sbrianextern int bundle_FillQueues(struct bundle *); 14836285Sbrianextern int bundle_ShowLinks(struct cmdargs const *); 14936285Sbrianextern int bundle_ShowStatus(struct cmdargs const *); 15036285Sbrianextern void bundle_StartIdleTimer(struct bundle *); 15136285Sbrianextern void bundle_SetIdleTimer(struct bundle *, int); 15236285Sbrianextern void bundle_StopIdleTimer(struct bundle *); 15336285Sbrianextern int bundle_IsDead(struct bundle *); 15436285Sbrianextern struct datalink *bundle2datalink(struct bundle *, const char *); 15536285Sbrian 15636285Sbrianextern void bundle_RegisterDescriptor(struct bundle *, struct descriptor *); 15736285Sbrianextern void bundle_UnRegisterDescriptor(struct bundle *, struct descriptor *); 15836285Sbrian 15936285Sbrianextern void bundle_SetTtyCommandMode(struct bundle *, struct datalink *); 16036285Sbrian 16136285Sbrianextern int bundle_DatalinkClone(struct bundle *, struct datalink *, 16236285Sbrian const char *); 16336285Sbrianextern void bundle_DatalinkRemove(struct bundle *, struct datalink *); 16436285Sbrianextern void bundle_CleanDatalinks(struct bundle *); 16536285Sbrianextern void bundle_SetLabel(struct bundle *, const char *); 16636285Sbrianextern const char *bundle_GetLabel(struct bundle *); 16736285Sbrianextern void bundle_SendDatalink(struct datalink *, int, struct sockaddr_un *); 16836285Sbrianextern void bundle_ReceiveDatalink(struct bundle *, int, struct sockaddr_un *); 16936285Sbrianextern int bundle_SetMode(struct bundle *, struct datalink *, int); 17036285Sbrianextern int bundle_RenameDatalink(struct bundle *, struct datalink *, 17136285Sbrian const char *); 17236452Sbrianextern void bundle_setsid(struct bundle *, int); 17336709Sbrianextern void bundle_LockTun(struct bundle *); 174