]> git.ozlabs.org Git - ppp.git/blob - pppd/pppd.h
Forgot to remote *.ln files (made by lint) when doing make clean.
[ppp.git] / pppd / pppd.h
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.48 1999/09/11 12:08:59 paulus 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
36 #if defined(__STDC__)
37 #include <stdarg.h>
38 #define __V(x)  x
39 #else
40 #include <varargs.h>
41 #define __V(x)  (va_alist) va_dcl
42 #define const
43 #define volatile
44 #endif
45
46 #ifdef INET6
47 #include "eui64.h"
48 #endif
49
50 /*
51  * Limits.
52  */
53
54 #define NUM_PPP         1       /* One PPP interface supported (per process) */
55 #define MAXWORDLEN      1024    /* max length of word in file (incl null) */
56 #define MAXARGS         1       /* max # args to a command */
57 #define MAXNAMELEN      256     /* max length of hostname or name for auth */
58 #define MAXSECRETLEN    256     /* max length of password or secret */
59
60 /*
61  * Option descriptor structure.
62  */
63
64 typedef unsigned char   bool;
65
66 enum opt_type {
67         o_special_noarg = 0,
68         o_special = 1,
69         o_bool,
70         o_int,
71         o_uint32,
72         o_string,
73 };
74
75 typedef struct {
76         char    *name;          /* name of the option */
77         enum opt_type type;
78         void    *addr;
79         char    *description;
80         int     flags;
81         void    *addr2;
82         int     upper_limit;
83         int     lower_limit;
84 } option_t;
85
86 /* Values for flags */
87 #define OPT_VALUE       0xff    /* mask for presupplied value */
88 #define OPT_HEX         0x100   /* int option is in hex */
89 #define OPT_NOARG       0x200   /* option doesn't take argument */
90 #define OPT_OR          0x400   /* OR in argument to value */
91 #define OPT_INC         0x800   /* increment value */
92 #define OPT_PRIV        0x1000  /* privileged option */
93 #define OPT_STATIC      0x2000  /* string option goes into static array */
94 #define OPT_LLIMIT      0x4000  /* check value against lower limit */
95 #define OPT_ULIMIT      0x8000  /* check value against upper limit */
96 #define OPT_LIMITS      (OPT_LLIMIT|OPT_ULIMIT)
97 #define OPT_ZEROOK      0x10000 /* 0 value is OK even if not within limits */
98 #define OPT_NOINCR      0x20000 /* value mustn't be increased */
99 #define OPT_ZEROINF     0x40000 /* with OPT_NOINCR, 0 == infinity */
100 #define OPT_A2INFO      0x100000 /* addr2 -> option_info to update */
101 #define OPT_A2COPY      0x200000 /* addr2 -> second location to rcv value */
102 #define OPT_ENABLE      0x400000 /* use *addr2 as enable for option */
103 #define OPT_PRIVFIX     0x800000 /* can't be overridden if noauth */
104 #define OPT_PREPASS     0x1000000 /* do this opt in pre-pass to find device */
105 #define OPT_INITONLY    0x2000000 /* option can only be set in init phase */
106 #define OPT_DEVEQUIV    0x4000000 /* equiv to device name */
107 #define OPT_DEVNAM      (OPT_PREPASS | OPT_INITONLY | OPT_DEVEQUIV)
108
109 #define OPT_VAL(x)      ((x) & OPT_VALUE)
110
111 #ifndef GIDSET_TYPE
112 #define GIDSET_TYPE     gid_t
113 #endif
114
115 /* Structure representing a list of permitted IP addresses. */
116 struct permitted_ip {
117     int         permit;         /* 1 = permit, 0 = forbid */
118     u_int32_t   base;           /* match if (addr & mask) == base */
119     u_int32_t   mask;           /* base and mask are in network byte order */
120 };
121
122 /*
123  * Unfortunately, the linux kernel driver uses a different structure
124  * for statistics from the rest of the ports.
125  * This structure serves as a common representation for the bits
126  * pppd needs.
127  */
128 struct pppd_stats {
129     unsigned int        bytes_in;
130     unsigned int        bytes_out;
131 };
132
133 /* Used for storing a sequence of words.  Usually malloced. */
134 struct wordlist {
135     struct wordlist     *next;
136     char                *word;
137 };
138
139 /*
140  * Global variables.
141  */
142
143 extern int      hungup;         /* Physical layer has disconnected */
144 extern int      ifunit;         /* Interface unit number */
145 extern char     ifname[];       /* Interface name */
146 extern int      ttyfd;          /* Serial device file descriptor */
147 extern char     hostname[];     /* Our hostname */
148 extern u_char   outpacket_buf[]; /* Buffer for outgoing packets */
149 extern int      phase;          /* Current state of link - see values below */
150 extern int      baud_rate;      /* Current link speed in bits/sec */
151 extern char     *progname;      /* Name of this program */
152 extern int      redirect_stderr;/* Connector's stderr should go to file */
153 extern char     peer_authname[];/* Authenticated name of peer */
154 extern int      privileged;     /* We were run by real-uid root */
155 extern int      need_holdoff;   /* Need holdoff period after link terminates */
156 extern char     **script_env;   /* Environment variables for scripts */
157 extern int      detached;       /* Have detached from controlling tty */
158 extern GIDSET_TYPE groups[NGROUPS_MAX]; /* groups the user is in */
159 extern int      ngroups;        /* How many groups valid in groups */
160 extern struct pppd_stats link_stats; /* byte/packet counts etc. for link */
161 extern int      link_stats_valid; /* set if link_stats is valid */
162 extern int      link_connect_time; /* time the link was up for */
163 extern int      using_pty;      /* using pty as device (notty or pty opt.) */
164 extern int      log_to_fd;      /* logging to this fd as well as syslog */
165 extern char     *no_ppp_msg;    /* message to print if ppp not in kernel */
166 extern volatile int status;     /* exit status for pppd */
167 extern int      devnam_fixed;   /* can no longer change devnam */
168 extern int      unsuccess;      /* # unsuccessful connection attempts */
169
170 /*
171  * Variables set by command-line options.
172  */
173
174 extern int      debug;          /* Debug flag */
175 extern int      kdebugflag;     /* Tell kernel to print debug messages */
176 extern int      default_device; /* Using /dev/tty or equivalent */
177 extern char     devnam[MAXPATHLEN];     /* Device name */
178 extern int      crtscts;        /* Use hardware flow control */
179 extern bool     modem;          /* Use modem control lines */
180 extern int      inspeed;        /* Input/Output speed requested */
181 extern u_int32_t netmask;       /* IP netmask to set on interface */
182 extern bool     lockflag;       /* Create lock file to lock the serial dev */
183 extern bool     nodetach;       /* Don't detach from controlling tty */
184 extern bool     updetach;       /* Detach from controlling tty when link up */
185 extern char     *initializer;   /* Script to initialize physical link */
186 extern char     *connector;     /* Script to establish physical link */
187 extern char     *disconnector;  /* Script to disestablish physical link */
188 extern char     *welcomer;      /* Script to welcome client after connection */
189 extern char     *ptycommand;    /* Command to run on other side of pty */
190 extern int      maxconnect;     /* Maximum connect time (seconds) */
191 extern char     user[MAXNAMELEN];/* Our name for authenticating ourselves */
192 extern char     passwd[MAXSECRETLEN];   /* Password for PAP or CHAP */
193 extern bool     auth_required;  /* Peer is required to authenticate */
194 extern bool     persist;        /* Reopen link after it goes down */
195 extern bool     uselogin;       /* Use /etc/passwd for checking PAP */
196 extern char     our_name[MAXNAMELEN];/* Our name for authentication purposes */
197 extern char     remote_name[MAXNAMELEN]; /* Peer's name for authentication */
198 extern bool     explicit_remote;/* remote_name specified with remotename opt */
199 extern bool     demand;         /* Do dial-on-demand */
200 extern char     *ipparam;       /* Extra parameter for ip up/down scripts */
201 extern bool     cryptpap;       /* Others' PAP passwords are encrypted */
202 extern int      idle_time_limit;/* Shut down link if idle for this long */
203 extern int      holdoff;        /* Dead time before restarting */
204 extern bool     holdoff_specified; /* true if user gave a holdoff value */
205 extern bool     notty;          /* Stdin/out is not a tty */
206 extern char     *record_file;   /* File to record chars sent/received */
207 extern bool     sync_serial;    /* Device is synchronous serial device */
208 extern int      maxfail;        /* Max # of unsuccessful connection attempts */
209 extern char     linkname[MAXPATHLEN]; /* logical name for link */
210 extern bool     tune_kernel;    /* May alter kernel settings as necessary */
211
212 #ifdef PPP_FILTER
213 extern struct   bpf_program pass_filter;   /* Filter for pkts to pass */
214 extern struct   bpf_program active_filter; /* Filter for link-active pkts */
215 #endif
216
217 #ifdef MSLANMAN
218 extern bool     ms_lanman;      /* Use LanMan password instead of NT */
219                                 /* Has meaning only with MS-CHAP challenges */
220 #endif
221
222 extern char *current_option;    /* the name of the option being parsed */
223 extern int  privileged_option;  /* set iff the current option came from root */
224 extern char *option_source;     /* string saying where the option came from */
225
226 /*
227  * Values for phase.
228  */
229 #define PHASE_DEAD              0
230 #define PHASE_INITIALIZE        1
231 #define PHASE_SERIALCONN        2
232 #define PHASE_DORMANT           3
233 #define PHASE_ESTABLISH         4
234 #define PHASE_AUTHENTICATE      5
235 #define PHASE_CALLBACK          6
236 #define PHASE_NETWORK           7
237 #define PHASE_RUNNING           8
238 #define PHASE_TERMINATE         9
239 #define PHASE_DISCONNECT        10
240 #define PHASE_HOLDOFF           11
241
242 /*
243  * The following struct gives the addresses of procedures to call
244  * for a particular protocol.
245  */
246 struct protent {
247     u_short protocol;           /* PPP protocol number */
248     /* Initialization procedure */
249     void (*init) __P((int unit));
250     /* Process a received packet */
251     void (*input) __P((int unit, u_char *pkt, int len));
252     /* Process a received protocol-reject */
253     void (*protrej) __P((int unit));
254     /* Lower layer has come up */
255     void (*lowerup) __P((int unit));
256     /* Lower layer has gone down */
257     void (*lowerdown) __P((int unit));
258     /* Open the protocol */
259     void (*open) __P((int unit));
260     /* Close the protocol */
261     void (*close) __P((int unit, char *reason));
262     /* Print a packet in readable form */
263     int  (*printpkt) __P((u_char *pkt, int len,
264                           void (*printer) __P((void *, char *, ...)),
265                           void *arg));
266     /* Process a received data packet */
267     void (*datainput) __P((int unit, u_char *pkt, int len));
268     bool enabled_flag;          /* 0 iff protocol is disabled */
269     char *name;                 /* Text name of protocol */
270     char *data_name;            /* Text name of corresponding data protocol */
271     option_t *options;          /* List of command-line options */
272     /* Check requested options, assign defaults */
273     void (*check_options) __P((void));
274     /* Configure interface for demand-dial */
275     int  (*demand_conf) __P((int unit));
276     /* Say whether to bring up link for this pkt */
277     int  (*active_pkt) __P((u_char *pkt, int len));
278 };
279
280 /* Table of pointers to supported protocols */
281 extern struct protent *protocols[];
282
283 /*
284  * Prototypes.
285  */
286
287 /* Procedures exported from main.c. */
288 void detach __P((void));        /* Detach from controlling tty */
289 void die __P((int));            /* Cleanup and exit */
290 void quit __P((void));          /* like die(1) */
291 void novm __P((char *));        /* Say we ran out of memory, and die */
292 void timeout __P((void (*func)(void *), void *arg, int t));
293                                 /* Call func(arg) after t seconds */
294 void untimeout __P((void (*func)(void *), void *arg));
295                                 /* Cancel call to func(arg) */
296 pid_t run_program __P((char *prog, char **args, int must_exist,
297                        void (*done)(void *), void *arg));
298                                 /* Run program prog with args in child */
299 void reopen_log __P((void));    /* (re)open the connection to syslog */
300 void update_link_stats __P((int)); /* Get stats at link termination */
301 void script_setenv __P((char *, char *));       /* set script env var */
302 void script_unsetenv __P((char *));             /* unset script env var */
303 void new_phase __P((int));      /* signal start of new phase */
304
305 /* Procedures exported from utils.c. */
306 void log_packet __P((u_char *, int, char *, int));
307                                 /* Format a packet and log it with syslog */
308 void print_string __P((char *, int,  void (*) (void *, char *, ...),
309                 void *));       /* Format a string for output */
310 int slprintf __P((char *, int, char *, ...));           /* sprintf++ */
311 int vslprintf __P((char *, int, char *, va_list));      /* vsprintf++ */
312 size_t strlcpy __P((char *, const char *, size_t));     /* safe strcpy */
313 size_t strlcat __P((char *, const char *, size_t));     /* safe strncpy */
314 void dbglog __P((char *, ...)); /* log a debug message */
315 void info __P((char *, ...));   /* log an informational message */
316 void notice __P((char *, ...)); /* log a notice-level message */
317 void warn __P((char *, ...));   /* log a warning message */
318 void error __P((char *, ...));  /* log an error message */
319 void fatal __P((char *, ...));  /* log an error message and die(1) */
320
321 /* Procedures exported from auth.c */
322 void link_required __P((int));    /* we are starting to use the link */
323 void link_terminated __P((int));  /* we are finished with the link */
324 void link_down __P((int));        /* the LCP layer has left the Opened state */
325 void link_established __P((int)); /* the link is up; authenticate now */
326 void start_networks __P((void));  /* start all the network control protos */
327 void np_up __P((int, int));       /* a network protocol has come up */
328 void np_down __P((int, int));     /* a network protocol has gone down */
329 void np_finished __P((int, int)); /* a network protocol no longer needs link */
330 void auth_peer_fail __P((int, int));
331                                 /* peer failed to authenticate itself */
332 void auth_peer_success __P((int, int, char *, int));
333                                 /* peer successfully authenticated itself */
334 void auth_withpeer_fail __P((int, int));
335                                 /* we failed to authenticate ourselves */
336 void auth_withpeer_success __P((int, int));
337                                 /* we successfully authenticated ourselves */
338 void auth_check_options __P((void));
339                                 /* check authentication options supplied */
340 void auth_reset __P((int));     /* check what secrets we have */
341 int  check_passwd __P((int, char *, int, char *, int, char **));
342                                 /* Check peer-supplied username/password */
343 int  get_secret __P((int, char *, char *, char *, int *, int));
344                                 /* get "secret" for chap */
345 int  auth_ip_addr __P((int, u_int32_t));
346                                 /* check if IP address is authorized */
347 int  bad_ip_adrs __P((u_int32_t));
348                                 /* check if IP address is unreasonable */
349
350 /* Procedures exported from demand.c */
351 void demand_conf __P((void));   /* config interface(s) for demand-dial */
352 void demand_block __P((void));  /* set all NPs to queue up packets */
353 void demand_unblock __P((void)); /* set all NPs to pass packets */
354 void demand_discard __P((void)); /* set all NPs to discard packets */
355 void demand_rexmit __P((int));  /* retransmit saved frames for an NP */
356 int  loop_chars __P((unsigned char *, int)); /* process chars from loopback */
357 int  loop_frame __P((unsigned char *, int)); /* should we bring link up? */
358
359 /* Procedures exported from sys-*.c */
360 void sys_init __P((void));      /* Do system-dependent initialization */
361 void sys_cleanup __P((void));   /* Restore system state before exiting */
362 int  sys_check_options __P((void)); /* Check options specified */
363 void sys_close __P((void));     /* Clean up in a child before execing */
364 int  ppp_available __P((void)); /* Test whether ppp kernel support exists */
365 int  get_pty __P((int *, int *, char *, int));  /* Get pty master/slave */
366 int  open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
367 int  establish_ppp __P((int));  /* Turn serial port into a ppp interface */
368 void restore_loop __P((void));  /* Transfer ppp unit back to loopback */
369 void disestablish_ppp __P((int)); /* Restore port to normal operation */
370 void clean_check __P((void));   /* Check if line was 8-bit clean */
371 void set_up_tty __P((int, int)); /* Set up port's speed, parameters, etc. */
372 void restore_tty __P((int));    /* Restore port's original parameters */
373 void setdtr __P((int, int));    /* Raise or lower port's DTR line */
374 void output __P((int, u_char *, int)); /* Output a PPP packet */
375 void wait_input __P((struct timeval *));
376                                 /* Wait for input, with timeout */
377 void add_fd __P((int));         /* Add fd to set to wait for */
378 void remove_fd __P((int));      /* Remove fd from set to wait for */
379 int  read_packet __P((u_char *)); /* Read PPP packet */
380 int  get_loop_output __P((void)); /* Read pkts from loopback */
381 void ppp_send_config __P((int, int, u_int32_t, int, int));
382                                 /* Configure i/f transmit parameters */
383 void ppp_set_xaccm __P((int, ext_accm));
384                                 /* Set extended transmit ACCM */
385 void ppp_recv_config __P((int, int, u_int32_t, int, int));
386                                 /* Configure i/f receive parameters */
387 int  ccp_test __P((int, u_char *, int, int));
388                                 /* Test support for compression scheme */
389 void ccp_flags_set __P((int, int, int));
390                                 /* Set kernel CCP state */
391 int  ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */
392 int  get_idle_time __P((int, struct ppp_idle *));
393                                 /* Find out how long link has been idle */
394 int  get_ppp_stats __P((int, struct pppd_stats *));
395                                 /* Return link statistics */
396 int  sifvjcomp __P((int, int, int, int));
397                                 /* Configure VJ TCP header compression */
398 int  sifup __P((int));          /* Configure i/f up for one protocol */
399 int  sifnpmode __P((int u, int proto, enum NPmode mode));
400                                 /* Set mode for handling packets for proto */
401 int  sifdown __P((int));        /* Configure i/f down for one protocol */
402 int  sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t));
403                                 /* Configure IPv4 addresses for i/f */
404 int  cifaddr __P((int, u_int32_t, u_int32_t));
405                                 /* Reset i/f IP addresses */
406 #ifdef INET6
407 int  sif6addr __P((int, eui64_t, eui64_t));
408                                 /* Configure IPv6 addresses for i/f */
409 int  cif6addr __P((int, eui64_t, eui64_t));
410                                 /* Remove an IPv6 address from i/f */
411 #endif
412 int  sifdefaultroute __P((int, u_int32_t, u_int32_t));
413                                 /* Create default route through i/f */
414 int  cifdefaultroute __P((int, u_int32_t, u_int32_t));
415                                 /* Delete default route through i/f */
416 int  sifproxyarp __P((int, u_int32_t));
417                                 /* Add proxy ARP entry for peer */
418 int  cifproxyarp __P((int, u_int32_t));
419                                 /* Delete proxy ARP entry for peer */
420 u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */
421 int  lock __P((char *));        /* Create lock file for device */
422 int  relock __P((int));         /* Rewrite lock file with new pid */
423 void unlock __P((void));        /* Delete previously-created lock file */
424 void logwtmp __P((const char *, const char *, const char *));
425                                 /* Write entry to wtmp file */
426 int  get_host_seed __P((void)); /* Get host-dependent random number seed */
427 int  have_route_to __P((u_int32_t)); /* Check if route to addr exists */
428 #ifdef PPP_FILTER
429 int  set_filters __P((struct bpf_program *pass, struct bpf_program *active));
430                                 /* Set filter programs in kernel */
431 #endif
432 #ifdef IPX_CHANGE
433 int  sipxfaddr __P((int, unsigned long, unsigned char *));
434 int  cipxfaddr __P((int));
435 #endif
436
437 /* Procedures exported from options.c */
438 int  parse_args __P((int argc, char **argv));
439                                 /* Parse options from arguments given */
440 int  options_from_file __P((char *filename, int must_exist, int check_prot,
441                             int privileged));
442                                 /* Parse options from an options file */
443 int  options_from_user __P((void)); /* Parse options from user's .ppprc */
444 int  options_for_tty __P((void)); /* Parse options from /etc/ppp/options.tty */
445 int  options_from_list __P((struct wordlist *, int privileged));
446                                 /* Parse options from a wordlist */
447 int  getword __P((FILE *f, char *word, int *newlinep, char *filename));
448                                 /* Read a word from a file */
449 void option_error __P((char *fmt, ...));
450                                 /* Print an error message about an option */
451 int int_option __P((char *, int *));
452                                 /* Simplified number_option for decimal ints */
453 void add_options __P((option_t *)); /* Add extra options */
454
455 /*
456  * This structure is used to store information about certain
457  * options, such as where the option value came from (/etc/ppp/options,
458  * command line, etc.) and whether it came from a privileged source.
459  */
460
461 struct option_info {
462     int     priv;               /* was value set by sysadmin? */
463     char    *source;            /* where option came from */
464 };
465
466 extern struct option_info devnam_info;
467 extern struct option_info initializer_info;
468 extern struct option_info connector_info;
469 extern struct option_info disconnector_info;
470 extern struct option_info welcomer_info;
471 extern struct option_info ptycommand_info;
472
473 /*
474  * Hooks to enable plugins to change various things.
475  */
476 extern int (*new_phase_hook) __P((int));
477 extern int (*idle_time_hook) __P((struct ppp_idle *));
478 extern int (*holdoff_hook) __P((void));
479 extern int (*pap_check_hook) __P((void));
480 extern int (*pap_auth_hook) __P((char *user, char *passwd, char **msgp,
481                                  struct wordlist **paddrs,
482                                  struct wordlist **popts));
483 extern int (*pap_passwd_hook) __P((char *user, char *passwd));
484
485 /*
486  * Inline versions of get/put char/short/long.
487  * Pointer is advanced; we assume that both arguments
488  * are lvalues and will already be in registers.
489  * cp MUST be u_char *.
490  */
491 #define GETCHAR(c, cp) { \
492         (c) = *(cp)++; \
493 }
494 #define PUTCHAR(c, cp) { \
495         *(cp)++ = (u_char) (c); \
496 }
497
498
499 #define GETSHORT(s, cp) { \
500         (s) = *(cp)++ << 8; \
501         (s) |= *(cp)++; \
502 }
503 #define PUTSHORT(s, cp) { \
504         *(cp)++ = (u_char) ((s) >> 8); \
505         *(cp)++ = (u_char) (s); \
506 }
507
508 #define GETLONG(l, cp) { \
509         (l) = *(cp)++ << 8; \
510         (l) |= *(cp)++; (l) <<= 8; \
511         (l) |= *(cp)++; (l) <<= 8; \
512         (l) |= *(cp)++; \
513 }
514 #define PUTLONG(l, cp) { \
515         *(cp)++ = (u_char) ((l) >> 24); \
516         *(cp)++ = (u_char) ((l) >> 16); \
517         *(cp)++ = (u_char) ((l) >> 8); \
518         *(cp)++ = (u_char) (l); \
519 }
520
521 #define INCPTR(n, cp)   ((cp) += (n))
522 #define DECPTR(n, cp)   ((cp) -= (n))
523
524 /*
525  * System dependent definitions for user-level 4.3BSD UNIX implementation.
526  */
527
528 #define TIMEOUT(r, f, t)        timeout((r), (f), (t))
529 #define UNTIMEOUT(r, f)         untimeout((r), (f))
530
531 #define BCOPY(s, d, l)          memcpy(d, s, l)
532 #define BZERO(s, n)             memset(s, 0, n)
533
534 #define PRINTMSG(m, l)          { info("Remote message: %0.*v", l, m); }
535
536 /*
537  * MAKEHEADER - Add Header fields to a packet.
538  */
539 #define MAKEHEADER(p, t) { \
540     PUTCHAR(PPP_ALLSTATIONS, p); \
541     PUTCHAR(PPP_UI, p); \
542     PUTSHORT(t, p); }
543
544 /*
545  * Exit status values.
546  */
547 #define EXIT_OK                 0
548 #define EXIT_FATAL_ERROR        1
549 #define EXIT_OPTION_ERROR       2
550 #define EXIT_NOT_ROOT           3
551 #define EXIT_NO_KERNEL_SUPPORT  4
552 #define EXIT_USER_REQUEST       5
553 #define EXIT_LOCK_FAILED        6
554 #define EXIT_OPEN_FAILED        7
555 #define EXIT_CONNECT_FAILED     8
556 #define EXIT_PTYCMD_FAILED      9
557 #define EXIT_NEGOTIATION_FAILED 10
558 #define EXIT_PEER_AUTH_FAILED   11
559 #define EXIT_IDLE_TIMEOUT       12
560 #define EXIT_CONNECT_TIME       13
561 #define EXIT_CALLBACK           14
562 #define EXIT_PEER_DEAD          15
563 #define EXIT_HANGUP             16
564 #define EXIT_LOOPBACK           17
565 #define EXIT_INIT_FAILED        18
566 #define EXIT_AUTH_TOPEER_FAILED 19
567
568 /*
569  * Debug macros.  Slightly useful for finding bugs in pppd, not particularly
570  * useful for finding out why your connection isn't being established.
571  */
572 #ifdef DEBUGALL
573 #define DEBUGMAIN       1
574 #define DEBUGFSM        1
575 #define DEBUGLCP        1
576 #define DEBUGIPCP       1
577 #define DEBUGIPV6CP     1
578 #define DEBUGUPAP       1
579 #define DEBUGCHAP       1
580 #endif
581
582 #ifndef LOG_PPP                 /* we use LOG_LOCAL2 for syslog by default */
583 #if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \
584   || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \
585   || defined(DEBUGCHAP) || defined(DEBUG) || defined(DEBUGIPV6CP)
586 #define LOG_PPP LOG_LOCAL2
587 #else
588 #define LOG_PPP LOG_DAEMON
589 #endif
590 #endif /* LOG_PPP */
591
592 #ifdef DEBUGMAIN
593 #define MAINDEBUG(x)    if (debug) dbglog x
594 #else
595 #define MAINDEBUG(x)
596 #endif
597
598 #ifdef DEBUGSYS
599 #define SYSDEBUG(x)     if (debug) dbglog x
600 #else
601 #define SYSDEBUG(x)
602 #endif
603
604 #ifdef DEBUGFSM
605 #define FSMDEBUG(x)     if (debug) dbglog x
606 #else
607 #define FSMDEBUG(x)
608 #endif
609
610 #ifdef DEBUGLCP
611 #define LCPDEBUG(x)     if (debug) dbglog x
612 #else
613 #define LCPDEBUG(x)
614 #endif
615
616 #ifdef DEBUGIPCP
617 #define IPCPDEBUG(x)    if (debug) dbglog x
618 #else
619 #define IPCPDEBUG(x)
620 #endif
621
622 #ifdef DEBUGIPV6CP
623 #define IPV6CPDEBUG(x)  if (debug) dbglog x
624 #else
625 #define IPV6CPDEBUG(x)
626 #endif
627
628 #ifdef DEBUGUPAP
629 #define UPAPDEBUG(x)    if (debug) dbglog x
630 #else
631 #define UPAPDEBUG(x)
632 #endif
633
634 #ifdef DEBUGCHAP
635 #define CHAPDEBUG(x)    if (debug) dbglog x
636 #else
637 #define CHAPDEBUG(x)
638 #endif
639
640 #ifdef DEBUGIPXCP
641 #define IPXCPDEBUG(x)   if (debug) dbglog x
642 #else
643 #define IPXCPDEBUG(x)
644 #endif
645
646 #ifndef SIGTYPE
647 #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
648 #define SIGTYPE void
649 #else
650 #define SIGTYPE int
651 #endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */
652 #endif /* SIGTYPE */
653
654 #ifndef MIN
655 #define MIN(a, b)       ((a) < (b)? (a): (b))
656 #endif
657 #ifndef MAX
658 #define MAX(a, b)       ((a) > (b)? (a): (b))
659 #endif
660
661 #endif /* __PPP_H__ */