changes to linux interface for new kernel driver,
[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.51 2000/03/27 06:03:06 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 extern int      do_callback;    /* set if we want to do callback next */
170 extern int      doing_callback; /* set if this is a callback */
171
172 /* Values for do_callback and doing_callback */
173 #define CALLBACK_DIALIN         1       /* we are expecting the call back */
174 #define CALLBACK_DIALOUT        2       /* we are dialling out to call back */
175
176 /*
177  * Variables set by command-line options.
178  */
179
180 extern int      debug;          /* Debug flag */
181 extern int      kdebugflag;     /* Tell kernel to print debug messages */
182 extern int      default_device; /* Using /dev/tty or equivalent */
183 extern char     devnam[MAXPATHLEN];     /* Device name */
184 extern int      crtscts;        /* Use hardware flow control */
185 extern bool     modem;          /* Use modem control lines */
186 extern int      inspeed;        /* Input/Output speed requested */
187 extern u_int32_t netmask;       /* IP netmask to set on interface */
188 extern bool     lockflag;       /* Create lock file to lock the serial dev */
189 extern bool     nodetach;       /* Don't detach from controlling tty */
190 extern bool     updetach;       /* Detach from controlling tty when link up */
191 extern char     *initializer;   /* Script to initialize physical link */
192 extern char     *connect_script; /* Script to establish physical link */
193 extern char     *disconnect_script; /* Script to disestablish physical link */
194 extern char     *welcomer;      /* Script to welcome client after connection */
195 extern char     *ptycommand;    /* Command to run on other side of pty */
196 extern int      maxconnect;     /* Maximum connect time (seconds) */
197 extern char     user[MAXNAMELEN];/* Our name for authenticating ourselves */
198 extern char     passwd[MAXSECRETLEN];   /* Password for PAP or CHAP */
199 extern bool     auth_required;  /* Peer is required to authenticate */
200 extern bool     persist;        /* Reopen link after it goes down */
201 extern bool     uselogin;       /* Use /etc/passwd for checking PAP */
202 extern char     our_name[MAXNAMELEN];/* Our name for authentication purposes */
203 extern char     remote_name[MAXNAMELEN]; /* Peer's name for authentication */
204 extern bool     explicit_remote;/* remote_name specified with remotename opt */
205 extern bool     demand;         /* Do dial-on-demand */
206 extern char     *ipparam;       /* Extra parameter for ip up/down scripts */
207 extern bool     cryptpap;       /* Others' PAP passwords are encrypted */
208 extern int      idle_time_limit;/* Shut down link if idle for this long */
209 extern int      holdoff;        /* Dead time before restarting */
210 extern bool     holdoff_specified; /* true if user gave a holdoff value */
211 extern bool     notty;          /* Stdin/out is not a tty */
212 extern char     *pty_socket;    /* Socket to connect to pty */
213 extern char     *record_file;   /* File to record chars sent/received */
214 extern bool     sync_serial;    /* Device is synchronous serial device */
215 extern int      maxfail;        /* Max # of unsuccessful connection attempts */
216 extern char     linkname[MAXPATHLEN]; /* logical name for link */
217 extern bool     tune_kernel;    /* May alter kernel settings as necessary */
218 extern int      connect_delay;  /* Time to delay after connect script */
219 extern int      max_data_rate;  /* max bytes/sec through charshunt */
220 extern int      req_unit;       /* interface unit number to use */
221 extern bool     multilink;      /* enable multilink operation */
222
223 #ifdef PPP_FILTER
224 extern struct   bpf_program pass_filter;   /* Filter for pkts to pass */
225 extern struct   bpf_program active_filter; /* Filter for link-active pkts */
226 #endif
227
228 #ifdef MSLANMAN
229 extern bool     ms_lanman;      /* Use LanMan password instead of NT */
230                                 /* Has meaning only with MS-CHAP challenges */
231 #endif
232
233 extern char *current_option;    /* the name of the option being parsed */
234 extern int  privileged_option;  /* set iff the current option came from root */
235 extern char *option_source;     /* string saying where the option came from */
236
237 /*
238  * Values for phase.
239  */
240 #define PHASE_DEAD              0
241 #define PHASE_INITIALIZE        1
242 #define PHASE_SERIALCONN        2
243 #define PHASE_DORMANT           3
244 #define PHASE_ESTABLISH         4
245 #define PHASE_AUTHENTICATE      5
246 #define PHASE_CALLBACK          6
247 #define PHASE_NETWORK           7
248 #define PHASE_RUNNING           8
249 #define PHASE_TERMINATE         9
250 #define PHASE_DISCONNECT        10
251 #define PHASE_HOLDOFF           11
252
253 /*
254  * The following struct gives the addresses of procedures to call
255  * for a particular protocol.
256  */
257 struct protent {
258     u_short protocol;           /* PPP protocol number */
259     /* Initialization procedure */
260     void (*init) __P((int unit));
261     /* Process a received packet */
262     void (*input) __P((int unit, u_char *pkt, int len));
263     /* Process a received protocol-reject */
264     void (*protrej) __P((int unit));
265     /* Lower layer has come up */
266     void (*lowerup) __P((int unit));
267     /* Lower layer has gone down */
268     void (*lowerdown) __P((int unit));
269     /* Open the protocol */
270     void (*open) __P((int unit));
271     /* Close the protocol */
272     void (*close) __P((int unit, char *reason));
273     /* Print a packet in readable form */
274     int  (*printpkt) __P((u_char *pkt, int len,
275                           void (*printer) __P((void *, char *, ...)),
276                           void *arg));
277     /* Process a received data packet */
278     void (*datainput) __P((int unit, u_char *pkt, int len));
279     bool enabled_flag;          /* 0 iff protocol is disabled */
280     char *name;                 /* Text name of protocol */
281     char *data_name;            /* Text name of corresponding data protocol */
282     option_t *options;          /* List of command-line options */
283     /* Check requested options, assign defaults */
284     void (*check_options) __P((void));
285     /* Configure interface for demand-dial */
286     int  (*demand_conf) __P((int unit));
287     /* Say whether to bring up link for this pkt */
288     int  (*active_pkt) __P((u_char *pkt, int len));
289 };
290
291 /* Table of pointers to supported protocols */
292 extern struct protent *protocols[];
293
294 /*
295  * Prototypes.
296  */
297
298 /* Procedures exported from main.c. */
299 void detach __P((void));        /* Detach from controlling tty */
300 void die __P((int));            /* Cleanup and exit */
301 void quit __P((void));          /* like die(1) */
302 void novm __P((char *));        /* Say we ran out of memory, and die */
303 void timeout __P((void (*func)(void *), void *arg, int t));
304                                 /* Call func(arg) after t seconds */
305 void untimeout __P((void (*func)(void *), void *arg));
306                                 /* Cancel call to func(arg) */
307 pid_t run_program __P((char *prog, char **args, int must_exist,
308                        void (*done)(void *), void *arg));
309                                 /* Run program prog with args in child */
310 void reopen_log __P((void));    /* (re)open the connection to syslog */
311 void update_link_stats __P((int)); /* Get stats at link termination */
312 void script_setenv __P((char *, char *));       /* set script env var */
313 void script_unsetenv __P((char *));             /* unset script env var */
314 void new_phase __P((int));      /* signal start of new phase */
315
316 /* Procedures exported from utils.c. */
317 void log_packet __P((u_char *, int, char *, int));
318                                 /* Format a packet and log it with syslog */
319 void print_string __P((char *, int,  void (*) (void *, char *, ...),
320                 void *));       /* Format a string for output */
321 int slprintf __P((char *, int, char *, ...));           /* sprintf++ */
322 int vslprintf __P((char *, int, char *, va_list));      /* vsprintf++ */
323 size_t strlcpy __P((char *, const char *, size_t));     /* safe strcpy */
324 size_t strlcat __P((char *, const char *, size_t));     /* safe strncpy */
325 void dbglog __P((char *, ...)); /* log a debug message */
326 void info __P((char *, ...));   /* log an informational message */
327 void notice __P((char *, ...)); /* log a notice-level message */
328 void warn __P((char *, ...));   /* log a warning message */
329 void error __P((char *, ...));  /* log an error message */
330 void fatal __P((char *, ...));  /* log an error message and die(1) */
331
332 /* Procedures exported from auth.c */
333 void link_required __P((int));    /* we are starting to use the link */
334 void link_terminated __P((int));  /* we are finished with the link */
335 void link_down __P((int));        /* the LCP layer has left the Opened state */
336 void link_established __P((int)); /* the link is up; authenticate now */
337 void start_networks __P((void));  /* start all the network control protos */
338 void np_up __P((int, int));       /* a network protocol has come up */
339 void np_down __P((int, int));     /* a network protocol has gone down */
340 void np_finished __P((int, int)); /* a network protocol no longer needs link */
341 void auth_peer_fail __P((int, int));
342                                 /* peer failed to authenticate itself */
343 void auth_peer_success __P((int, int, char *, int));
344                                 /* peer successfully authenticated itself */
345 void auth_withpeer_fail __P((int, int));
346                                 /* we failed to authenticate ourselves */
347 void auth_withpeer_success __P((int, int));
348                                 /* we successfully authenticated ourselves */
349 void auth_check_options __P((void));
350                                 /* check authentication options supplied */
351 void auth_reset __P((int));     /* check what secrets we have */
352 int  check_passwd __P((int, char *, int, char *, int, char **));
353                                 /* Check peer-supplied username/password */
354 int  get_secret __P((int, char *, char *, char *, int *, int));
355                                 /* get "secret" for chap */
356 int  auth_ip_addr __P((int, u_int32_t));
357                                 /* check if IP address is authorized */
358 int  bad_ip_adrs __P((u_int32_t));
359                                 /* check if IP address is unreasonable */
360
361 /* Procedures exported from demand.c */
362 void demand_conf __P((void));   /* config interface(s) for demand-dial */
363 void demand_block __P((void));  /* set all NPs to queue up packets */
364 void demand_unblock __P((void)); /* set all NPs to pass packets */
365 void demand_discard __P((void)); /* set all NPs to discard packets */
366 void demand_rexmit __P((int));  /* retransmit saved frames for an NP */
367 int  loop_chars __P((unsigned char *, int)); /* process chars from loopback */
368 int  loop_frame __P((unsigned char *, int)); /* should we bring link up? */
369
370 /* Procedures exported from sys-*.c */
371 void sys_init __P((void));      /* Do system-dependent initialization */
372 void sys_cleanup __P((void));   /* Restore system state before exiting */
373 int  sys_check_options __P((void)); /* Check options specified */
374 void sys_close __P((void));     /* Clean up in a child before execing */
375 int  ppp_available __P((void)); /* Test whether ppp kernel support exists */
376 int  get_pty __P((int *, int *, char *, int));  /* Get pty master/slave */
377 int  open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
378 int  establish_ppp __P((int));  /* Turn serial port into a ppp interface */
379 void restore_loop __P((void));  /* Transfer ppp unit back to loopback */
380 void disestablish_ppp __P((int)); /* Restore port to normal operation */
381 void clean_check __P((void));   /* Check if line was 8-bit clean */
382 void set_up_tty __P((int, int)); /* Set up port's speed, parameters, etc. */
383 void restore_tty __P((int));    /* Restore port's original parameters */
384 void setdtr __P((int, int));    /* Raise or lower port's DTR line */
385 void output __P((int, u_char *, int)); /* Output a PPP packet */
386 void wait_input __P((struct timeval *));
387                                 /* Wait for input, with timeout */
388 void add_fd __P((int));         /* Add fd to set to wait for */
389 void remove_fd __P((int));      /* Remove fd from set to wait for */
390 int  read_packet __P((u_char *)); /* Read PPP packet */
391 int  get_loop_output __P((void)); /* Read pkts from loopback */
392 void ppp_send_config __P((int, int, u_int32_t, int, int));
393                                 /* Configure i/f transmit parameters */
394 void ppp_set_xaccm __P((int, ext_accm));
395                                 /* Set extended transmit ACCM */
396 void ppp_recv_config __P((int, int, u_int32_t, int, int));
397                                 /* Configure i/f receive parameters */
398 int  ccp_test __P((int, u_char *, int, int));
399                                 /* Test support for compression scheme */
400 void ccp_flags_set __P((int, int, int));
401                                 /* Set kernel CCP state */
402 int  ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */
403 int  get_idle_time __P((int, struct ppp_idle *));
404                                 /* Find out how long link has been idle */
405 int  get_ppp_stats __P((int, struct pppd_stats *));
406                                 /* Return link statistics */
407 int  sifvjcomp __P((int, int, int, int));
408                                 /* Configure VJ TCP header compression */
409 int  sifup __P((int));          /* Configure i/f up for one protocol */
410 int  sifnpmode __P((int u, int proto, enum NPmode mode));
411                                 /* Set mode for handling packets for proto */
412 int  sifdown __P((int));        /* Configure i/f down for one protocol */
413 int  sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t));
414                                 /* Configure IPv4 addresses for i/f */
415 int  cifaddr __P((int, u_int32_t, u_int32_t));
416                                 /* Reset i/f IP addresses */
417 #ifdef INET6
418 int  sif6addr __P((int, eui64_t, eui64_t));
419                                 /* Configure IPv6 addresses for i/f */
420 int  cif6addr __P((int, eui64_t, eui64_t));
421                                 /* Remove an IPv6 address from i/f */
422 #endif
423 int  sifdefaultroute __P((int, u_int32_t, u_int32_t));
424                                 /* Create default route through i/f */
425 int  cifdefaultroute __P((int, u_int32_t, u_int32_t));
426                                 /* Delete default route through i/f */
427 int  sifproxyarp __P((int, u_int32_t));
428                                 /* Add proxy ARP entry for peer */
429 int  cifproxyarp __P((int, u_int32_t));
430                                 /* Delete proxy ARP entry for peer */
431 u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */
432 int  lock __P((char *));        /* Create lock file for device */
433 int  relock __P((int));         /* Rewrite lock file with new pid */
434 void unlock __P((void));        /* Delete previously-created lock file */
435 void logwtmp __P((const char *, const char *, const char *));
436                                 /* Write entry to wtmp file */
437 int  get_host_seed __P((void)); /* Get host-dependent random number seed */
438 int  have_route_to __P((u_int32_t)); /* Check if route to addr exists */
439 #ifdef PPP_FILTER
440 int  set_filters __P((struct bpf_program *pass, struct bpf_program *active));
441                                 /* Set filter programs in kernel */
442 #endif
443 #ifdef IPX_CHANGE
444 int  sipxfaddr __P((int, unsigned long, unsigned char *));
445 int  cipxfaddr __P((int));
446 #endif
447
448 /* Procedures exported from options.c */
449 int  parse_args __P((int argc, char **argv));
450                                 /* Parse options from arguments given */
451 int  options_from_file __P((char *filename, int must_exist, int check_prot,
452                             int privileged));
453                                 /* Parse options from an options file */
454 int  options_from_user __P((void)); /* Parse options from user's .ppprc */
455 int  options_for_tty __P((void)); /* Parse options from /etc/ppp/options.tty */
456 int  options_from_list __P((struct wordlist *, int privileged));
457                                 /* Parse options from a wordlist */
458 int  getword __P((FILE *f, char *word, int *newlinep, char *filename));
459                                 /* Read a word from a file */
460 void option_error __P((char *fmt, ...));
461                                 /* Print an error message about an option */
462 int int_option __P((char *, int *));
463                                 /* Simplified number_option for decimal ints */
464 void add_options __P((option_t *)); /* Add extra options */
465
466 /*
467  * This structure is used to store information about certain
468  * options, such as where the option value came from (/etc/ppp/options,
469  * command line, etc.) and whether it came from a privileged source.
470  */
471
472 struct option_info {
473     int     priv;               /* was value set by sysadmin? */
474     char    *source;            /* where option came from */
475 };
476
477 extern struct option_info devnam_info;
478 extern struct option_info initializer_info;
479 extern struct option_info connect_script_info;
480 extern struct option_info disconnect_script_info;
481 extern struct option_info welcomer_info;
482 extern struct option_info ptycommand_info;
483
484 /*
485  * Hooks to enable plugins to change various things.
486  */
487 extern int (*new_phase_hook) __P((int));
488 extern int (*idle_time_hook) __P((struct ppp_idle *));
489 extern int (*holdoff_hook) __P((void));
490 extern int (*pap_check_hook) __P((void));
491 extern int (*pap_auth_hook) __P((char *user, char *passwd, char **msgp,
492                                  struct wordlist **paddrs,
493                                  struct wordlist **popts));
494 extern void (*pap_logout_hook) __P((void));
495 extern int (*pap_passwd_hook) __P((char *user, char *passwd));
496 extern void (*ip_up_hook) __P((void));
497 extern void (*ip_down_hook) __P((void));
498
499 /*
500  * Inline versions of get/put char/short/long.
501  * Pointer is advanced; we assume that both arguments
502  * are lvalues and will already be in registers.
503  * cp MUST be u_char *.
504  */
505 #define GETCHAR(c, cp) { \
506         (c) = *(cp)++; \
507 }
508 #define PUTCHAR(c, cp) { \
509         *(cp)++ = (u_char) (c); \
510 }
511
512
513 #define GETSHORT(s, cp) { \
514         (s) = *(cp)++ << 8; \
515         (s) |= *(cp)++; \
516 }
517 #define PUTSHORT(s, cp) { \
518         *(cp)++ = (u_char) ((s) >> 8); \
519         *(cp)++ = (u_char) (s); \
520 }
521
522 #define GETLONG(l, cp) { \
523         (l) = *(cp)++ << 8; \
524         (l) |= *(cp)++; (l) <<= 8; \
525         (l) |= *(cp)++; (l) <<= 8; \
526         (l) |= *(cp)++; \
527 }
528 #define PUTLONG(l, cp) { \
529         *(cp)++ = (u_char) ((l) >> 24); \
530         *(cp)++ = (u_char) ((l) >> 16); \
531         *(cp)++ = (u_char) ((l) >> 8); \
532         *(cp)++ = (u_char) (l); \
533 }
534
535 #define INCPTR(n, cp)   ((cp) += (n))
536 #define DECPTR(n, cp)   ((cp) -= (n))
537
538 /*
539  * System dependent definitions for user-level 4.3BSD UNIX implementation.
540  */
541
542 #define TIMEOUT(r, f, t)        timeout((r), (f), (t))
543 #define UNTIMEOUT(r, f)         untimeout((r), (f))
544
545 #define BCOPY(s, d, l)          memcpy(d, s, l)
546 #define BZERO(s, n)             memset(s, 0, n)
547
548 #define PRINTMSG(m, l)          { info("Remote message: %0.*v", l, m); }
549
550 /*
551  * MAKEHEADER - Add Header fields to a packet.
552  */
553 #define MAKEHEADER(p, t) { \
554     PUTCHAR(PPP_ALLSTATIONS, p); \
555     PUTCHAR(PPP_UI, p); \
556     PUTSHORT(t, p); }
557
558 /*
559  * Exit status values.
560  */
561 #define EXIT_OK                 0
562 #define EXIT_FATAL_ERROR        1
563 #define EXIT_OPTION_ERROR       2
564 #define EXIT_NOT_ROOT           3
565 #define EXIT_NO_KERNEL_SUPPORT  4
566 #define EXIT_USER_REQUEST       5
567 #define EXIT_LOCK_FAILED        6
568 #define EXIT_OPEN_FAILED        7
569 #define EXIT_CONNECT_FAILED     8
570 #define EXIT_PTYCMD_FAILED      9
571 #define EXIT_NEGOTIATION_FAILED 10
572 #define EXIT_PEER_AUTH_FAILED   11
573 #define EXIT_IDLE_TIMEOUT       12
574 #define EXIT_CONNECT_TIME       13
575 #define EXIT_CALLBACK           14
576 #define EXIT_PEER_DEAD          15
577 #define EXIT_HANGUP             16
578 #define EXIT_LOOPBACK           17
579 #define EXIT_INIT_FAILED        18
580 #define EXIT_AUTH_TOPEER_FAILED 19
581
582 /*
583  * Debug macros.  Slightly useful for finding bugs in pppd, not particularly
584  * useful for finding out why your connection isn't being established.
585  */
586 #ifdef DEBUGALL
587 #define DEBUGMAIN       1
588 #define DEBUGFSM        1
589 #define DEBUGLCP        1
590 #define DEBUGIPCP       1
591 #define DEBUGIPV6CP     1
592 #define DEBUGUPAP       1
593 #define DEBUGCHAP       1
594 #endif
595
596 #ifndef LOG_PPP                 /* we use LOG_LOCAL2 for syslog by default */
597 #if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \
598   || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \
599   || defined(DEBUGCHAP) || defined(DEBUG) || defined(DEBUGIPV6CP)
600 #define LOG_PPP LOG_LOCAL2
601 #else
602 #define LOG_PPP LOG_DAEMON
603 #endif
604 #endif /* LOG_PPP */
605
606 #ifdef DEBUGMAIN
607 #define MAINDEBUG(x)    if (debug) dbglog x
608 #else
609 #define MAINDEBUG(x)
610 #endif
611
612 #ifdef DEBUGSYS
613 #define SYSDEBUG(x)     if (debug) dbglog x
614 #else
615 #define SYSDEBUG(x)
616 #endif
617
618 #ifdef DEBUGFSM
619 #define FSMDEBUG(x)     if (debug) dbglog x
620 #else
621 #define FSMDEBUG(x)
622 #endif
623
624 #ifdef DEBUGLCP
625 #define LCPDEBUG(x)     if (debug) dbglog x
626 #else
627 #define LCPDEBUG(x)
628 #endif
629
630 #ifdef DEBUGIPCP
631 #define IPCPDEBUG(x)    if (debug) dbglog x
632 #else
633 #define IPCPDEBUG(x)
634 #endif
635
636 #ifdef DEBUGIPV6CP
637 #define IPV6CPDEBUG(x)  if (debug) dbglog x
638 #else
639 #define IPV6CPDEBUG(x)
640 #endif
641
642 #ifdef DEBUGUPAP
643 #define UPAPDEBUG(x)    if (debug) dbglog x
644 #else
645 #define UPAPDEBUG(x)
646 #endif
647
648 #ifdef DEBUGCHAP
649 #define CHAPDEBUG(x)    if (debug) dbglog x
650 #else
651 #define CHAPDEBUG(x)
652 #endif
653
654 #ifdef DEBUGIPXCP
655 #define IPXCPDEBUG(x)   if (debug) dbglog x
656 #else
657 #define IPXCPDEBUG(x)
658 #endif
659
660 #ifndef SIGTYPE
661 #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
662 #define SIGTYPE void
663 #else
664 #define SIGTYPE int
665 #endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */
666 #endif /* SIGTYPE */
667
668 #ifndef MIN
669 #define MIN(a, b)       ((a) < (b)? (a): (b))
670 #endif
671 #ifndef MAX
672 #define MAX(a, b)       ((a) > (b)? (a): (b))
673 #endif
674
675 #endif /* __PPP_H__ */