]> git.ozlabs.org Git - ppp.git/blobdiff - pppd/pppd.h
Rework options processing stuff to implement option priorities
[ppp.git] / pppd / pppd.h
index 15a503cbd5b341791169d94f6606c57ffa4a23d8..f33c0fb944b44c66f50874414208e6df41d72cee 100644 (file)
@@ -16,7 +16,7 @@
  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  *
- * $Id: pppd.h,v 1.47 1999/09/08 01:13:45 masputra Exp $
+ * $Id: pppd.h,v 1.57 2001/02/22 03:15:21 paulus Exp $
  */
 
 /*
@@ -70,6 +70,7 @@ enum opt_type {
        o_int,
        o_uint32,
        o_string,
+       o_wild,
 };
 
 typedef struct {
@@ -81,6 +82,8 @@ typedef struct {
        void    *addr2;
        int     upper_limit;
        int     lower_limit;
+       const char *source;
+       int     priority;
 } option_t;
 
 /* Values for flags */
@@ -97,17 +100,23 @@ typedef struct {
 #define OPT_ZEROOK     0x10000 /* 0 value is OK even if not within limits */
 #define OPT_NOINCR     0x20000 /* value mustn't be increased */
 #define OPT_ZEROINF    0x40000 /* with OPT_NOINCR, 0 == infinity */
-#define OPT_A2INFO     0x100000 /* addr2 -> option_info to update */
+#define OPT_MULTIPART  0x80000 /* optionally sets multiple variables */
 #define OPT_A2COPY     0x200000 /* addr2 -> second location to rcv value */
 #define OPT_ENABLE     0x400000 /* use *addr2 as enable for option */
-#define OPT_PRIVFIX    0x800000 /* can't be overridden if noauth */
-#define OPT_PREPASS    0x1000000 /* do this opt in pre-pass to find device */
+#define OPT_PRIVFIX    0x800000 /* user can't override if set by root */
 #define OPT_INITONLY   0x2000000 /* option can only be set in init phase */
 #define OPT_DEVEQUIV   0x4000000 /* equiv to device name */
-#define OPT_DEVNAM     (OPT_PREPASS | OPT_INITONLY | OPT_DEVEQUIV)
+#define OPT_DEVNAM     (OPT_INITONLY | OPT_DEVEQUIV)
 
 #define OPT_VAL(x)     ((x) & OPT_VALUE)
 
+/* Values for priority */
+#define OPRIO_DEFAULT  0       /* a default value */
+#define OPRIO_CFGFILE  1       /* value from a configuration file */
+#define OPRIO_CMDLINE  2       /* value from the command line */
+#define OPRIO_SECFILE  3       /* value from options in a secrets file */
+#define OPRIO_ROOT     100     /* added to priority if OPT_PRIVFIX && root */
+
 #ifndef GIDSET_TYPE
 #define GIDSET_TYPE    gid_t
 #endif
@@ -136,6 +145,30 @@ struct wordlist {
     char               *word;
 };
 
+/* An endpoint discriminator, used with multilink. */
+#define MAX_ENDP_LEN   20      /* maximum length of discriminator value */
+struct epdisc {
+    unsigned char      class;
+    unsigned char      length;
+    unsigned char      value[MAX_ENDP_LEN];
+};
+
+/* values for epdisc.class */
+#define EPD_NULL       0       /* null discriminator, no data */
+#define EPD_LOCAL      1
+#define EPD_IP         2
+#define EPD_MAC                3
+#define EPD_MAGIC      4
+#define EPD_PHONENUM   5
+
+typedef void (*notify_func) __P((void *, int));
+
+struct notifier {
+    struct notifier *next;
+    notify_func            func;
+    void           *arg;
+};
+
 /*
  * Global variables.
  */
@@ -143,7 +176,6 @@ struct wordlist {
 extern int     hungup;         /* Physical layer has disconnected */
 extern int     ifunit;         /* Interface unit number */
 extern char    ifname[];       /* Interface name */
-extern int     ttyfd;          /* Serial device file descriptor */
 extern char    hostname[];     /* Our hostname */
 extern u_char  outpacket_buf[]; /* Buffer for outgoing packets */
 extern int     phase;          /* Current state of link - see values below */
@@ -159,12 +191,29 @@ extern GIDSET_TYPE groups[NGROUPS_MAX];   /* groups the user is in */
 extern int     ngroups;        /* How many groups valid in groups */
 extern struct pppd_stats link_stats; /* byte/packet counts etc. for link */
 extern int     link_stats_valid; /* set if link_stats is valid */
+extern int     link_connect_time; /* time the link was up for */
 extern int     using_pty;      /* using pty as device (notty or pty opt.) */
 extern int     log_to_fd;      /* logging to this fd as well as syslog */
+extern bool    log_to_file;    /* log_to_fd is a file */
+extern bool    log_to_specific_fd;     /* log_to_fd was specified by user */
 extern char    *no_ppp_msg;    /* message to print if ppp not in kernel */
 extern volatile int status;    /* exit status for pppd */
-extern int     devnam_fixed;   /* can no longer change devnam */
+extern bool    devnam_fixed;   /* can no longer change devnam */
 extern int     unsuccess;      /* # unsuccessful connection attempts */
+extern int     do_callback;    /* set if we want to do callback next */
+extern int     doing_callback; /* set if this is a callback */
+extern char    ppp_devnam[MAXPATHLEN];
+extern struct notifier *pidchange;   /* for notifications of pid changing */
+extern struct notifier *phasechange; /* for notifications of phase changes */
+extern struct notifier *exitnotify;  /* for notification that we're exiting */
+extern struct notifier *sigreceived; /* notification of received signal */
+extern int     listen_time;    /* time to listen first (ms) */
+extern char    *current_option; /* option we're processing now */
+extern int     option_priority; /* priority of current options */
+
+/* Values for do_callback and doing_callback */
+#define CALLBACK_DIALIN                1       /* we are expecting the call back */
+#define CALLBACK_DIALOUT       2       /* we are dialling out to call back */
 
 /*
  * Variables set by command-line options.
@@ -182,8 +231,8 @@ extern bool lockflag;       /* Create lock file to lock the serial dev */
 extern bool    nodetach;       /* Don't detach from controlling tty */
 extern bool    updetach;       /* Detach from controlling tty when link up */
 extern char    *initializer;   /* Script to initialize physical link */
-extern char    *connector;     /* Script to establish physical link */
-extern char    *disconnector;  /* Script to disestablish physical link */
+extern char    *connect_script; /* Script to establish physical link */
+extern char    *disconnect_script; /* Script to disestablish physical link */
 extern char    *welcomer;      /* Script to welcome client after connection */
 extern char    *ptycommand;    /* Command to run on other side of pty */
 extern int     maxconnect;     /* Maximum connect time (seconds) */
@@ -200,11 +249,20 @@ extern char       *ipparam;       /* Extra parameter for ip up/down scripts */
 extern bool    cryptpap;       /* Others' PAP passwords are encrypted */
 extern int     idle_time_limit;/* Shut down link if idle for this long */
 extern int     holdoff;        /* Dead time before restarting */
+extern bool    holdoff_specified; /* true if user gave a holdoff value */
 extern bool    notty;          /* Stdin/out is not a tty */
+extern char    *pty_socket;    /* Socket to connect to pty */
 extern char    *record_file;   /* File to record chars sent/received */
 extern bool    sync_serial;    /* Device is synchronous serial device */
 extern int     maxfail;        /* Max # of unsuccessful connection attempts */
 extern char    linkname[MAXPATHLEN]; /* logical name for link */
+extern bool    tune_kernel;    /* May alter kernel settings as necessary */
+extern int     connect_delay;  /* Time to delay after connect script */
+extern int     max_data_rate;  /* max bytes/sec through charshunt */
+extern int     req_unit;       /* interface unit number to use */
+extern bool    multilink;      /* enable multilink operation */
+extern bool    noendpoint;     /* don't send or accept endpt. discrim. */
+extern char    *bundle_name;   /* bundle name for multilink */
 
 #ifdef PPP_FILTER
 extern struct  bpf_program pass_filter;   /* Filter for pkts to pass */
@@ -231,8 +289,10 @@ extern char *option_source;        /* string saying where the option came from */
 #define PHASE_AUTHENTICATE     5
 #define PHASE_CALLBACK         6
 #define PHASE_NETWORK          7
-#define PHASE_TERMINATE                8
-#define PHASE_HOLDOFF          9
+#define PHASE_RUNNING          8
+#define PHASE_TERMINATE                9
+#define PHASE_DISCONNECT       10
+#define PHASE_HOLDOFF          11
 
 /*
  * The following struct gives the addresses of procedures to call
@@ -280,21 +340,38 @@ extern struct protent *protocols[];
  */
 
 /* Procedures exported from main.c. */
+void set_ifunit __P((int));    /* set stuff that depends on ifunit */
 void detach __P((void));       /* Detach from controlling tty */
 void die __P((int));           /* Cleanup and exit */
 void quit __P((void));         /* like die(1) */
 void novm __P((char *));       /* Say we ran out of memory, and die */
-void timeout __P((void (*func)(void *), void *arg, int t));
-                               /* Call func(arg) after t seconds */
+void timeout __P((void (*func)(void *), void *arg, int s, int us));
+                               /* Call func(arg) after s.us seconds */
 void untimeout __P((void (*func)(void *), void *arg));
                                /* Cancel call to func(arg) */
+void record_child __P((int, char *, void (*) (void *), void *));
+int  device_script __P((char *cmd, int in, int out, int dont_wait));
+                               /* Run `cmd' with given stdin and stdout */
 pid_t run_program __P((char *prog, char **args, int must_exist,
                       void (*done)(void *), void *arg));
                                /* Run program prog with args in child */
 void reopen_log __P((void));   /* (re)open the connection to syslog */
 void update_link_stats __P((int)); /* Get stats at link termination */
-void script_setenv __P((char *, char *));      /* set script env var */
+void script_setenv __P((char *, char *, int)); /* set script env var */
 void script_unsetenv __P((char *));            /* unset script env var */
+void new_phase __P((int));     /* signal start of new phase */
+void add_notifier __P((struct notifier **, notify_func, void *));
+void remove_notifier __P((struct notifier **, notify_func, void *));
+void notify __P((struct notifier *, int));
+
+/* Procedures exported from tty.c. */
+void tty_init __P((void));
+void tty_device_check __P((void));
+void tty_check_options __P((void));
+int  connect_tty __P((void));
+void disconnect_tty __P((void));
+void tty_close_fds __P((void));
+void cleanup_tty __P((void));
 
 /* Procedures exported from utils.c. */
 void log_packet __P((u_char *, int, char *, int));
@@ -332,7 +409,7 @@ void auth_withpeer_success __P((int, int));
 void auth_check_options __P((void));
                                /* check authentication options supplied */
 void auth_reset __P((int));    /* check what secrets we have */
-int  check_passwd __P((int, char *, int, char *, int, char **, int *));
+int  check_passwd __P((int, char *, int, char *, int, char **));
                                /* Check peer-supplied username/password */
 int  get_secret __P((int, char *, char *, char *, int *, int));
                                /* get "secret" for chap */
@@ -350,6 +427,12 @@ void demand_rexmit __P((int));     /* retransmit saved frames for an NP */
 int  loop_chars __P((unsigned char *, int)); /* process chars from loopback */
 int  loop_frame __P((unsigned char *, int)); /* should we bring link up? */
 
+/* Procedures exported from multilink.c */
+void mp_check_options __P((void)); /* Check multilink-related options */
+int  mp_join_bundle __P((void));  /* join our link to an appropriate bundle */
+char *epdisc_to_str __P((struct epdisc *)); /* string from endpoint discrim. */
+int  str_to_epdisc __P((struct epdisc *, char *)); /* endpt disc. from str */
+
 /* Procedures exported from sys-*.c */
 void sys_init __P((void));     /* Do system-dependent initialization */
 void sys_cleanup __P((void));  /* Restore system state before exiting */
@@ -361,6 +444,9 @@ int  open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
 int  establish_ppp __P((int)); /* Turn serial port into a ppp interface */
 void restore_loop __P((void)); /* Transfer ppp unit back to loopback */
 void disestablish_ppp __P((int)); /* Restore port to normal operation */
+void make_new_bundle __P((int, int, int, int)); /* Create new bundle */
+int  bundle_attach __P((int)); /* Attach link to existing bundle */
+void cfg_bundle __P((int, int, int, int)); /* Configure existing bundle */
 void clean_check __P((void));  /* Check if line was 8-bit clean */
 void set_up_tty __P((int, int)); /* Set up port's speed, parameters, etc. */
 void restore_tty __P((int));   /* Restore port's original parameters */
@@ -427,6 +513,8 @@ int  set_filters __P((struct bpf_program *pass, struct bpf_program *active));
 int  sipxfaddr __P((int, unsigned long, unsigned char *));
 int  cipxfaddr __P((int));
 #endif
+int  get_if_hwaddr __P((u_char *addr, char *name));
+char *get_first_ethernet __P((void));
 
 /* Procedures exported from options.c */
 int  parse_args __P((int argc, char **argv));
@@ -444,24 +532,25 @@ void option_error __P((char *fmt, ...));
                                /* Print an error message about an option */
 int int_option __P((char *, int *));
                                /* Simplified number_option for decimal ints */
+void add_options __P((option_t *)); /* Add extra options */
+
+int parse_dotted_ip __P((char *, u_int32_t *));
 
 /*
- * This structure is used to store information about certain
- * options, such as where the option value came from (/etc/ppp/options,
- * command line, etc.) and whether it came from a privileged source.
+ * Hooks to enable plugins to change various things.
  */
-
-struct option_info {
-    int            priv;               /* was value set by sysadmin? */
-    char    *source;           /* where option came from */
-};
-
-extern struct option_info devnam_info;
-extern struct option_info initializer_info;
-extern struct option_info connector_info;
-extern struct option_info disconnector_info;
-extern struct option_info welcomer_info;
-extern struct option_info ptycommand_info;
+extern int (*new_phase_hook) __P((int));
+extern int (*idle_time_hook) __P((struct ppp_idle *));
+extern int (*holdoff_hook) __P((void));
+extern int (*pap_check_hook) __P((void));
+extern int (*pap_auth_hook) __P((char *user, char *passwd, char **msgp,
+                                struct wordlist **paddrs,
+                                struct wordlist **popts));
+extern void (*pap_logout_hook) __P((void));
+extern int (*pap_passwd_hook) __P((char *user, char *passwd));
+extern void (*ip_up_hook) __P((void));
+extern void (*ip_down_hook) __P((void));
+extern void (*ip_choose_hook) __P((u_int32_t *));
 
 /*
  * Inline versions of get/put char/short/long.
@@ -506,7 +595,7 @@ extern struct option_info ptycommand_info;
  * System dependent definitions for user-level 4.3BSD UNIX implementation.
  */
 
-#define TIMEOUT(r, f, t)       timeout((r), (f), (t))
+#define TIMEOUT(r, f, t)       timeout((r), (f), (t), 0)
 #define UNTIMEOUT(r, f)                untimeout((r), (f))
 
 #define BCOPY(s, d, l)         memcpy(d, s, l)