usr.sbin/ppp/datalink.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 1998 Brian Somers <brian@Awfulhak.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #define DATALINK_CLOSED  (0)
  32 #define DATALINK_OPENING (1)
  33 #define DATALINK_HANGUP  (2)
  34 #define DATALINK_DIAL    (3)
  35 #define DATALINK_CARRIER (4)
  36 #define DATALINK_LOGOUT  (5)
  37 #define DATALINK_LOGIN   (6)
  38 #define DATALINK_READY   (7)
  39 #define DATALINK_LCP     (8)
  40 #define DATALINK_AUTH    (9)
  41 #define DATALINK_CBCP    (10)
  42 #define DATALINK_OPEN    (11)
  43
  44 #define DATALINK_MAXNAME (20)   /* Maximum datalink::name length */
  45
  46 /* How to close the link */
  47 #define CLOSE_NORMAL            0
  48 #define CLOSE_STAYDOWN          1
  49 #define CLOSE_LCP               2
  50
  51 struct iovec;
  52 struct prompt;
  53 struct physical;
  54 struct bundle;
  55
  56 struct datalink {
  57   struct fdescriptor desc;      /* We play either a physical or a chat */
  58   unsigned state;               /* Our DATALINK_* state */
  59   struct physical *physical;    /* Our link */
  60
  61   struct chat chat;             /* For bringing the link up & down */
  62
  63   unsigned stayonline : 1;      /* stay online when LCP is closed ? */
  64   struct {
  65     unsigned run : 1;           /* run scripts ? */
  66     unsigned packetmode : 1;    /* Go into packet mode after login ? */
  67   } script;
  68
  69   struct {
  70     struct {
  71       char dial[SCRIPT_LEN];
  72       char login[SCRIPT_LEN];
  73       char logout[SCRIPT_LEN];
  74       char hangup[SCRIPT_LEN];
  75     } script;                   /* various chat scripts */
  76     struct {
  77       char list[SCRIPT_LEN];    /* Telephone Numbers */
  78     } phone;
  79     struct {
  80       int max;                  /* initially try again this number of times */
  81       int next_timeout;         /* Redial next timeout value */
  82       int inc;                  /* Increment timeout by `inc' each time read */
  83       int maxinc;               /* Maximum number of increments */
  84       int timeout;              /* Redial timeout value (end of phone list) */
  85     } dial;
  86     struct {
  87       int max;                  /* initially try again this number of times */
  88       int timeout;              /* Timeout before reconnect on carrier loss */
  89     } reconnect;
  90     struct callback callback;   /* Direction depends on physical type */
  91     struct cbcpcfg cbcp;        /* Direction depends on phys type & callback */
  92   } cfg;                        /* All our config data is in here */
  93
  94   struct {
  95     char list[SCRIPT_LEN];      /* copy of cfg.list for strsep() */
  96     char *next;                 /* Next phone from the list */
  97     char *alt;                  /* Alternate (after fail) phone from the list */
  98     const char *chosen;         /* Chosen phone number after DIAL */
  99   } phone;
 100
 101   struct cbcp cbcp;
 102
 103   struct {
 104     struct pppTimer timer;      /* For timing between close & open */
 105     int tries;                  /* currently try again this number of times */
 106     int incs;                   /* # times our timeout has been incremented */
 107   } dial;
 108
 109   unsigned reconnect_tries;     /* currently try again this number of times */
 110
 111   char *name;                   /* Our name */
 112
 113   struct peerid peer;           /* Peer identification */
 114
 115   struct fsm_parent fsmp;          /* Our callback functions */
 116   const struct fsm_parent *parent; /* Our parent */
 117
 118   struct authinfo pap;             /* Authentication using pap */
 119   struct chap chap;                /* Authentication using chap */
 120
 121   struct mp_link mp;               /* multilink data */
 122
 123   struct bundle *bundle;           /* for the moment */
 124   struct datalink *next;           /* Next in the list */
 125 };
 126
 127 #define descriptor2datalink(d) \
 128   ((d)->type == DATALINK_DESCRIPTOR ? (struct datalink *)(d) : NULL)
 129
 130 extern struct datalink *datalink_Create(const char *name, struct bundle *, int);
 131 extern struct datalink *datalink_Clone(struct datalink *, const char *);
 132 extern struct datalink *iov2datalink(struct bundle *, struct iovec *, int *,
 133                                      int, int, int *, int *);
 134 extern int datalink2iov(struct datalink *, struct iovec *, int *, int, int *,
 135                         int *);
 136 extern struct datalink *datalink_Destroy(struct datalink *);
 137 extern void datalink_GotAuthname(struct datalink *, const char *);
 138 extern void datalink_Up(struct datalink *, int, int);
 139 extern void datalink_Close(struct datalink *, int);
 140 extern void datalink_Down(struct datalink *, int);
 141 extern void datalink_StayDown(struct datalink *);
 142 extern void datalink_DontHangup(struct datalink *);
 143 extern void datalink_AuthOk(struct datalink *);
 144 extern void datalink_AuthNotOk(struct datalink *);
 145 extern void datalink_NCPUp(struct datalink *);
 146 extern void datalink_CBCPComplete(struct datalink *);
 147 extern void datalink_CBCPFailed(struct datalink *);
 148 extern int datalink_Show(struct cmdargs const *);
 149 extern int datalink_SetRedial(struct cmdargs const *);
 150 extern int datalink_SetReconnect(struct cmdargs const *);
 151 extern const char *datalink_State(struct datalink *);
 152 extern void datalink_Rename(struct datalink *, const char *);
 153 extern int datalink_RemoveFromSet(struct datalink *, fd_set *, fd_set *,
 154                                   fd_set *);
 155 extern int datalink_SetMode(struct datalink *, int);
 156 extern int datalink_GetDialTimeout(struct datalink *);
 157 extern const char *datalink_ChoosePhoneNumber(struct datalink *);
 158 extern void datalink_ComeDown(struct datalink *, int);