]> git.ozlabs.org Git - ppp.git/blobdiff - pppd/pppd.h
Merge branch 'master' of https://github.com/gburgessiv/ppp
[ppp.git] / pppd / pppd.h
index 8dd3fc6617a72e6dc5798a091410d5fdbde99ce7..1a1bf0b99582fa323cb0ee587d79c248642a7896 100644 (file)
@@ -39,7 +39,7 @@
  * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  *
- * $Id: pppd.h,v 1.78 2002/12/04 23:03:32 paulus Exp $
+ * $Id: pppd.h,v 1.96 2008/06/23 11:47:18 paulus Exp $
  */
 
 /*
 #define MAXARGS                1       /* max # args to a command */
 #define MAXNAMELEN     256     /* max length of hostname or name for auth */
 #define MAXSECRETLEN   256     /* max length of password or secret */
+#define MAXIFNAMELEN   32      /* max length of interface name; or use IFNAMSIZ, can we
+                                  always include net/if.h? */
+
+/*
+ * If PPP_DRV_NAME is not defined, use the default "ppp" as the device name.
+ * Where should PPP_DRV_NAME come from? Do we include it here?
+ */
+#if !defined(PPP_DRV_NAME)
+#define PPP_DRV_NAME   "ppp"
+#endif /* !defined(PPP_DRV_NAME) */
 
 /*
  * Option descriptor structure.
@@ -109,26 +119,25 @@ typedef struct {
        const char *source;
        short int priority;
        short int winner;
-       void    *addr3;
 } option_t;
 
 /* Values for flags */
 #define OPT_VALUE      0xff    /* mask for presupplied value */
 #define OPT_HEX                0x100   /* int option is in hex */
 #define OPT_NOARG      0x200   /* option doesn't take argument */
-#define OPT_OR         0x400   /* OR in argument to value */
-#define OPT_INC                0x800   /* increment value */
+#define OPT_OR         0x400   /* for u32, OR in argument to value */
+#define OPT_INC                0x400   /* for o_int, increment value */
 #define OPT_A2OR       0x800   /* for o_bool, OR arg to *(u_char *)addr2 */
 #define OPT_PRIV       0x1000  /* privileged option */
 #define OPT_STATIC     0x2000  /* string option goes into static array */
+#define OPT_NOINCR     0x2000  /* for o_int, value mustn't be increased */
 #define OPT_LLIMIT     0x4000  /* check value against lower limit */
 #define OPT_ULIMIT     0x8000  /* check value against upper limit */
 #define OPT_LIMITS     (OPT_LLIMIT|OPT_ULIMIT)
 #define OPT_ZEROOK     0x10000 /* 0 value is OK even if not within limits */
 #define OPT_HIDE       0x10000 /* for o_string, print value as ?????? */
-#define OPT_A2LIST     0x10000 /* for o_special, keep list of values */
-#define OPT_A2CLRB     0x10000 /* o_bool, clr val bits in *(u_char *)addr2 */
-#define OPT_NOINCR     0x20000 /* value mustn't be increased */
+#define OPT_A2LIST     0x20000 /* for o_special, keep list of values */
+#define OPT_A2CLRB     0x20000 /* o_bool, clr val bits in *(u_char *)addr2 */
 #define OPT_ZEROINF    0x40000 /* with OPT_NOINCR, 0 == infinity */
 #define OPT_PRIO       0x80000 /* process option priorities for this option */
 #define OPT_PRIOSUB    0x100000 /* subsidiary member of priority group */
@@ -140,7 +149,7 @@ typedef struct {
 #define OPT_INITONLY   0x4000000 /* option can only be set in init phase */
 #define OPT_DEVEQUIV   0x8000000 /* equiv to device name */
 #define OPT_DEVNAM     (OPT_INITONLY | OPT_DEVEQUIV)
-#define OPT_A2PRINTER  0x10000000 /* *addr2 is a fn for printing option */
+#define OPT_A2PRINTER  0x10000000 /* *addr2 printer_func to print option */
 #define OPT_A2STRVAL   0x20000000 /* *addr2 points to current string value */
 #define OPT_NOPRINT    0x40000000 /* don't print this option at all */
 
@@ -200,6 +209,7 @@ struct epdisc {
 #define EPD_PHONENUM   5
 
 typedef void (*notify_func) __P((void *, int));
+typedef void (*printer_func) __P((void *, char *, ...));
 
 struct notifier {
     struct notifier *next;
@@ -216,6 +226,8 @@ extern int  ifunit;         /* Interface unit number */
 extern char    ifname[];       /* Interface name */
 extern char    hostname[];     /* Our hostname */
 extern u_char  outpacket_buf[]; /* Buffer for outgoing packets */
+extern int     devfd;          /* fd of underlying device */
+extern int     fd_ppp;         /* fd for talking PPP */
 extern int     phase;          /* Current state of link - see values below */
 extern int     baud_rate;      /* Current link speed in bits/sec */
 extern char    *progname;      /* Name of this program */
@@ -240,19 +252,29 @@ 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 int     error_count;    /* # of times error() has been called */
 extern char    ppp_devnam[MAXPATHLEN];
 extern char     remote_number[MAXNAMELEN]; /* Remote telephone number, if avail. */
 extern int      ppp_session_number; /* Session number (eg PPPoE session) */
+extern int     fd_devnull;     /* fd open to /dev/null */
 
 extern int     listen_time;    /* time to listen first (ms) */
+extern bool    doing_multilink;
+extern bool    multilink_master;
+extern bool    bundle_eof;
+extern bool    bundle_terminating;
+
 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 struct notifier *ip_up_notifier; /* IPCP has come up */
-extern struct notifier *ip_down_notifier; /* IPCP has gone down */
+extern struct notifier *ip_up_notifier;     /* IPCP has come up */
+extern struct notifier *ip_down_notifier;   /* IPCP has gone down */
+extern struct notifier *ipv6_up_notifier;   /* IPV6CP has come up */
+extern struct notifier *ipv6_down_notifier; /* IPV6CP has gone down */
 extern struct notifier *auth_up_notifier; /* peer has authenticated */
 extern struct notifier *link_down_notifier; /* link has gone down */
+extern struct notifier *fork_notifier; /* we are a new child process */
 
 /* Values for do_callback and doing_callback */
 #define CALLBACK_DIALIN                1       /* we are expecting the call back */
@@ -267,12 +289,14 @@ extern int        kdebugflag;     /* Tell kernel to print debug messages */
 extern int     default_device; /* Using /dev/tty or equivalent */
 extern char    devnam[MAXPATHLEN];     /* Device name */
 extern int     crtscts;        /* Use hardware flow control */
+extern int     stop_bits;      /* Number of serial port stop bits */
 extern bool    modem;          /* Use modem control lines */
 extern int     inspeed;        /* Input/Output speed requested */
 extern u_int32_t netmask;      /* IP netmask to set on interface */
 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 bool    master_detach;  /* Detach when multilink master without link */
 extern char    *initializer;   /* Script to initialize physical link */
 extern char    *connect_script; /* Script to establish physical link */
 extern char    *disconnect_script; /* Script to disestablish physical link */
@@ -284,6 +308,7 @@ extern char passwd[MAXSECRETLEN];   /* Password for PAP or CHAP */
 extern bool    auth_required;  /* Peer is required to authenticate */
 extern bool    persist;        /* Reopen link after it goes down */
 extern bool    uselogin;       /* Use /etc/passwd for checking PAP */
+extern bool    session_mgmt;   /* Do session management (login records) */
 extern char    our_name[MAXNAMELEN];/* Our name for authentication purposes */
 extern char    remote_name[MAXNAMELEN]; /* Peer's name for authentication */
 extern bool    explicit_remote;/* remote_name specified with remotename opt */
@@ -303,11 +328,13 @@ 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 char    req_ifname[MAXIFNAMELEN]; /* interface name 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 */
 extern bool    dump_options;   /* print out option values */
 extern bool    dryrun;         /* check everything, print options, exit */
+extern int     child_wait;     /* # seconds to wait for children at end */
 
 #ifdef MAXOCTETS
 extern unsigned int maxoctets;      /* Maximum octetes per session (in bytes) */
@@ -346,13 +373,11 @@ extern bool       ms_lanman;      /* Use LanMan password instead of NT */
 /* Values for auth_done only */
 #define CHAP_MD5_WITHPEER      0x40
 #define CHAP_MD5_PEER          0x80
-#ifdef CHAPMS
 #define CHAP_MS_SHIFT          8       /* LSB position for MS auths */
 #define CHAP_MS_WITHPEER       0x100
 #define CHAP_MS_PEER           0x200
 #define CHAP_MS2_WITHPEER      0x400
 #define CHAP_MS2_PEER          0x800
-#endif
 
 extern char *current_option;   /* the name of the option being parsed */
 extern int  privileged_option; /* set iff the current option came from root */
@@ -374,6 +399,7 @@ extern int  option_priority;        /* priority of current options */
 #define PHASE_TERMINATE                9
 #define PHASE_DISCONNECT       10
 #define PHASE_HOLDOFF          11
+#define PHASE_MASTER           12
 
 /*
  * The following struct gives the addresses of procedures to call
@@ -396,8 +422,7 @@ struct protent {
     /* Close the protocol */
     void (*close) __P((int unit, char *reason));
     /* Print a packet in readable form */
-    int  (*printpkt) __P((u_char *pkt, int len,
-                         void (*printer) __P((void *, char *, ...)),
+    int  (*printpkt) __P((u_char *pkt, int len, printer_func printer,
                          void *arg));
     /* Process a received data packet */
     void (*datainput) __P((int unit, u_char *pkt, int len));
@@ -450,17 +475,20 @@ struct channel {
 
 extern struct channel *the_channel;
 
-#define ppp_send_config(unit, mtu, accm, pc, acc)                       \
-do {                                                                    \
-       if (the_channel->send_config)                                    \
-               (*the_channel->send_config)((mtu), (accm), (pc), (acc)); \
-} while (0)
+/*
+ * This structure contains environment variables that are set or unset
+ * by the user.
+ */
+struct userenv {
+       struct userenv *ue_next;
+       char *ue_value;         /* value (set only) */
+       bool ue_isset;          /* 1 for set, 0 for unset */
+       bool ue_priv;           /* from privileged source */
+       const char *ue_source;  /* source name */
+       char ue_name[1];        /* variable name */
+};
 
-#define ppp_recv_config(unit, mtu, accm, pc, acc)                       \
-do {                                                                    \
-       if (the_channel->send_config)                                    \
-               (*the_channel->recv_config)((mtu), (accm), (pc), (acc)); \
-} while (0)
+extern struct userenv *userenv_list;
 
 /*
  * Prototypes.
@@ -476,13 +504,16 @@ 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 *));
+void record_child __P((int, char *, void (*) (void *), void *, int));
+pid_t safe_fork __P((int, int, int));  /* Fork & close stuff in child */
 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));
+                      void (*done)(void *), void *arg, int wait));
                                /* Run program prog with args in child */
 void reopen_log __P((void));   /* (re)open the connection to syslog */
+void print_link_stats __P((void)); /* Print stats, if available */
+void reset_link_stats __P((int)); /* Reset (init) stats when link goes up */
 void update_link_stats __P((int)); /* Get stats at link termination */
 void script_setenv __P((char *, char *, int)); /* set script env var */
 void script_unsetenv __P((char *));            /* unset script env var */
@@ -490,6 +521,12 @@ 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));
+int  ppp_send_config __P((int, int, u_int32_t, int, int));
+int  ppp_recv_config __P((int, int, u_int32_t, int, int));
+const char *protocol_name __P((int));
+void remove_pidfiles __P((void));
+void lock_db __P((void));
+void unlock_db __P((void));
 
 /* Procedures exported from tty.c. */
 void tty_init __P((void));
@@ -497,8 +534,8 @@ void tty_init __P((void));
 /* Procedures exported from utils.c. */
 void log_packet __P((u_char *, int, char *, int));
                                /* Format a packet and log it with syslog */
-void print_string __P((char *, int,  void (*) (void *, char *, ...),
-               void *));       /* Format a string for output */
+void print_string __P((char *, int,  printer_func, void *));
+                               /* Format a string for output */
 int slprintf __P((char *, int, char *, ...));          /* sprintf++ */
 int vslprintf __P((char *, int, char *, va_list));     /* vsprintf++ */
 size_t strlcpy __P((char *, const char *, size_t));    /* safe strcpy */
@@ -509,16 +546,20 @@ void notice __P((char *, ...));   /* log a notice-level message */
 void warn __P((char *, ...));  /* log a warning message */
 void error __P((char *, ...)); /* log an error message */
 void fatal __P((char *, ...)); /* log an error message and die(1) */
-void init_pr_log __P((char *, int));   /* initialize for using pr_log */
+void init_pr_log __P((const char *, int)); /* initialize for using pr_log */
 void pr_log __P((void *, char *, ...));        /* printer fn, output to syslog */
 void end_pr_log __P((void));   /* finish up after using pr_log */
 void dump_packet __P((const char *, u_char *, int));
                                /* dump packet to debug log if interesting */
+ssize_t complete_read __P((int, void *, size_t));
+                               /* read a complete buffer */
 
 /* Procedures exported from auth.c */
 void link_required __P((int));   /* we are starting to use the link */
+void start_link __P((int));      /* bring the link up now */
 void link_terminated __P((int));  /* we are finished with the link */
 void link_down __P((int));       /* the LCP layer has left the Opened state */
+void upper_layers_down __P((int));/* take all NCPs down */
 void link_established __P((int)); /* the link is up; authenticate now */
 void start_networks __P((int));   /* start all the network control protos */
 void continue_networks __P((int)); /* start network [ip, etc] control protos */
@@ -558,10 +599,19 @@ 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 */
+#ifdef HAVE_MULTILINK
 void mp_check_options __P((void)); /* Check multilink-related options */
 int  mp_join_bundle __P((void));  /* join our link to an appropriate bundle */
+void mp_exit_bundle __P((void));  /* have disconnected our link from bundle */
+void mp_bundle_terminated __P((void));
 char *epdisc_to_str __P((struct epdisc *)); /* string from endpoint discrim. */
 int  str_to_epdisc __P((struct epdisc *, char *)); /* endpt disc. from str */
+#else
+#define mp_bundle_terminated() /* nothing */
+#define mp_exit_bundle()       /* nothing */
+#define doing_multilink                0
+#define multilink_master       0
+#endif
 
 /* Procedures exported from sys-*.c */
 void sys_init __P((void));     /* Do system-dependent initialization */
@@ -578,6 +628,7 @@ int  generic_establish_ppp __P((int dev_fd)); /* Make a ppp interface */
 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 destroy_bundle __P((void)); /* Tell driver to destroy 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 */
@@ -617,6 +668,9 @@ int  sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t));
 int  cifaddr __P((int, u_int32_t, u_int32_t));
                                /* Reset i/f IP addresses */
 #ifdef INET6
+int  ether_to_eui64(eui64_t *p_eui64); /* convert eth0 hw address to EUI64 */
+int  sif6up __P((int));                /* Configure i/f up for IPv6 */
+int  sif6down __P((int));      /* Configure i/f down for IPv6 */
 int  sif6addr __P((int, eui64_t, eui64_t));
                                /* Configure IPv6 addresses for i/f */
 int  cif6addr __P((int, eui64_t, eui64_t));
@@ -670,7 +724,7 @@ void add_options __P((option_t *)); /* Add extra options */
 void check_options __P((void));        /* check values after all options parsed */
 int  override_value __P((const char *, int, const char *));
                                /* override value if permitted by priority */
-void print_options __P((void (*) __P((void *, char *, ...)), void *));
+void print_options __P((printer_func, void *));
                                /* print out values of all options */
 
 int parse_dotted_ip __P((char *, u_int32_t *));
@@ -691,9 +745,12 @@ extern int (*allowed_address_hook) __P((u_int32_t addr));
 extern void (*ip_up_hook) __P((void));
 extern void (*ip_down_hook) __P((void));
 extern void (*ip_choose_hook) __P((u_int32_t *));
+extern void (*ipv6_up_hook) __P((void));
+extern void (*ipv6_down_hook) __P((void));
 
 extern int (*chap_check_hook) __P((void));
 extern int (*chap_passwd_hook) __P((char *user, char *passwd));
+extern void (*multilink_join_hook) __P((void));
 
 /* Let a plugin snoop sent and received packets.  Useful for L2TP */
 extern void (*snoop_recv_hook) __P((unsigned char *p, int len));