bundle.h revision 58028
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 * 2650479Speter * $FreeBSD: head/usr.sbin/ppp/bundle.h 58028 2000-03-14 01:46:09Z brian $ 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 */ 3640665Sbrian#define OPT_IDCHECK 0x0001 3740666Sbrian#define OPT_IFACEALIAS 0x0002 3847689Sbrian#define OPT_KEEPSESSION 0x0004 3947689Sbrian#define OPT_LOOPBACK 0x0008 4047689Sbrian#define OPT_PASSWDAUTH 0x0010 4147689Sbrian#define OPT_PROXY 0x0020 4247689Sbrian#define OPT_PROXYALL 0x0040 4347689Sbrian#define OPT_SROUTES 0x0080 4447689Sbrian#define OPT_THROUGHPUT 0x0100 4547689Sbrian#define OPT_UTMP 0x0200 4636285Sbrian 4736285Sbrian#define MAX_ENDDISC_CLASS 5 4836285Sbrian 4936285Sbrian#define Enabled(b, o) ((b)->cfg.opt & (o)) 5036285Sbrian 5149434Sbrian/* AutoAdjust() values */ 5249434Sbrian#define AUTO_UP 1 5349434Sbrian#define AUTO_DOWN 2 5449434Sbrian 5536285Sbrianstruct sockaddr_un; 5636285Sbrianstruct datalink; 5736285Sbrianstruct physical; 5836285Sbrianstruct link; 5936285Sbrianstruct server; 6036285Sbrianstruct prompt; 6140561Sbrianstruct iface; 6236285Sbrian 6336285Sbrianstruct bundle { 6458028Sbrian struct fdescriptor desc; /* really all our datalinks */ 6536285Sbrian int unit; /* The device/interface unit number */ 6636285Sbrian 6736285Sbrian struct { 6836285Sbrian char Name[20]; /* The /dev/XXXX name */ 6958028Sbrian int fd; /* The /dev/XXXX fdescriptor */ 7056413Sbrian unsigned header : 1; /* Family header sent & received ? */ 7136285Sbrian } dev; 7236285Sbrian 7349434Sbrian u_long bandwidth; /* struct tuninfo speed */ 7440561Sbrian struct iface *iface; /* Interface information */ 7540561Sbrian 7636285Sbrian int routing_seq; /* The current routing sequence number */ 7736285Sbrian u_int phase; /* Curent phase */ 7836285Sbrian 7936928Sbrian struct { 8036928Sbrian int all; /* Union of all physical::type's */ 8136928Sbrian int open; /* Union of all open physical::type's */ 8236928Sbrian } phys_type; 8336928Sbrian 8436285Sbrian unsigned CleaningUp : 1; /* Going to exit.... */ 8550059Sbrian unsigned NatEnabled : 1; /* Are we using libalias ? */ 8636285Sbrian 8736285Sbrian struct fsm_parent fsm; /* Our callback functions */ 8836285Sbrian struct datalink *links; /* Our data links */ 8936285Sbrian 9049978Sbrian time_t upat; /* When the link came up */ 9149978Sbrian 9236285Sbrian struct { 9336285Sbrian struct { 9449978Sbrian int timeout; /* NCP Idle timeout value */ 9549978Sbrian int min_timeout; /* Don't idle out before this */ 9649978Sbrian } idle; 9749978Sbrian struct { 9843313Sbrian char name[AUTHLEN]; /* PAP/CHAP system name */ 9943313Sbrian char key[AUTHLEN]; /* PAP/CHAP key */ 10036285Sbrian } auth; 10136285Sbrian unsigned opt; /* Uses OPT_ bits from above */ 10236285Sbrian char label[50]; /* last thing `load'ed */ 10336285Sbrian u_short mtu; /* Interface mtu */ 10436285Sbrian 10538544Sbrian struct { 10643313Sbrian int timeout; /* How long to leave the output queue choked */ 10738544Sbrian } choked; 10836285Sbrian } cfg; 10936285Sbrian 11036285Sbrian struct { 11136285Sbrian struct ipcp ipcp; /* Our IPCP FSM */ 11236285Sbrian struct mp mp; /* Our MP */ 11336285Sbrian } ncp; 11436285Sbrian 11536285Sbrian struct { 11643313Sbrian struct filter in; /* incoming packet filter */ 11743313Sbrian struct filter out; /* outgoing packet filter */ 11843313Sbrian struct filter dial; /* dial-out packet filter */ 11943313Sbrian struct filter alive; /* keep-alive packet filter */ 12036285Sbrian } filter; 12136285Sbrian 12236285Sbrian struct { 12343313Sbrian struct pppTimer timer; /* timeout after cfg.idle_timeout */ 12436285Sbrian time_t done; 12536285Sbrian } idle; 12636285Sbrian 12736285Sbrian struct { 12843313Sbrian int fd; /* write status here */ 12936285Sbrian } notify; 13036285Sbrian 13136285Sbrian struct { 13243313Sbrian struct pppTimer timer; /* choked output queue timer */ 13338544Sbrian } choked; 13443313Sbrian 13543313Sbrian#ifndef NORADIUS 13643313Sbrian struct radius radius; /* Info retrieved from radius server */ 13743313Sbrian#endif 13836285Sbrian}; 13936285Sbrian 14036285Sbrian#define descriptor2bundle(d) \ 14136285Sbrian ((d)->type == BUNDLE_DESCRIPTOR ? (struct bundle *)(d) : NULL) 14236285Sbrian 14353298Sbrianextern struct bundle *bundle_Create(const char *, int, int); 14436285Sbrianextern void bundle_Destroy(struct bundle *); 14536285Sbrianextern const char *bundle_PhaseName(struct bundle *); 14636285Sbrian#define bundle_Phase(b) ((b)->phase) 14736285Sbrianextern void bundle_NewPhase(struct bundle *, u_int); 14838174Sbrianextern void bundle_LinksRemoved(struct bundle *); 14936285Sbrianextern int bundle_LinkIsUp(const struct bundle *); 15036285Sbrianextern int bundle_SetRoute(struct bundle *, int, struct in_addr, 15137927Sbrian struct in_addr, struct in_addr, int, int); 15236285Sbrianextern void bundle_Close(struct bundle *, const char *, int); 15337018Sbrianextern void bundle_Down(struct bundle *, int); 15437955Sbrianextern void bundle_Open(struct bundle *, const char *, int, int); 15536285Sbrianextern void bundle_LinkClosed(struct bundle *, struct datalink *); 15636285Sbrian 15736285Sbrianextern int bundle_ShowLinks(struct cmdargs const *); 15836285Sbrianextern int bundle_ShowStatus(struct cmdargs const *); 15936285Sbrianextern void bundle_StartIdleTimer(struct bundle *); 16049978Sbrianextern void bundle_SetIdleTimer(struct bundle *, int, int); 16136285Sbrianextern void bundle_StopIdleTimer(struct bundle *); 16236285Sbrianextern int bundle_IsDead(struct bundle *); 16336285Sbrianextern struct datalink *bundle2datalink(struct bundle *, const char *); 16436285Sbrian 16558028Sbrianextern void bundle_RegisterDescriptor(struct bundle *, struct fdescriptor *); 16658028Sbrianextern void bundle_UnRegisterDescriptor(struct bundle *, struct fdescriptor *); 16736285Sbrian 16836285Sbrianextern void bundle_SetTtyCommandMode(struct bundle *, struct datalink *); 16936285Sbrian 17036285Sbrianextern int bundle_DatalinkClone(struct bundle *, struct datalink *, 17136285Sbrian const char *); 17236285Sbrianextern void bundle_DatalinkRemove(struct bundle *, struct datalink *); 17336285Sbrianextern void bundle_CleanDatalinks(struct bundle *); 17436285Sbrianextern void bundle_SetLabel(struct bundle *, const char *); 17536285Sbrianextern const char *bundle_GetLabel(struct bundle *); 17636285Sbrianextern void bundle_SendDatalink(struct datalink *, int, struct sockaddr_un *); 17753684Sbrianextern int bundle_LinkSize(void); 17853684Sbrianextern void bundle_ReceiveDatalink(struct bundle *, int); 17936285Sbrianextern int bundle_SetMode(struct bundle *, struct datalink *, int); 18036285Sbrianextern int bundle_RenameDatalink(struct bundle *, struct datalink *, 18136285Sbrian const char *); 18236452Sbrianextern void bundle_setsid(struct bundle *, int); 18336709Sbrianextern void bundle_LockTun(struct bundle *); 18440622Sbrianextern int bundle_HighestState(struct bundle *); 18541654Sbrianextern int bundle_Exception(struct bundle *, int); 18647648Sbrianextern void bundle_AdjustFilters(struct bundle *, struct in_addr *, 18747648Sbrian struct in_addr *); 18849434Sbrianextern void bundle_CalculateBandwidth(struct bundle *); 18949434Sbrianextern void bundle_AutoAdjust(struct bundle *, int, int); 19049434Sbrianextern int bundle_WantAutoloadTimer(struct bundle *); 19156350Sbrianextern void bundle_ChangedPID(struct bundle *); 192