if_spppvar.h revision 1.32
1 /* $NetBSD: if_spppvar.h,v 1.32 2020/11/25 10:30:51 yamaguchi Exp $ */ 2 3 #ifndef _NET_IF_SPPPVAR_H_ 4 #define _NET_IF_SPPPVAR_H_ 5 6 /* 7 * Defines for synchronous PPP/Cisco link level subroutines. 8 * 9 * Copyright (C) 1994 Cronyx Ltd. 10 * Author: Serge Vakulenko, <vak (at) cronyx.ru> 11 * 12 * Heavily revamped to conform to RFC 1661. 13 * Copyright (C) 1997, Joerg Wunsch. 14 * 15 * This software is distributed with NO WARRANTIES, not even the implied 16 * warranties for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 17 * 18 * Authors grant any other persons or organizations permission to use 19 * or modify this software as long as this message is kept with the software, 20 * all derivative works or modified versions. 21 * 22 * From: Version 2.0, Fri Oct 6 20:39:21 MSK 1995 23 * 24 * From: if_sppp.h,v 1.8 1997/10/11 11:25:20 joerg Exp 25 * 26 * From: Id: if_sppp.h,v 1.7 1998/12/01 20:20:19 hm Exp 27 */ 28 29 #include <sys/workqueue.h> 30 #include <sys/pcq.h> 31 struct sppp; 32 33 struct sppp_work { 34 struct work work; 35 void *arg; 36 void (*func)(struct sppp *, void *); 37 unsigned int state; 38 #define SPPP_WK_FREE 0 39 #define SPPP_WK_BUSY 1 40 #define SPPP_WK_UNAVAIL 2 41 }; 42 43 #define IDX_LCP 0 /* idx into state table */ 44 45 struct slcp { 46 u_long opts; /* LCP options to send (bitfield) */ 47 u_long magic; /* local magic number */ 48 u_long mru; /* our max receive unit */ 49 u_long their_mru; /* their max receive unit */ 50 u_long protos; /* bitmask of protos that are started */ 51 u_char echoid; /* id of last keepalive echo request */ 52 /* restart max values, see RFC 1661 */ 53 int timeout; 54 int max_terminate; 55 int max_configure; 56 int max_failure; 57 /* multilink variables */ 58 u_long mrru; /* our max received reconstructed unit */ 59 u_long their_mrru; /* their max receive dreconstructed unit */ 60 bool reestablish; /* reestablish after the next down event */ 61 bool tlf_sent; /* call lower layer's tlf before a down event */ 62 }; 63 64 #define IDX_IPCP 1 /* idx into state table */ 65 #define IDX_IPV6CP 2 /* idx into state table */ 66 67 struct sipcp { 68 u_long opts; /* IPCP options to send (bitfield) */ 69 u_int flags; 70 #define IPCP_HISADDR_SEEN 1 /* have seen his address already */ 71 #define IPCP_MYADDR_SEEN 2 /* have a local address assigned already */ 72 #define IPCP_MYADDR_DYN 4 /* my address is dynamically assigned */ 73 #define IPCP_HISADDR_DYN 8 /* his address is dynamically assigned */ 74 #ifdef notdef 75 #define IPV6CP_MYIFID_DYN 2 /* my ifid is dynamically assigned */ 76 #endif 77 #define IPV6CP_MYIFID_SEEN 4 /* have seen his ifid already */ 78 uint32_t saved_hisaddr;/* if hisaddr (IPv4) is dynamic, save original one here, in network byte order */ 79 uint32_t req_hisaddr; /* remote address requested */ 80 uint32_t req_myaddr; /* local address requested */ 81 82 uint8_t my_ifid[8]; /* IPv6CP my ifid*/ 83 uint8_t his_ifid[8]; /* IPv6CP his ifid*/ 84 }; 85 86 struct sauth { 87 u_short proto; /* authentication protocol to use */ 88 u_short flags; 89 char *name; /* system identification name */ 90 char *secret; /* secret password */ 91 u_char name_len; /* no need to have a bigger size */ 92 u_char secret_len; /* because proto gives size in a byte */ 93 }; 94 95 struct schap { 96 char challenge[16]; /* random challenge 97 [don't change size! it's really hardcoded!] */ 98 char digest[16]; 99 u_char digest_len; 100 bool rechallenging; /* sent challenge after open */ 101 bool response_rcvd; /* receive response, stop sending challenge */ 102 103 struct sppp_work work_challenge_rcvd; 104 }; 105 106 #define IDX_PAP 3 107 #define IDX_CHAP 4 108 109 #define IDX_COUNT (IDX_CHAP + 1) /* bump this when adding cp's! */ 110 111 struct sppp_cp { 112 u_long seq; /* local sequence number */ 113 u_long rseq; /* remote sequence number */ 114 int state; /* state machine */ 115 u_char confid; /* local id of last configuration request */ 116 u_char rconfid; /* remote id of last configuration request */ 117 int rst_counter; /* restart counter */ 118 int fail_counter; /* negotiation failure counter */ 119 struct callout ch; /* per-proto and if callouts */ 120 u_char rcr_type; 121 void *rcr_buf; 122 size_t rcr_blen; 123 int rcr_rlen; 124 125 struct sppp_work work_up; 126 struct sppp_work work_down; 127 struct sppp_work work_open; 128 struct sppp_work work_close; 129 struct sppp_work work_to; 130 struct sppp_work work_rcr; 131 struct sppp_work work_rca; 132 struct sppp_work work_rcn; 133 struct sppp_work work_rtr; 134 struct sppp_work work_rta; 135 struct sppp_work work_rxj; 136 }; 137 138 struct sppp { 139 /* NB: pp_if _must_ be first */ 140 struct ifnet pp_if; /* network interface data */ 141 struct ifqueue pp_fastq; /* fast output queue */ 142 struct ifqueue pp_cpq; /* PPP control protocol queue */ 143 struct sppp *pp_next; /* next interface in keepalive list */ 144 u_int pp_flags; /* use Cisco protocol instead of PPP */ 145 u_int pp_framebytes; /* number of bytes added by (hardware) framing */ 146 u_int pp_alivecnt; /* keepalive packets counter */ 147 u_int pp_loopcnt; /* loopback detection counter */ 148 u_int pp_maxalive; /* number or echo req. w/o reply */ 149 uint64_t pp_saved_mtu; /* saved MTU value */ 150 time_t pp_last_receive; /* peer's last "sign of life" */ 151 time_t pp_max_noreceive; /* seconds since last receive before 152 we start to worry and send echo 153 requests */ 154 time_t pp_last_activity; /* second of last payload data s/r */ 155 time_t pp_idle_timeout; /* idle seconds before auto-disconnect, 156 * 0 = disabled */ 157 int pp_auth_failures; /* authorization failures */ 158 int pp_max_auth_fail; /* max. allowed authorization failures */ 159 int pp_phase; /* phase we're currently in */ 160 krwlock_t pp_lock; /* lock for sppp structure */ 161 int query_dns; /* 1 if we want to know the dns addresses */ 162 uint32_t dns_addrs[2]; 163 #if defined(__FreeBSD__) && __FreeBSD__ >= 3 164 struct callout_handle ch[IDX_COUNT]; /* per-proto and if callouts */ 165 struct callout_handle pap_my_to_ch; /* PAP needs one more... */ 166 #endif 167 struct workqueue *wq_cp; 168 struct sppp_work work_ifdown; 169 struct sppp_cp scp[IDX_COUNT]; 170 struct slcp lcp; /* LCP params */ 171 struct sipcp ipcp; /* IPCP params */ 172 struct sipcp ipv6cp; /* IPv6CP params */ 173 struct sauth myauth; /* auth params, i'm peer */ 174 struct sauth hisauth; /* auth params, i'm authenticator */ 175 struct schap chap; /* CHAP params */ 176 /* 177 * These functions are filled in by sppp_attach(), and are 178 * expected to be used by the lower layer (hardware) drivers 179 * in order to communicate the (un)availability of the 180 * communication link. Lower layer drivers that are always 181 * ready to communicate (like hardware HDLC) can shortcut 182 * pp_up from pp_tls, and pp_down from pp_tlf. 183 */ 184 void (*pp_up)(struct sppp *); 185 void (*pp_down)(struct sppp *); 186 /* 187 * These functions need to be filled in by the lower layer 188 * (hardware) drivers if they request notification from the 189 * PPP layer whether the link is actually required. They 190 * correspond to the tls and tlf actions. 191 */ 192 void (*pp_tls)(struct sppp *); 193 void (*pp_tlf)(struct sppp *); 194 /* 195 * These (optional) functions may be filled by the hardware 196 * driver if any notification of established connections 197 * (currently: IPCP up) is desired (pp_con) or any internal 198 * state change of the interface state machine should be 199 * signaled for monitoring purposes (pp_chg). 200 */ 201 void (*pp_con)(struct sppp *); 202 void (*pp_chg)(struct sppp *, int); 203 }; 204 205 #define PP_KEEPALIVE 0x01 /* use keepalive protocol */ 206 #define PP_CISCO 0x02 /* use Cisco protocol instead of PPP */ 207 /* 0x04 was PP_TIMO */ 208 #define PP_CALLIN 0x08 /* we are being called */ 209 #define PP_NEEDAUTH 0x10 /* remote requested authentication */ 210 #define PP_NOFRAMING 0x20 /* do not add/expect encapsulation 211 around PPP frames (i.e. the serial 212 HDLC like encapsulation, RFC1662) */ 213 214 215 #define PP_MTU 1500 /* default/minimal MRU */ 216 #define PP_MAX_MRU 2048 /* maximal MRU we want to negotiate */ 217 218 #ifdef _KERNEL 219 void sppp_attach (struct ifnet *); 220 void sppp_detach (struct ifnet *); 221 void sppp_input (struct ifnet *, struct mbuf *); 222 int sppp_ioctl(struct ifnet *, u_long, void *); 223 struct mbuf *sppp_dequeue (struct ifnet *); 224 int sppp_isempty (struct ifnet *); 225 void sppp_flush (struct ifnet *); 226 #endif 227 228 /* 229 * Locking notes: 230 * + spppq is protected by spppq_lock (an adaptive mutex) 231 * spppq is a list of all struct sppps, and it is used for 232 * sending keepalive packets. 233 * + struct sppp is protected by sppp->pp_lock (an rwlock) 234 * sppp holds configuration parameters for line, 235 * authentication and addresses. It also has pointers 236 * of functions to notify events to lower layer. 237 * When notify events, sppp->pp_lock must be released. 238 * Because the event handler implemented in a lower 239 * layer often call functions implemented in 240 * if_spppsubr.c. 241 * 242 * Locking order: 243 * - spppq_lock => struct sppp->pp_lock 244 * 245 * NOTICE 246 * - Lower layers must not acquire sppp->pp_lock 247 */ 248 #endif /* !_NET_IF_SPPPVAR_H_ */ 249
Indexes created Mon Sep 29 21:09:56 GMT 2025