bundle.h revision 85991
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 85991 2001-11-03 21:45:32Z 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 */ 3662778Sbrian#define OPT_FILTERDECAP 0x0001 3762778Sbrian#define OPT_IDCHECK 0x0002 3862778Sbrian#define OPT_IFACEALIAS 0x0004 3981634Sbrian#ifndef NOINET6 4081634Sbrian#define OPT_IPCP 0x0008 4181634Sbrian#define OPT_IPV6CP 0x0010 4281634Sbrian#endif 4381634Sbrian#define OPT_KEEPSESSION 0x0020 4481634Sbrian#define OPT_LOOPBACK 0x0040 4581634Sbrian#define OPT_PASSWDAUTH 0x0080 4681634Sbrian#define OPT_PROXY 0x0100 4781634Sbrian#define OPT_PROXYALL 0x0200 4881634Sbrian#define OPT_SROUTES 0x0400 4981634Sbrian#define OPT_TCPMSSFIXUP 0x0800 5081634Sbrian#define OPT_THROUGHPUT 0x1000 5181634Sbrian#define OPT_UTMP 0x2000 5236285Sbrian 5336285Sbrian#define MAX_ENDDISC_CLASS 5 5436285Sbrian 5536285Sbrian#define Enabled(b, o) ((b)->cfg.opt & (o)) 5636285Sbrian 5749434Sbrian/* AutoAdjust() values */ 5849434Sbrian#define AUTO_UP 1 5949434Sbrian#define AUTO_DOWN 2 6049434Sbrian 6136285Sbrianstruct sockaddr_un; 6236285Sbrianstruct datalink; 6336285Sbrianstruct physical; 6436285Sbrianstruct link; 6536285Sbrianstruct server; 6636285Sbrianstruct prompt; 6740561Sbrianstruct iface; 6836285Sbrian 6936285Sbrianstruct bundle { 7058040Sbrian struct fdescriptor desc; /* really all our datalinks */ 7136285Sbrian int unit; /* The device/interface unit number */ 7236285Sbrian 7336285Sbrian struct { 7436285Sbrian char Name[20]; /* The /dev/XXXX name */ 7558038Sbrian int fd; /* The /dev/XXXX descriptor */ 7656413Sbrian unsigned header : 1; /* Family header sent & received ? */ 7736285Sbrian } dev; 7836285Sbrian 7949434Sbrian u_long bandwidth; /* struct tuninfo speed */ 8040561Sbrian struct iface *iface; /* Interface information */ 8140561Sbrian 8236285Sbrian int routing_seq; /* The current routing sequence number */ 8336285Sbrian u_int phase; /* Curent phase */ 8436285Sbrian 8536928Sbrian struct { 8636928Sbrian int all; /* Union of all physical::type's */ 8736928Sbrian int open; /* Union of all open physical::type's */ 8836928Sbrian } phys_type; 8936928Sbrian 9036285Sbrian unsigned CleaningUp : 1; /* Going to exit.... */ 9150059Sbrian unsigned NatEnabled : 1; /* Are we using libalias ? */ 9236285Sbrian 9336285Sbrian struct fsm_parent fsm; /* Our callback functions */ 9436285Sbrian struct datalink *links; /* Our data links */ 9536285Sbrian 9649978Sbrian time_t upat; /* When the link came up */ 9749978Sbrian 9836285Sbrian struct { 9936285Sbrian struct { 10049978Sbrian int timeout; /* NCP Idle timeout value */ 10149978Sbrian int min_timeout; /* Don't idle out before this */ 10249978Sbrian } idle; 10349978Sbrian struct { 10443313Sbrian char name[AUTHLEN]; /* PAP/CHAP system name */ 10543313Sbrian char key[AUTHLEN]; /* PAP/CHAP key */ 10636285Sbrian } auth; 10736285Sbrian unsigned opt; /* Uses OPT_ bits from above */ 10836285Sbrian char label[50]; /* last thing `load'ed */ 10961534Sbrian u_short ifqueue; /* Interface queue size */ 11036285Sbrian 11138544Sbrian struct { 11243313Sbrian int timeout; /* How long to leave the output queue choked */ 11338544Sbrian } choked; 11436285Sbrian } cfg; 11536285Sbrian 11681634Sbrian struct ncp ncp; 11736285Sbrian 11836285Sbrian struct { 11943313Sbrian struct filter in; /* incoming packet filter */ 12043313Sbrian struct filter out; /* outgoing packet filter */ 12143313Sbrian struct filter dial; /* dial-out packet filter */ 12243313Sbrian struct filter alive; /* keep-alive packet filter */ 12336285Sbrian } filter; 12436285Sbrian 12536285Sbrian struct { 12643313Sbrian struct pppTimer timer; /* timeout after cfg.idle_timeout */ 12736285Sbrian time_t done; 12836285Sbrian } idle; 12936285Sbrian 13036285Sbrian struct { 13143313Sbrian int fd; /* write status here */ 13236285Sbrian } notify; 13336285Sbrian 13436285Sbrian struct { 13543313Sbrian struct pppTimer timer; /* choked output queue timer */ 13638544Sbrian } choked; 13743313Sbrian 13843313Sbrian#ifndef NORADIUS 13943313Sbrian struct radius radius; /* Info retrieved from radius server */ 14065178Sbrian struct radacct radacct; 14143313Sbrian#endif 14236285Sbrian}; 14336285Sbrian 14436285Sbrian#define descriptor2bundle(d) \ 14536285Sbrian ((d)->type == BUNDLE_DESCRIPTOR ? (struct bundle *)(d) : NULL) 14636285Sbrian 14753298Sbrianextern struct bundle *bundle_Create(const char *, int, int); 14836285Sbrianextern void bundle_Destroy(struct bundle *); 14936285Sbrianextern const char *bundle_PhaseName(struct bundle *); 15036285Sbrian#define bundle_Phase(b) ((b)->phase) 15136285Sbrianextern void bundle_NewPhase(struct bundle *, u_int); 15238174Sbrianextern void bundle_LinksRemoved(struct bundle *); 15336285Sbrianextern void bundle_Close(struct bundle *, const char *, int); 15437018Sbrianextern void bundle_Down(struct bundle *, int); 15537955Sbrianextern void bundle_Open(struct bundle *, const char *, int, int); 15636285Sbrianextern void bundle_LinkClosed(struct bundle *, struct datalink *); 15736285Sbrian 15836285Sbrianextern int bundle_ShowLinks(struct cmdargs const *); 15936285Sbrianextern int bundle_ShowStatus(struct cmdargs const *); 16062977Sbrianextern void bundle_StartIdleTimer(struct bundle *, unsigned secs); 16149978Sbrianextern void bundle_SetIdleTimer(struct bundle *, int, int); 16236285Sbrianextern void bundle_StopIdleTimer(struct bundle *); 16336285Sbrianextern int bundle_IsDead(struct bundle *); 16436285Sbrianextern struct datalink *bundle2datalink(struct bundle *, const char *); 16536285Sbrian 16658028Sbrianextern void bundle_RegisterDescriptor(struct bundle *, struct fdescriptor *); 16758028Sbrianextern void bundle_UnRegisterDescriptor(struct bundle *, struct fdescriptor *); 16836285Sbrian 16936285Sbrianextern void bundle_SetTtyCommandMode(struct bundle *, struct datalink *); 17036285Sbrian 17136285Sbrianextern int bundle_DatalinkClone(struct bundle *, struct datalink *, 17236285Sbrian const char *); 17336285Sbrianextern void bundle_DatalinkRemove(struct bundle *, struct datalink *); 17436285Sbrianextern void bundle_CleanDatalinks(struct bundle *); 17536285Sbrianextern void bundle_SetLabel(struct bundle *, const char *); 17636285Sbrianextern const char *bundle_GetLabel(struct bundle *); 17736285Sbrianextern void bundle_SendDatalink(struct datalink *, int, struct sockaddr_un *); 17853684Sbrianextern int bundle_LinkSize(void); 17953684Sbrianextern void bundle_ReceiveDatalink(struct bundle *, int); 18036285Sbrianextern int bundle_SetMode(struct bundle *, struct datalink *, int); 18136285Sbrianextern int bundle_RenameDatalink(struct bundle *, struct datalink *, 18236285Sbrian const char *); 18336452Sbrianextern void bundle_setsid(struct bundle *, int); 18436709Sbrianextern void bundle_LockTun(struct bundle *); 18540622Sbrianextern int bundle_HighestState(struct bundle *); 18641654Sbrianextern int bundle_Exception(struct bundle *, int); 18781634Sbrianextern void bundle_AdjustFilters(struct bundle *, struct ncpaddr *, 18881634Sbrian struct ncpaddr *); 18981634Sbrianextern void bundle_AdjustDNS(struct bundle *); 19049434Sbrianextern void bundle_CalculateBandwidth(struct bundle *); 19149434Sbrianextern void bundle_AutoAdjust(struct bundle *, int, int); 19249434Sbrianextern int bundle_WantAutoloadTimer(struct bundle *); 19356350Sbrianextern void bundle_ChangedPID(struct bundle *); 19459084Sbrianextern void bundle_Notify(struct bundle *, char); 19585991Sbrianextern int bundle_Uptime(struct bundle *); 196