bundle.h revision 65178
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 65178 2000-08-28 22:44:54Z 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 3962778Sbrian#define OPT_KEEPSESSION 0x0008 4062778Sbrian#define OPT_LOOPBACK 0x0010 4162778Sbrian#define OPT_PASSWDAUTH 0x0020 4262778Sbrian#define OPT_PROXY 0x0040 4362778Sbrian#define OPT_PROXYALL 0x0080 4462778Sbrian#define OPT_SROUTES 0x0100 4562778Sbrian#define OPT_THROUGHPUT 0x0200 4662778Sbrian#define OPT_UTMP 0x0400 4736285Sbrian 4836285Sbrian#define MAX_ENDDISC_CLASS 5 4936285Sbrian 5036285Sbrian#define Enabled(b, o) ((b)->cfg.opt & (o)) 5136285Sbrian 5249434Sbrian/* AutoAdjust() values */ 5349434Sbrian#define AUTO_UP 1 5449434Sbrian#define AUTO_DOWN 2 5549434Sbrian 5636285Sbrianstruct sockaddr_un; 5736285Sbrianstruct datalink; 5836285Sbrianstruct physical; 5936285Sbrianstruct link; 6036285Sbrianstruct server; 6136285Sbrianstruct prompt; 6240561Sbrianstruct iface; 6336285Sbrian 6436285Sbrianstruct bundle { 6558040Sbrian struct fdescriptor desc; /* really all our datalinks */ 6636285Sbrian int unit; /* The device/interface unit number */ 6736285Sbrian 6836285Sbrian struct { 6936285Sbrian char Name[20]; /* The /dev/XXXX name */ 7058038Sbrian int fd; /* The /dev/XXXX descriptor */ 7156413Sbrian unsigned header : 1; /* Family header sent & received ? */ 7236285Sbrian } dev; 7336285Sbrian 7449434Sbrian u_long bandwidth; /* struct tuninfo speed */ 7540561Sbrian struct iface *iface; /* Interface information */ 7640561Sbrian 7736285Sbrian int routing_seq; /* The current routing sequence number */ 7836285Sbrian u_int phase; /* Curent phase */ 7936285Sbrian 8036928Sbrian struct { 8136928Sbrian int all; /* Union of all physical::type's */ 8236928Sbrian int open; /* Union of all open physical::type's */ 8336928Sbrian } phys_type; 8436928Sbrian 8536285Sbrian unsigned CleaningUp : 1; /* Going to exit.... */ 8650059Sbrian unsigned NatEnabled : 1; /* Are we using libalias ? */ 8736285Sbrian 8836285Sbrian struct fsm_parent fsm; /* Our callback functions */ 8936285Sbrian struct datalink *links; /* Our data links */ 9036285Sbrian 9149978Sbrian time_t upat; /* When the link came up */ 9249978Sbrian 9336285Sbrian struct { 9436285Sbrian struct { 9549978Sbrian int timeout; /* NCP Idle timeout value */ 9649978Sbrian int min_timeout; /* Don't idle out before this */ 9749978Sbrian } idle; 9849978Sbrian struct { 9943313Sbrian char name[AUTHLEN]; /* PAP/CHAP system name */ 10043313Sbrian char key[AUTHLEN]; /* PAP/CHAP key */ 10136285Sbrian } auth; 10236285Sbrian unsigned opt; /* Uses OPT_ bits from above */ 10336285Sbrian char label[50]; /* last thing `load'ed */ 10436285Sbrian u_short mtu; /* Interface mtu */ 10561534Sbrian u_short ifqueue; /* Interface queue size */ 10636285Sbrian 10738544Sbrian struct { 10843313Sbrian int timeout; /* How long to leave the output queue choked */ 10938544Sbrian } choked; 11036285Sbrian } cfg; 11136285Sbrian 11236285Sbrian struct { 11336285Sbrian struct ipcp ipcp; /* Our IPCP FSM */ 11436285Sbrian struct mp mp; /* Our MP */ 11536285Sbrian } ncp; 11636285Sbrian 11736285Sbrian struct { 11843313Sbrian struct filter in; /* incoming packet filter */ 11943313Sbrian struct filter out; /* outgoing packet filter */ 12043313Sbrian struct filter dial; /* dial-out packet filter */ 12143313Sbrian struct filter alive; /* keep-alive packet filter */ 12236285Sbrian } filter; 12336285Sbrian 12436285Sbrian struct { 12543313Sbrian struct pppTimer timer; /* timeout after cfg.idle_timeout */ 12636285Sbrian time_t done; 12736285Sbrian } idle; 12836285Sbrian 12936285Sbrian struct { 13043313Sbrian int fd; /* write status here */ 13136285Sbrian } notify; 13236285Sbrian 13336285Sbrian struct { 13443313Sbrian struct pppTimer timer; /* choked output queue timer */ 13538544Sbrian } choked; 13643313Sbrian 13743313Sbrian#ifndef NORADIUS 13843313Sbrian struct radius radius; /* Info retrieved from radius server */ 13965178Sbrian struct radacct radacct; 14043313Sbrian#endif 14136285Sbrian}; 14236285Sbrian 14336285Sbrian#define descriptor2bundle(d) \ 14436285Sbrian ((d)->type == BUNDLE_DESCRIPTOR ? (struct bundle *)(d) : NULL) 14536285Sbrian 14653298Sbrianextern struct bundle *bundle_Create(const char *, int, int); 14736285Sbrianextern void bundle_Destroy(struct bundle *); 14836285Sbrianextern const char *bundle_PhaseName(struct bundle *); 14936285Sbrian#define bundle_Phase(b) ((b)->phase) 15036285Sbrianextern void bundle_NewPhase(struct bundle *, u_int); 15138174Sbrianextern void bundle_LinksRemoved(struct bundle *); 15236285Sbrianextern int bundle_LinkIsUp(const struct bundle *); 15336285Sbrianextern int bundle_SetRoute(struct bundle *, int, struct in_addr, 15437927Sbrian struct in_addr, struct in_addr, int, int); 15536285Sbrianextern void bundle_Close(struct bundle *, const char *, int); 15637018Sbrianextern void bundle_Down(struct bundle *, int); 15737955Sbrianextern void bundle_Open(struct bundle *, const char *, int, int); 15836285Sbrianextern void bundle_LinkClosed(struct bundle *, struct datalink *); 15936285Sbrian 16036285Sbrianextern int bundle_ShowLinks(struct cmdargs const *); 16136285Sbrianextern int bundle_ShowStatus(struct cmdargs const *); 16262977Sbrianextern void bundle_StartIdleTimer(struct bundle *, unsigned secs); 16349978Sbrianextern void bundle_SetIdleTimer(struct bundle *, int, int); 16436285Sbrianextern void bundle_StopIdleTimer(struct bundle *); 16536285Sbrianextern int bundle_IsDead(struct bundle *); 16636285Sbrianextern struct datalink *bundle2datalink(struct bundle *, const char *); 16736285Sbrian 16858028Sbrianextern void bundle_RegisterDescriptor(struct bundle *, struct fdescriptor *); 16958028Sbrianextern void bundle_UnRegisterDescriptor(struct bundle *, struct fdescriptor *); 17036285Sbrian 17136285Sbrianextern void bundle_SetTtyCommandMode(struct bundle *, struct datalink *); 17236285Sbrian 17336285Sbrianextern int bundle_DatalinkClone(struct bundle *, struct datalink *, 17436285Sbrian const char *); 17536285Sbrianextern void bundle_DatalinkRemove(struct bundle *, struct datalink *); 17636285Sbrianextern void bundle_CleanDatalinks(struct bundle *); 17736285Sbrianextern void bundle_SetLabel(struct bundle *, const char *); 17836285Sbrianextern const char *bundle_GetLabel(struct bundle *); 17936285Sbrianextern void bundle_SendDatalink(struct datalink *, int, struct sockaddr_un *); 18053684Sbrianextern int bundle_LinkSize(void); 18153684Sbrianextern void bundle_ReceiveDatalink(struct bundle *, int); 18236285Sbrianextern int bundle_SetMode(struct bundle *, struct datalink *, int); 18336285Sbrianextern int bundle_RenameDatalink(struct bundle *, struct datalink *, 18436285Sbrian const char *); 18536452Sbrianextern void bundle_setsid(struct bundle *, int); 18636709Sbrianextern void bundle_LockTun(struct bundle *); 18740622Sbrianextern int bundle_HighestState(struct bundle *); 18841654Sbrianextern int bundle_Exception(struct bundle *, int); 18947648Sbrianextern void bundle_AdjustFilters(struct bundle *, struct in_addr *, 19047648Sbrian struct in_addr *); 19158044Sbrianextern void bundle_AdjustDNS(struct bundle *, struct in_addr [2]); 19249434Sbrianextern void bundle_CalculateBandwidth(struct bundle *); 19349434Sbrianextern void bundle_AutoAdjust(struct bundle *, int, int); 19449434Sbrianextern int bundle_WantAutoloadTimer(struct bundle *); 19556350Sbrianextern void bundle_ChangedPID(struct bundle *); 19659084Sbrianextern void bundle_Notify(struct bundle *, char); 197