1/*
2 * pppd.h - PPP daemon global declarations.
3 *
4 * Copyright (c) 1989 Carnegie Mellon University.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms are permitted
8 * provided that the above copyright notice and this paragraph are
9 * duplicated in all such forms and that any documentation,
10 * advertising materials, and other materials related to such
11 * distribution and use acknowledge that the software was developed
12 * by Carnegie Mellon University.  The name of the
13 * University may not be used to endorse or promote products derived
14 * from this software without specific prior written permission.
15 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
17 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
18 *
19 * $Id: pppd.h,v 1.1.1.1 2008/10/15 03:30:13 james26_jang Exp $
20 */
21
22/*
23 * TODO:
24 */
25
26#ifndef __PPPD_H__
27#define __PPPD_H__
28
29#include <stdio.h>		/* for FILE */
30#include <limits.h>		/* for NGROUPS_MAX */
31#include <sys/param.h>		/* for MAXPATHLEN and BSD4_4, if defined */
32#include <sys/types.h>		/* for u_int32_t, if defined */
33#include <sys/time.h>		/* for struct timeval */
34#include <net/ppp_defs.h>
35#include "patchlevel.h"
36
37#if defined(__STDC__)
38#include <stdarg.h>
39#define __V(x)	x
40#else
41#include <varargs.h>
42#define __V(x)	(va_alist) va_dcl
43#define const
44#define volatile
45#endif
46
47#ifdef INET6
48#include "eui64.h"
49#endif
50
51/*
52 * Limits.
53 */
54
55#define NUM_PPP		1	/* One PPP interface supported (per process) */
56#define MAXWORDLEN	1024	/* max length of word in file (incl null) */
57#define MAXARGS		1	/* max # args to a command */
58#define MAXNAMELEN	256	/* max length of hostname or name for auth */
59#define MAXSECRETLEN	256	/* max length of password or secret */
60
61/*
62 * Option descriptor structure.
63 */
64
65typedef unsigned char	bool;
66
67enum opt_type {
68	o_special_noarg = 0,
69	o_special = 1,
70	o_bool,
71	o_int,
72	o_uint32,
73	o_string,
74	o_wild,
75};
76
77typedef struct {
78	char	*name;		/* name of the option */
79	enum opt_type type;
80	void	*addr;
81	char	*description;
82	int	flags;
83	void	*addr2;
84	int	upper_limit;
85	int	lower_limit;
86	const char *source;
87	short int priority;
88	short int winner;
89} option_t;
90
91/* Values for flags */
92#define OPT_VALUE	0xff	/* mask for presupplied value */
93#define OPT_HEX		0x100	/* int option is in hex */
94#define OPT_NOARG	0x200	/* option doesn't take argument */
95#define OPT_OR		0x400	/* OR in argument to value */
96#define OPT_INC		0x800	/* increment value */
97#define OPT_PRIV	0x1000	/* privileged option */
98#define OPT_STATIC	0x2000	/* string option goes into static array */
99#define OPT_LLIMIT	0x4000	/* check value against lower limit */
100#define OPT_ULIMIT	0x8000	/* check value against upper limit */
101#define OPT_LIMITS	(OPT_LLIMIT|OPT_ULIMIT)
102#define OPT_ZEROOK	0x10000	/* 0 value is OK even if not within limits */
103#define OPT_HIDE	0x10000	/* for o_string, print value as ?????? */
104#define OPT_A2LIST	0x10000 /* for o_special, keep list of values */
105#define OPT_NOINCR	0x20000	/* value mustn't be increased */
106#define OPT_ZEROINF	0x40000	/* with OPT_NOINCR, 0 == infinity */
107#define OPT_PRIO	0x80000	/* process option priorities for this option */
108#define OPT_PRIOSUB	0x100000 /* subsidiary member of priority group */
109#define OPT_ALIAS	0x200000 /* option is alias for previous option */
110#define OPT_A2COPY	0x400000 /* addr2 -> second location to rcv value */
111#define OPT_ENABLE	0x800000 /* use *addr2 as enable for option */
112#define OPT_A2CLR	0x1000000 /* clear *(bool *)addr2 */
113#define OPT_PRIVFIX	0x2000000 /* user can't override if set by root */
114#define OPT_INITONLY	0x4000000 /* option can only be set in init phase */
115#define OPT_DEVEQUIV	0x8000000 /* equiv to device name */
116#define OPT_DEVNAM	(OPT_INITONLY | OPT_DEVEQUIV)
117#define OPT_A2PRINTER	0x10000000 /* *addr2 is a fn for printing option */
118#define OPT_A2STRVAL	0x20000000 /* *addr2 points to current string value */
119#define OPT_NOPRINT	0x40000000 /* don't print this option at all */
120
121#define OPT_VAL(x)	((x) & OPT_VALUE)
122
123/* Values for priority */
124#define OPRIO_DEFAULT	0	/* a default value */
125#define OPRIO_CFGFILE	1	/* value from a configuration file */
126#define OPRIO_CMDLINE	2	/* value from the command line */
127#define OPRIO_SECFILE	3	/* value from options in a secrets file */
128#define OPRIO_ROOT	100	/* added to priority if OPT_PRIVFIX && root */
129
130#ifndef GIDSET_TYPE
131#define GIDSET_TYPE	gid_t
132#endif
133
134/* Structure representing a list of permitted IP addresses. */
135struct permitted_ip {
136    int		permit;		/* 1 = permit, 0 = forbid */
137    u_int32_t	base;		/* match if (addr & mask) == base */
138    u_int32_t	mask;		/* base and mask are in network byte order */
139};
140
141/*
142 * Unfortunately, the linux kernel driver uses a different structure
143 * for statistics from the rest of the ports.
144 * This structure serves as a common representation for the bits
145 * pppd needs.
146 */
147struct pppd_stats {
148    unsigned int	bytes_in;
149    unsigned int	bytes_out;
150};
151
152/* Used for storing a sequence of words.  Usually malloced. */
153struct wordlist {
154    struct wordlist	*next;
155    char		*word;
156};
157
158/* An endpoint discriminator, used with multilink. */
159#define MAX_ENDP_LEN	20	/* maximum length of discriminator value */
160struct epdisc {
161    unsigned char	class;
162    unsigned char	length;
163    unsigned char	value[MAX_ENDP_LEN];
164};
165
166/* values for epdisc.class */
167#define EPD_NULL	0	/* null discriminator, no data */
168#define EPD_LOCAL	1
169#define EPD_IP		2
170#define EPD_MAC		3
171#define EPD_MAGIC	4
172#define EPD_PHONENUM	5
173
174typedef void (*notify_func) __P((void *, int));
175
176struct notifier {
177    struct notifier *next;
178    notify_func	    func;
179    void	    *arg;
180};
181
182/*
183 * Global variables.
184 */
185
186extern int	hungup;		/* Physical layer has disconnected */
187extern int	ifunit;		/* Interface unit number */
188extern char	ifname[];	/* Interface name */
189extern char	hostname[];	/* Our hostname */
190extern u_char	outpacket_buf[]; /* Buffer for outgoing packets */
191extern int	phase;		/* Current state of link - see values below */
192extern int	baud_rate;	/* Current link speed in bits/sec */
193extern char	*progname;	/* Name of this program */
194extern int	redirect_stderr;/* Connector's stderr should go to file */
195extern char	peer_authname[];/* Authenticated name of peer */
196extern int	privileged;	/* We were run by real-uid root */
197extern int	need_holdoff;	/* Need holdoff period after link terminates */
198extern char	**script_env;	/* Environment variables for scripts */
199extern int	detached;	/* Have detached from controlling tty */
200extern GIDSET_TYPE groups[NGROUPS_MAX];	/* groups the user is in */
201extern int	ngroups;	/* How many groups valid in groups */
202extern struct pppd_stats link_stats; /* byte/packet counts etc. for link */
203extern int	link_stats_valid; /* set if link_stats is valid */
204extern int	link_connect_time; /* time the link was up for */
205extern int	using_pty;	/* using pty as device (notty or pty opt.) */
206extern int	log_to_fd;	/* logging to this fd as well as syslog */
207extern bool	log_default;	/* log_to_fd is default (stdout) */
208extern char	*no_ppp_msg;	/* message to print if ppp not in kernel */
209extern volatile int status;	/* exit status for pppd */
210extern bool	devnam_fixed;	/* can no longer change devnam */
211extern int	unsuccess;	/* # unsuccessful connection attempts */
212extern int	do_callback;	/* set if we want to do callback next */
213extern int	doing_callback;	/* set if this is a callback */
214extern char	ppp_devnam[MAXPATHLEN];
215extern struct notifier *pidchange;   /* for notifications of pid changing */
216extern struct notifier *phasechange; /* for notifications of phase changes */
217extern struct notifier *exitnotify;  /* for notification that we're exiting */
218extern struct notifier *sigreceived; /* notification of received signal */
219extern int	listen_time;	/* time to listen first (ms) */
220
221/* Values for do_callback and doing_callback */
222#define CALLBACK_DIALIN		1	/* we are expecting the call back */
223#define CALLBACK_DIALOUT	2	/* we are dialling out to call back */
224
225/*
226 * Variables set by command-line options.
227 */
228
229extern int	debug;		/* Debug flag */
230extern int	kdebugflag;	/* Tell kernel to print debug messages */
231extern int	default_device;	/* Using /dev/tty or equivalent */
232extern char	devnam[MAXPATHLEN];	/* Device name */
233extern int	crtscts;	/* Use hardware flow control */
234extern bool	modem;		/* Use modem control lines */
235extern int	inspeed;	/* Input/Output speed requested */
236extern u_int32_t netmask;	/* IP netmask to set on interface */
237extern bool	lockflag;	/* Create lock file to lock the serial dev */
238extern bool	nodetach;	/* Don't detach from controlling tty */
239extern bool	updetach;	/* Detach from controlling tty when link up */
240extern char	*initializer;	/* Script to initialize physical link */
241extern char	*connect_script; /* Script to establish physical link */
242extern char	*disconnect_script; /* Script to disestablish physical link */
243extern char	*welcomer;	/* Script to welcome client after connection */
244extern char	*ptycommand;	/* Command to run on other side of pty */
245extern int	maxconnect;	/* Maximum connect time (seconds) */
246extern char	user[MAXNAMELEN];/* Our name for authenticating ourselves */
247extern char	passwd[MAXSECRETLEN];	/* Password for PAP or CHAP */
248extern bool	auth_required;	/* Peer is required to authenticate */
249extern bool	persist;	/* Reopen link after it goes down */
250extern bool	uselogin;	/* Use /etc/passwd for checking PAP */
251extern char	our_name[MAXNAMELEN];/* Our name for authentication purposes */
252extern char	remote_name[MAXNAMELEN]; /* Peer's name for authentication */
253extern bool	explicit_remote;/* remote_name specified with remotename opt */
254extern bool	demand;		/* Do dial-on-demand */
255extern char	*ipparam;	/* Extra parameter for ip up/down scripts */
256extern bool	cryptpap;	/* Others' PAP passwords are encrypted */
257extern int	idle_time_limit;/* Shut down link if idle for this long */
258extern int	holdoff;	/* Dead time before restarting */
259extern bool	holdoff_specified; /* true if user gave a holdoff value */
260extern bool	notty;		/* Stdin/out is not a tty */
261extern char	*pty_socket;	/* Socket to connect to pty */
262extern char	*record_file;	/* File to record chars sent/received */
263extern bool	sync_serial;	/* Device is synchronous serial device */
264extern int	maxfail;	/* Max # of unsuccessful connection attempts */
265extern char	linkname[MAXPATHLEN]; /* logical name for link */
266extern bool	tune_kernel;	/* May alter kernel settings as necessary */
267extern int	connect_delay;	/* Time to delay after connect script */
268extern int	max_data_rate;	/* max bytes/sec through charshunt */
269extern int	req_unit;	/* interface unit number to use */
270static const bool	multilink = 0;	/* enable multilink operation */
271extern bool	noendpoint;	/* don't send or accept endpt. discrim. */
272extern char	*bundle_name;	/* bundle name for multilink */
273extern bool	dump_options;	/* print out option values */
274extern bool	dryrun;		/* check everything, print options, exit */
275static const int new_style_driver = 1;
276
277#ifdef PPP_FILTER
278extern struct	bpf_program pass_filter;   /* Filter for pkts to pass */
279extern struct	bpf_program active_filter; /* Filter for link-active pkts */
280#endif
281
282#ifdef MSLANMAN
283extern bool	ms_lanman;	/* Use LanMan password instead of NT */
284				/* Has meaning only with MS-CHAP challenges */
285#endif
286
287extern char *current_option;	/* the name of the option being parsed */
288extern int  privileged_option;	/* set iff the current option came from root */
289extern char *option_source;	/* string saying where the option came from */
290extern int  option_priority;	/* priority of current options */
291
292/*
293 * Values for phase.
294 */
295#define PHASE_DEAD		0
296#define PHASE_INITIALIZE	1
297#define PHASE_SERIALCONN	2
298#define PHASE_DORMANT		3
299#define PHASE_ESTABLISH		4
300#define PHASE_AUTHENTICATE	5
301#define PHASE_CALLBACK		6
302#define PHASE_NETWORK		7
303#define PHASE_RUNNING		8
304#define PHASE_TERMINATE		9
305#define PHASE_DISCONNECT	10
306#define PHASE_HOLDOFF		11
307
308/*
309 * The following struct gives the addresses of procedures to call
310 * for a particular protocol.
311 */
312struct protent {
313    u_short protocol;		/* PPP protocol number */
314    /* Initialization procedure */
315    void (*init) __P((int unit));
316    /* Process a received packet */
317    void (*input) __P((int unit, u_char *pkt, int len));
318    /* Process a received protocol-reject */
319    void (*protrej) __P((int unit));
320    /* Lower layer has come up */
321    void (*lowerup) __P((int unit));
322    /* Lower layer has gone down */
323    void (*lowerdown) __P((int unit));
324    /* Open the protocol */
325    void (*open) __P((int unit));
326    /* Close the protocol */
327    void (*close) __P((int unit, char *reason));
328    /* Print a packet in readable form */
329    int  (*printpkt) __P((u_char *pkt, int len,
330			  void (*printer) __P((void *, char *, ...)),
331			  void *arg));
332    /* Process a received data packet */
333    void (*datainput) __P((int unit, u_char *pkt, int len));
334    bool enabled_flag;		/* 0 iff protocol is disabled */
335    char *name;			/* Text name of protocol */
336    char *data_name;		/* Text name of corresponding data protocol */
337    option_t *options;		/* List of command-line options */
338    /* Check requested options, assign defaults */
339    void (*check_options) __P((void));
340    /* Configure interface for demand-dial */
341    int  (*demand_conf) __P((int unit));
342    /* Say whether to bring up link for this pkt */
343    int  (*active_pkt) __P((u_char *pkt, int len));
344};
345
346/* Table of pointers to supported protocols */
347extern struct protent *protocols[];
348
349/*
350 * This struct contains pointers to a set of procedures for
351 * doing operations on a "channel".  A channel provides a way
352 * to send and receive PPP packets - the canonical example is
353 * a serial port device in PPP line discipline (or equivalently
354 * with PPP STREAMS modules pushed onto it).
355 */
356struct channel {
357	/* set of options for this channel */
358	option_t *options;
359	/* find and process a per-channel options file */
360	void (*process_extra_options) __P((void));
361	/* check all the options that have been given */
362	void (*check_options) __P((void));
363	/* get the channel ready to do PPP, return a file descriptor */
364	int  (*connect) __P((void));
365	/* we're finished with the channel */
366	void (*disconnect) __P((void));
367	/* put the channel into PPP `mode' */
368	int  (*establish_ppp) __P((int));
369	/* take the channel out of PPP `mode', restore loopback if demand */
370	void (*disestablish_ppp) __P((int));
371	/* set the transmit-side PPP parameters of the channel */
372	void (*send_config) __P((int, u_int32_t, int, int));
373	/* set the receive-side PPP parameters of the channel */
374	void (*recv_config) __P((int, u_int32_t, int, int));
375	/* cleanup on error or normal exit */
376	void (*cleanup) __P((void));
377	/* close the device, called in children after fork */
378	void (*close) __P((void));
379};
380
381extern struct channel *the_channel;
382
383#define ppp_send_config(unit, mtu, accm, pc, acc)			 \
384do {									 \
385	if (the_channel->send_config)					 \
386		(*the_channel->send_config)((mtu), (accm), (pc), (acc)); \
387} while (0)
388
389#define ppp_recv_config(unit, mtu, accm, pc, acc)			 \
390do {									 \
391	if (the_channel->send_config)					 \
392		(*the_channel->recv_config)((mtu), (accm), (pc), (acc)); \
393} while (0)
394
395/*
396 * Prototypes.
397 */
398
399/* Procedures exported from main.c. */
400void set_ifunit __P((int));	/* set stuff that depends on ifunit */
401void detach __P((void));	/* Detach from controlling tty */
402void die __P((int));		/* Cleanup and exit */
403void quit __P((void));		/* like die(1) */
404#define novm fatal
405void timeout __P((void (*func)(void *), void *arg, int s, int us));
406				/* Call func(arg) after s.us seconds */
407void untimeout __P((void (*func)(void *), void *arg));
408				/* Cancel call to func(arg) */
409void record_child __P((int, char *, void (*) (void *), void *));
410#define device_script(a,b,c,d) (-1)
411pid_t run_program __P((char *prog, char **args, int must_exist,
412		       void (*done)(void *), void *arg));
413				/* Run program prog with args in child */
414void reopen_log __P((void));	/* (re)open the connection to syslog */
415void update_link_stats __P((int)); /* Get stats at link termination */
416void script_setenv __P((char *, char *, int));	/* set script env var */
417void script_unsetenv __P((char *));		/* unset script env var */
418void new_phase __P((int));	/* signal start of new phase */
419#define add_notifier(a,b)
420#define remove_notifier(a,b)
421#define notify(a,b)
422
423/* Procedures exported from tty.c. */
424#define tty_init()
425
426/* Procedures exported from utils.c. */
427int slprintf __P((char *, int, char *, ...));		/* sprintf++ */
428int vslprintf __P((char *, int, char *, va_list));	/* vsprintf++ */
429size_t strlcpy __P((char *, const char *, size_t));	/* safe strcpy */
430size_t strlcat __P((char *, const char *, size_t));	/* safe strncpy */
431#ifdef DEBUG
432void log_packet __P((u_char *, int, char *, int));
433				/* Format a packet and log it with syslog */
434void print_string __P((char *, int,  void (*) (void *, char *, ...),
435		void *));	/* Format a string for output */
436void dbglog __P((char *, ...));	/* log a debug message */
437void info __P((char *, ...));	/* log an informational message */
438void notice __P((char *, ...));	/* log a notice-level message */
439void warn __P((char *, ...));	/* log a warning message */
440void error __P((char *, ...));	/* log an error message */
441void fatal __P((char *, ...));	/* log an error message and die(1) */
442void init_pr_log __P((char *, int));	/* initialize for using pr_log */
443void pr_log __P((void *, char *, ...));	/* printer fn, output to syslog */
444void end_pr_log __P((void));	/* finish up after using pr_log */
445#else
446#define log_packet(a,b,c,d)
447#define print_string(a,b,c,d)
448#define dbglog(a,b...)
449#define info(a,b...)
450#define notice(a,b...)
451#define warn(a,b...)
452#define error(a,b...)
453#define fatal(a,b...)
454#define init_pr_log(a,b)
455#define pr_log (NULL)
456#define end_pr_log()
457#endif
458
459/* Procedures exported from auth.c */
460#define link_required(a)
461void link_terminated __P((int));  /* we are finished with the link */
462void link_down __P((int));	  /* the LCP layer has left the Opened state */
463void link_established __P((int)); /* the link is up; authenticate now */
464void start_networks __P((void));  /* start all the network control protos */
465void np_up __P((int, int));	  /* a network protocol has come up */
466void np_down __P((int, int));	  /* a network protocol has gone down */
467void np_finished __P((int, int)); /* a network protocol no longer needs link */
468void auth_peer_fail __P((int, int));
469				/* peer failed to authenticate itself */
470void auth_peer_success __P((int, int, char *, int));
471				/* peer successfully authenticated itself */
472void auth_withpeer_fail __P((int, int));
473				/* we failed to authenticate ourselves */
474void auth_withpeer_success __P((int, int));
475				/* we successfully authenticated ourselves */
476#define auth_check_options()
477void auth_reset __P((int));	/* check what secrets we have */
478#define check_passwd(a,b,c,d,e,f) (UPAP_AUTHNAK)
479int  get_secret __P((int, char *, char *, char *, int *, int));
480				/* get "secret" for chap */
481#define auth_ip_addr(a,b) (1)
482int  bad_ip_adrs __P((u_int32_t));
483				/* check if IP address is unreasonable */
484
485/* Procedures exported from demand.c */
486void demand_conf __P((void));	/* config interface(s) for demand-dial */
487void demand_block __P((void));	/* set all NPs to queue up packets */
488void demand_unblock __P((void)); /* set all NPs to pass packets */
489void demand_discard __P((void)); /* set all NPs to discard packets */
490void demand_rexmit __P((int));	/* retransmit saved frames for an NP */
491int  loop_chars __P((unsigned char *, int)); /* process chars from loopback */
492int  loop_frame __P((unsigned char *, int)); /* should we bring link up? */
493
494/* Procedures exported from multilink.c */
495#define mp_check_options()
496#define mp_join_bundle() (0)
497#define epdisc_to_str(a) (NULL)
498#define str_to_epdisc(a,b) (0)
499
500/* Procedures exported from sys-*.c */
501void sys_init __P((void));	/* Do system-dependent initialization */
502void sys_cleanup __P((void));	/* Restore system state before exiting */
503#define sys_check_options() (1)
504void sys_close __P((void));	/* Clean up in a child before execing */
505int  ppp_available __P((void));	/* Test whether ppp kernel support exists */
506#define get_pty(a,b,c,d) (0)
507int  open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
508#define tty_establish_ppp(a) (-1)
509#define tty_disestablish_ppp(a)
510void generic_disestablish_ppp __P((int dev_fd)); /* Restore device setting */
511int  generic_establish_ppp __P((int dev_fd)); /* Make a ppp interface */
512#define make_new_bundle(a,b,c,d)
513#define bundle_attach(a) (0)
514#define cfg_bundle(a,b,c,d)
515void clean_check __P((void));	/* Check if line was 8-bit clean */
516#define set_up_tty(a,b)
517#define restore_tty(a)
518#define setdtr(a,b)
519void output __P((int, u_char *, int)); /* Output a PPP packet */
520void wait_input __P((struct timeval *));
521				/* Wait for input, with timeout */
522void add_fd __P((int));		/* Add fd to set to wait for */
523void remove_fd __P((int));	/* Remove fd from set to wait for */
524int  read_packet __P((u_char *)); /* Read PPP packet */
525int  get_loop_output __P((void)); /* Read pkts from loopback */
526#define tty_send_config(a,b,c,d)
527#define tty_set_xaccm(a)
528#define tty_recv_config(a,b,c,d)
529int  ccp_test __P((int, u_char *, int, int));
530				/* Test support for compression scheme */
531void ccp_flags_set __P((int, int, int));
532				/* Set kernel CCP state */
533int  ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */
534int  get_idle_time __P((int, struct ppp_idle *));
535				/* Find out how long link has been idle */
536int  get_ppp_stats __P((int, struct pppd_stats *));
537				/* Return link statistics */
538void netif_set_mtu __P((int, int)); /* Set PPP interface MTU */
539int  sifvjcomp __P((int, int, int, int));
540				/* Configure VJ TCP header compression */
541int  sifup __P((int));		/* Configure i/f up for one protocol */
542int  sifnpmode __P((int u, int proto, enum NPmode mode));
543				/* Set mode for handling packets for proto */
544int  sifdown __P((int));	/* Configure i/f down for one protocol */
545int  sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t));
546				/* Configure IPv4 addresses for i/f */
547int  cifaddr __P((int, u_int32_t, u_int32_t));
548				/* Reset i/f IP addresses */
549#define sifdefaultroute(a,b,c) (0)
550#define cifdefaultroute(a,b,c) (0)
551#define sifproxyarp(a,b) (0)
552#define cifproxyarp(a,b) (0)
553u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */
554#define lock(a) (0)
555#define relock(a) (0)
556#define unlock()
557#define logwtmp(a,b,c)
558int  get_host_seed __P((void));	/* Get host-dependent random number seed */
559#define have_route_to(a) (-1)
560#define get_if_hwaddr(a,b) (0)
561#define get_first_ethernet() ("eth0")
562
563/* Procedures exported from options.c */
564int  parse_args __P((int argc, char **argv));
565				/* Parse options from arguments given */
566#define options_from_file(a,b,c,d) (1)
567#define options_from_user() (1)
568#define options_for_tty() (1)
569#define options_from_list(a,b) (1)
570#define getword(a,b,c,d) (0)
571#define option_error error
572#define int_option(a,b) (1)
573#define add_options(a)
574#define check_options()
575#define remove_option(a) (0)
576#define override_value(a,b,c) (1)
577#define print_options(a,b)
578int parse_dotted_ip __P((char *, u_int32_t *));
579
580/*
581 * Hooks to enable plugins to change various things.
582 */
583extern int (*new_phase_hook) __P((int));
584extern int (*idle_time_hook) __P((struct ppp_idle *));
585extern int (*holdoff_hook) __P((void));
586extern int (*pap_check_hook) __P((void));
587extern int (*pap_auth_hook) __P((char *user, char *passwd, char **msgp,
588				 struct wordlist **paddrs,
589				 struct wordlist **popts));
590extern void (*pap_logout_hook) __P((void));
591extern int (*pap_passwd_hook) __P((char *user, char *passwd));
592extern void (*ip_up_hook) __P((void));
593extern void (*ip_down_hook) __P((void));
594extern void (*ip_choose_hook) __P((u_int32_t *));
595
596/*
597 * Inline versions of get/put char/short/long.
598 * Pointer is advanced; we assume that both arguments
599 * are lvalues and will already be in registers.
600 * cp MUST be u_char *.
601 */
602#define GETCHAR(c, cp) { \
603	(c) = *(cp)++; \
604}
605#define PUTCHAR(c, cp) { \
606	*(cp)++ = (u_char) (c); \
607}
608
609
610#define GETSHORT(s, cp) { \
611	(s) = *(cp)++ << 8; \
612	(s) |= *(cp)++; \
613}
614#define PUTSHORT(s, cp) { \
615	*(cp)++ = (u_char) ((s) >> 8); \
616	*(cp)++ = (u_char) (s); \
617}
618
619#define GETLONG(l, cp) { \
620	(l) = *(cp)++ << 8; \
621	(l) |= *(cp)++; (l) <<= 8; \
622	(l) |= *(cp)++; (l) <<= 8; \
623	(l) |= *(cp)++; \
624}
625#define PUTLONG(l, cp) { \
626	*(cp)++ = (u_char) ((l) >> 24); \
627	*(cp)++ = (u_char) ((l) >> 16); \
628	*(cp)++ = (u_char) ((l) >> 8); \
629	*(cp)++ = (u_char) (l); \
630}
631
632#define INCPTR(n, cp)	((cp) += (n))
633#define DECPTR(n, cp)	((cp) -= (n))
634
635/*
636 * System dependent definitions for user-level 4.3BSD UNIX implementation.
637 */
638
639#define TIMEOUT(r, f, t)	timeout((r), (f), (t), 0)
640#define UNTIMEOUT(r, f)		untimeout((r), (f))
641
642#define BCOPY(s, d, l)		memcpy(d, s, l)
643#define BZERO(s, n)		memset(s, 0, n)
644
645#define PRINTMSG(m, l)		{ info("Remote message: %0.*v", l, m); }
646
647/*
648 * MAKEHEADER - Add Header fields to a packet.
649 */
650#define MAKEHEADER(p, t) { \
651    PUTCHAR(PPP_ALLSTATIONS, p); \
652    PUTCHAR(PPP_UI, p); \
653    PUTSHORT(t, p); }
654
655/*
656 * Exit status values.
657 */
658#define EXIT_OK			0
659#define EXIT_FATAL_ERROR	1
660#define EXIT_OPTION_ERROR	2
661#define EXIT_NOT_ROOT		3
662#define EXIT_NO_KERNEL_SUPPORT	4
663#define EXIT_USER_REQUEST	5
664#define EXIT_LOCK_FAILED	6
665#define EXIT_OPEN_FAILED	7
666#define EXIT_CONNECT_FAILED	8
667#define EXIT_PTYCMD_FAILED	9
668#define EXIT_NEGOTIATION_FAILED	10
669#define EXIT_PEER_AUTH_FAILED	11
670#define EXIT_IDLE_TIMEOUT	12
671#define EXIT_CONNECT_TIME	13
672#define EXIT_CALLBACK		14
673#define EXIT_PEER_DEAD		15
674#define EXIT_HANGUP		16
675#define EXIT_LOOPBACK		17
676#define EXIT_INIT_FAILED	18
677#define EXIT_AUTH_TOPEER_FAILED	19
678
679/*
680 * Debug macros.  Slightly useful for finding bugs in pppd, not particularly
681 * useful for finding out why your connection isn't being established.
682 */
683#ifdef DEBUGALL
684#define DEBUGMAIN	1
685#define DEBUGFSM	1
686#define DEBUGLCP	1
687#define DEBUGIPCP	1
688#define DEBUGIPV6CP	1
689#define DEBUGUPAP	1
690#define DEBUGCHAP	1
691#endif
692
693#ifndef LOG_PPP			    /* we use LOG_LOCAL2 for syslog by default */
694#if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \
695  || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \
696  || defined(DEBUGCHAP) || defined(DEBUG) || defined(DEBUGIPV6CP)
697#define LOG_PPP LOG_LOCAL2
698#else
699#define LOG_PPP LOG_DAEMON
700#endif
701#endif /* LOG_PPP */
702
703#ifdef DEBUGMAIN
704#define MAINDEBUG(x)	if (debug) dbglog x
705#else
706#define MAINDEBUG(x)
707#endif
708
709#ifdef DEBUGSYS
710#define SYSDEBUG(x)	if (debug) dbglog x
711#else
712#define SYSDEBUG(x)
713#endif
714
715#ifdef DEBUGFSM
716#define FSMDEBUG(x)	if (debug) dbglog x
717#else
718#define FSMDEBUG(x)
719#endif
720
721#ifdef DEBUGLCP
722#define LCPDEBUG(x)	if (debug) dbglog x
723#else
724#define LCPDEBUG(x)
725#endif
726
727#ifdef DEBUGIPCP
728#define IPCPDEBUG(x)	if (debug) dbglog x
729#else
730#define IPCPDEBUG(x)
731#endif
732
733#ifdef DEBUGIPV6CP
734#define IPV6CPDEBUG(x)  if (debug) dbglog x
735#else
736#define IPV6CPDEBUG(x)
737#endif
738
739#ifdef DEBUGUPAP
740#define UPAPDEBUG(x)	if (debug) dbglog x
741#else
742#define UPAPDEBUG(x)
743#endif
744
745#ifdef DEBUGCHAP
746#define CHAPDEBUG(x)	if (debug) dbglog x
747#else
748#define CHAPDEBUG(x)
749#endif
750
751#ifdef DEBUGIPXCP
752#define IPXCPDEBUG(x)	if (debug) dbglog x
753#else
754#define IPXCPDEBUG(x)
755#endif
756
757#ifndef SIGTYPE
758#if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
759#define SIGTYPE void
760#else
761#define SIGTYPE int
762#endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */
763#endif /* SIGTYPE */
764
765#ifndef MIN
766#define MIN(a, b)	((a) < (b)? (a): (b))
767#endif
768#ifndef MAX
769#define MAX(a, b)	((a) > (b)? (a): (b))
770#endif
771
772#endif /* __PPP_H__ */
773