]> git.ozlabs.org Git - ppp.git/blobdiff - pppd/fsm.c
Merge branch 'master' of https://github.com/gburgessiv/ppp
[ppp.git] / pppd / fsm.c
index a24c7c9116e23cb749a1b64e95ef2f42b49a8b65..e9bd34f0e8f48fd0da69e4ffea3349691975f435 100644 (file)
@@ -1,25 +1,46 @@
 /*
  * fsm.c - {Link, IP} Control Protocol Finite State Machine.
  *
- * Copyright (c) 1989 Carnegie Mellon University.
- * All rights reserved.
+ * Copyright (c) 1984-2000 Carnegie Mellon University. All rights reserved.
  *
- * Redistribution and use in source and binary forms are permitted
- * provided that the above copyright notice and this paragraph are
- * duplicated in all such forms and that any documentation,
- * advertising materials, and other materials related to such
- * distribution and use acknowledge that the software was developed
- * by Carnegie Mellon University.  The name of the
- * University may not be used to endorse or promote products derived
- * from this software without specific prior written permission.
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
- * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
- * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. The name "Carnegie Mellon University" must not be used to
+ *    endorse or promote products derived from this software without
+ *    prior written permission. For permission or any legal
+ *    details, please contact
+ *      Office of Technology Transfer
+ *      Carnegie Mellon University
+ *      5000 Forbes Avenue
+ *      Pittsburgh, PA  15213-3890
+ *      (412) 268-4387, fax: (412) 268-7395
+ *      tech-transfer@andrew.cmu.edu
+ *
+ * 4. Redistributions of any form whatsoever must retain the following
+ *    acknowledgment:
+ *    "This product includes software developed by Computing Services
+ *     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
+ *
+ * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
+ * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
+ * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
+ * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
+ * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
-#ifndef lint
-static char rcsid[] = "$Id: fsm.c,v 1.10 1995/12/18 03:44:42 paulus Exp $";
-#endif
+#define RCSID  "$Id: fsm.c,v 1.23 2004/11/13 02:28:15 paulus Exp $"
 
 /*
  * TODO:
@@ -30,18 +51,17 @@ static char rcsid[] = "$Id: fsm.c,v 1.10 1995/12/18 03:44:42 paulus Exp $";
 #include <stdio.h>
 #include <string.h>
 #include <sys/types.h>
-#include <syslog.h>
 
 #include "pppd.h"
 #include "fsm.h"
 
-extern char *proto_name();
+static const char rcsid[] = RCSID;
 
-static void fsm_timeout __P((caddr_t));
+static void fsm_timeout __P((void *));
 static void fsm_rconfreq __P((fsm *, int, u_char *, int));
 static void fsm_rconfack __P((fsm *, int, u_char *, int));
 static void fsm_rconfnakrej __P((fsm *, int, int, u_char *, int));
-static void fsm_rtermreq __P((fsm *, int));
+static void fsm_rtermreq __P((fsm *, int, u_char *, int));
 static void fsm_rtermack __P((fsm *));
 static void fsm_rcoderej __P((fsm *, u_char *, int));
 static void fsm_sconfreq __P((fsm *, int));
@@ -94,8 +114,7 @@ fsm_lowerup(f)
        break;
 
     default:
-       FSMDEBUG((LOG_INFO, "%s: Up event in state %d!",
-                 PROTO_NAME(f), f->state));
+       FSMDEBUG(("%s: Up event in state %d!", PROTO_NAME(f), f->state));
     }
 }
 
@@ -122,7 +141,7 @@ fsm_lowerdown(f)
 
     case CLOSING:
        f->state = INITIAL;
-       UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
+       UNTIMEOUT(fsm_timeout, f);      /* Cancel timeout */
        break;
 
     case STOPPING:
@@ -130,7 +149,7 @@ fsm_lowerdown(f)
     case ACKRCVD:
     case ACKSENT:
        f->state = STARTING;
-       UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
+       UNTIMEOUT(fsm_timeout, f);      /* Cancel timeout */
        break;
 
     case OPENED:
@@ -140,8 +159,7 @@ fsm_lowerdown(f)
        break;
 
     default:
-       FSMDEBUG((LOG_INFO, "%s: Down event in state %d!",
-                 PROTO_NAME(f), f->state));
+       FSMDEBUG(("%s: Down event in state %d!", PROTO_NAME(f), f->state));
     }
 }
 
@@ -183,6 +201,44 @@ fsm_open(f)
     }
 }
 
+/*
+ * terminate_layer - Start process of shutting down the FSM
+ *
+ * Cancel any timeout running, notify upper layers we're done, and
+ * send a terminate-request message as configured.
+ */
+static void
+terminate_layer(f, nextstate)
+    fsm *f;
+    int nextstate;
+{
+    if( f->state != OPENED )
+       UNTIMEOUT(fsm_timeout, f);      /* Cancel timeout */
+    else if( f->callbacks->down )
+       (*f->callbacks->down)(f);       /* Inform upper layers we're down */
+
+    /* Init restart counter and send Terminate-Request */
+    f->retransmits = f->maxtermtransmits;
+    fsm_sdata(f, TERMREQ, f->reqid = ++f->id,
+             (u_char *) f->term_reason, f->term_reason_len);
+
+    if (f->retransmits == 0) {
+       /*
+        * User asked for no terminate requests at all; just close it.
+        * We've already fired off one Terminate-Request just to be nice
+        * to the peer, but we're not going to wait for a reply.
+        */
+       f->state = nextstate == CLOSING ? CLOSED : STOPPED;
+       if( f->callbacks->finished )
+           (*f->callbacks->finished)(f);
+       return;
+    }
+
+    TIMEOUT(fsm_timeout, f, f->timeouttime);
+    --f->retransmits;
+
+    f->state = nextstate;
+}
 
 /*
  * fsm_close - Start closing connection.
@@ -212,19 +268,7 @@ fsm_close(f, reason)
     case ACKRCVD:
     case ACKSENT:
     case OPENED:
-       if( f->state != OPENED )
-           UNTIMEOUT(fsm_timeout, (caddr_t) f);        /* Cancel timeout */
-       else if( f->callbacks->down )
-           (*f->callbacks->down)(f);   /* Inform upper layers we're down */
-
-       /* Init restart counter, send Terminate-Request */
-       f->retransmits = f->maxtermtransmits;
-       fsm_sdata(f, TERMREQ, f->reqid = ++f->id,
-                 (u_char *) f->term_reason, f->term_reason_len);
-       TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
-       --f->retransmits;
-
-       f->state = CLOSING;
+       terminate_layer(f, CLOSING);
        break;
     }
 }
@@ -235,7 +279,7 @@ fsm_close(f, reason)
  */
 static void
 fsm_timeout(arg)
-    caddr_t arg;
+    void *arg;
 {
     fsm *f = (fsm *) arg;
 
@@ -253,7 +297,7 @@ fsm_timeout(arg)
            /* Send Terminate-Request */
            fsm_sdata(f, TERMREQ, f->reqid = ++f->id,
                      (u_char *) f->term_reason, f->term_reason_len);
-           TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
+           TIMEOUT(fsm_timeout, f, f->timeouttime);
            --f->retransmits;
        }
        break;
@@ -262,8 +306,7 @@ fsm_timeout(arg)
     case ACKRCVD:
     case ACKSENT:
        if (f->retransmits <= 0) {
-           syslog(LOG_WARNING, "%s: timeout sending Config-Requests",
-                  PROTO_NAME(f));
+           warn("%s: timeout sending Config-Requests\n", PROTO_NAME(f));
            f->state = STOPPED;
            if( (f->flags & OPT_PASSIVE) == 0 && f->callbacks->finished )
                (*f->callbacks->finished)(f);
@@ -279,8 +322,7 @@ fsm_timeout(arg)
        break;
 
     default:
-       FSMDEBUG((LOG_INFO, "%s: Timeout event in state %d!",
-                 PROTO_NAME(f), f->state));
+       FSMDEBUG(("%s: Timeout event in state %d!", PROTO_NAME(f), f->state));
     }
 }
 
@@ -294,7 +336,7 @@ fsm_input(f, inpacket, l)
     u_char *inpacket;
     int l;
 {
-    u_char *inp, *outp;
+    u_char *inp;
     u_char code, id;
     int len;
 
@@ -304,27 +346,24 @@ fsm_input(f, inpacket, l)
      */
     inp = inpacket;
     if (l < HEADERLEN) {
-       FSMDEBUG((LOG_WARNING, "fsm_input(%x): Rcvd short header.",
-                 f->protocol));
+       FSMDEBUG(("fsm_input(%x): Rcvd short header.", f->protocol));
        return;
     }
     GETCHAR(code, inp);
     GETCHAR(id, inp);
     GETSHORT(len, inp);
     if (len < HEADERLEN) {
-       FSMDEBUG((LOG_INFO, "fsm_input(%x): Rcvd illegal length.",
-                 f->protocol));
+       FSMDEBUG(("fsm_input(%x): Rcvd illegal length.", f->protocol));
        return;
     }
     if (len > l) {
-       FSMDEBUG((LOG_INFO, "fsm_input(%x): Rcvd short packet.",
-                 f->protocol));
+       FSMDEBUG(("fsm_input(%x): Rcvd short packet.", f->protocol));
        return;
     }
     len -= HEADERLEN;          /* subtract header length */
 
     if( f->state == INITIAL || f->state == STARTING ){
-       FSMDEBUG((LOG_INFO, "fsm_input(%x): Rcvd packet in state %d.",
+       FSMDEBUG(("fsm_input(%x): Rcvd packet in state %d.",
                  f->protocol, f->state));
        return;
     }
@@ -347,7 +386,7 @@ fsm_input(f, inpacket, l)
        break;
     
     case TERMREQ:
-       fsm_rtermreq(f, id);
+       fsm_rtermreq(f, id, inp, len);
        break;
     
     case TERMACK:
@@ -377,10 +416,8 @@ fsm_rconfreq(f, id, inp, len)
     u_char *inp;
     int len;
 {
-    u_char *outp;
     int code, reject_if_disagree;
 
-    FSMDEBUG((LOG_INFO, "fsm_rconfreq(%s): Rcvd id %d.", PROTO_NAME(f), id));
     switch( f->state ){
     case CLOSED:
        /* Go away, we're closed */
@@ -395,6 +432,7 @@ fsm_rconfreq(f, id, inp, len)
        if( f->callbacks->down )
            (*f->callbacks->down)(f);   /* Inform upper layers */
        fsm_sconfreq(f, 0);             /* Send initial Configure-Request */
+       f->state = REQSENT;
        break;
 
     case STOPPED:
@@ -421,7 +459,7 @@ fsm_rconfreq(f, id, inp, len)
 
     if (code == CONFACK) {
        if (f->state == ACKRCVD) {
-           UNTIMEOUT(fsm_timeout, (caddr_t) f);        /* Cancel timeout */
+           UNTIMEOUT(fsm_timeout, f);  /* Cancel timeout */
            f->state = OPENED;
            if (f->callbacks->up)
                (*f->callbacks->up)(f); /* Inform upper layers */
@@ -430,7 +468,7 @@ fsm_rconfreq(f, id, inp, len)
        f->nakloops = 0;
 
     } else {
-       /* we sent CONFACK or CONFREJ */
+       /* we sent CONFNAK or CONFREJ */
        if (f->state != ACKRCVD)
            f->state = REQSENT;
        if( code == CONFNAK )
@@ -449,19 +487,16 @@ fsm_rconfack(f, id, inp, len)
     u_char *inp;
     int len;
 {
-    FSMDEBUG((LOG_INFO, "fsm_rconfack(%s): Rcvd id %d.",
-             PROTO_NAME(f), id));
-
     if (id != f->reqid || f->seen_ack)         /* Expected id? */
        return;                                 /* Nope, toss... */
     if( !(f->callbacks->ackci? (*f->callbacks->ackci)(f, inp, len):
          (len == 0)) ){
        /* Ack is bad - ignore it */
-       FSMDEBUG((LOG_INFO, "%s: received bad Ack (length %d)",
-                 PROTO_NAME(f), len));
+       error("Received bad configure-ack: %P", inp, len);
        return;
     }
     f->seen_ack = 1;
+    f->rnakloops = 0;
 
     switch (f->state) {
     case CLOSED:
@@ -476,13 +511,13 @@ fsm_rconfack(f, id, inp, len)
 
     case ACKRCVD:
        /* Huh? an extra valid Ack? oh well... */
-       UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
+       UNTIMEOUT(fsm_timeout, f);      /* Cancel timeout */
        fsm_sconfreq(f, 0);
        f->state = REQSENT;
        break;
 
     case ACKSENT:
-       UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
+       UNTIMEOUT(fsm_timeout, f);      /* Cancel timeout */
        f->state = OPENED;
        f->retransmits = f->maxconfreqtransmits;
        if (f->callbacks->up)
@@ -510,21 +545,29 @@ fsm_rconfnakrej(f, code, id, inp, len)
     u_char *inp;
     int len;
 {
-    int (*proc)();
     int ret;
-
-    FSMDEBUG((LOG_INFO, "fsm_rconfnakrej(%s): Rcvd id %d.",
-             PROTO_NAME(f), id));
+    int treat_as_reject;
 
     if (id != f->reqid || f->seen_ack) /* Expected id? */
        return;                         /* Nope, toss... */
-    proc = (code == CONFNAK)? f->callbacks->nakci: f->callbacks->rejci;
-    if (!proc || !(ret = proc(f, inp, len))) {
-       /* Nak/reject is bad - ignore it */
-       FSMDEBUG((LOG_INFO, "%s: received bad %s (length %d)",
-                 PROTO_NAME(f), (code==CONFNAK? "Nak": "reject"), len));
-       return;
+
+    if (code == CONFNAK) {
+       ++f->rnakloops;
+       treat_as_reject = (f->rnakloops >= f->maxnakloops);
+       if (f->callbacks->nakci == NULL
+           || !(ret = f->callbacks->nakci(f, inp, len, treat_as_reject))) {
+           error("Received bad configure-nak: %P", inp, len);
+           return;
+       }
+    } else {
+       f->rnakloops = 0;
+       if (f->callbacks->rejci == NULL
+           || !(ret = f->callbacks->rejci(f, inp, len))) {
+           error("Received bad configure-rej: %P", inp, len);
+           return;
+       }
     }
+
     f->seen_ack = 1;
 
     switch (f->state) {
@@ -536,7 +579,7 @@ fsm_rconfnakrej(f, code, id, inp, len)
     case REQSENT:
     case ACKSENT:
        /* They didn't agree to what we wanted - try another request */
-       UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
+       UNTIMEOUT(fsm_timeout, f);      /* Cancel timeout */
        if (ret < 0)
            f->state = STOPPED;         /* kludge for stopping CCP */
        else
@@ -545,7 +588,7 @@ fsm_rconfnakrej(f, code, id, inp, len)
 
     case ACKRCVD:
        /* Got a Nak/reject when we had already had an Ack?? oh well... */
-       UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
+       UNTIMEOUT(fsm_timeout, f);      /* Cancel timeout */
        fsm_sconfreq(f, 0);
        f->state = REQSENT;
        break;
@@ -565,13 +608,12 @@ fsm_rconfnakrej(f, code, id, inp, len)
  * fsm_rtermreq - Receive Terminate-Req.
  */
 static void
-fsm_rtermreq(f, id)
+fsm_rtermreq(f, id, p, len)
     fsm *f;
     int id;
+    u_char *p;
+    int len;
 {
-    FSMDEBUG((LOG_INFO, "fsm_rtermreq(%s): Rcvd id %d.",
-             PROTO_NAME(f), id));
-
     switch (f->state) {
     case ACKRCVD:
     case ACKSENT:
@@ -579,12 +621,15 @@ fsm_rtermreq(f, id)
        break;
 
     case OPENED:
-       syslog(LOG_INFO, "%s terminated at peer's request", PROTO_NAME(f));
-       if (f->callbacks->down)
-           (*f->callbacks->down)(f);   /* Inform upper layers */
+       if (len > 0) {
+           info("%s terminated by peer (%0.*v)", PROTO_NAME(f), len, p);
+       } else
+           info("%s terminated by peer", PROTO_NAME(f));
        f->retransmits = 0;
        f->state = STOPPING;
-       TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
+       if (f->callbacks->down)
+           (*f->callbacks->down)(f);   /* Inform upper layers */
+       TIMEOUT(fsm_timeout, f, f->timeouttime);
        break;
     }
 
@@ -599,17 +644,15 @@ static void
 fsm_rtermack(f)
     fsm *f;
 {
-    FSMDEBUG((LOG_INFO, "fsm_rtermack(%s).", PROTO_NAME(f)));
-
     switch (f->state) {
     case CLOSING:
-       UNTIMEOUT(fsm_timeout, (caddr_t) f);
+       UNTIMEOUT(fsm_timeout, f);
        f->state = CLOSED;
        if( f->callbacks->finished )
            (*f->callbacks->finished)(f);
        break;
     case STOPPING:
-       UNTIMEOUT(fsm_timeout, (caddr_t) f);
+       UNTIMEOUT(fsm_timeout, f);
        f->state = STOPPED;
        if( f->callbacks->finished )
            (*f->callbacks->finished)(f);
@@ -623,6 +666,7 @@ fsm_rtermack(f)
        if (f->callbacks->down)
            (*f->callbacks->down)(f);   /* Inform upper layers */
        fsm_sconfreq(f, 0);
+       f->state = REQSENT;
        break;
     }
 }
@@ -639,16 +683,13 @@ fsm_rcoderej(f, inp, len)
 {
     u_char code, id;
 
-    FSMDEBUG((LOG_INFO, "fsm_rcoderej(%s).", PROTO_NAME(f)));
-
     if (len < HEADERLEN) {
-       FSMDEBUG((LOG_INFO, "fsm_rcoderej: Rcvd short Code-Reject packet!"));
+       FSMDEBUG(("fsm_rcoderej: Rcvd short Code-Reject packet!"));
        return;
     }
     GETCHAR(code, inp);
     GETCHAR(id, inp);
-    syslog(LOG_WARNING, "%s: Rcvd Code-Reject for code %d, id %d",
-          PROTO_NAME(f), code, id);
+    warn("%s: Rcvd Code-Reject for code %d, id %d", PROTO_NAME(f), code, id);
 
     if( f->state == ACKRCVD )
        f->state = REQSENT;
@@ -666,7 +707,7 @@ fsm_protreject(f)
 {
     switch( f->state ){
     case CLOSING:
-       UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
+       UNTIMEOUT(fsm_timeout, f);      /* Cancel timeout */
        /* fall through */
     case CLOSED:
        f->state = CLOSED;
@@ -678,7 +719,7 @@ fsm_protreject(f)
     case REQSENT:
     case ACKRCVD:
     case ACKSENT:
-       UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
+       UNTIMEOUT(fsm_timeout, f);      /* Cancel timeout */
        /* fall through */
     case STOPPED:
        f->state = STOPPED;
@@ -687,21 +728,11 @@ fsm_protreject(f)
        break;
 
     case OPENED:
-       if( f->callbacks->down )
-           (*f->callbacks->down)(f);
-
-       /* Init restart counter, send Terminate-Request */
-       f->retransmits = f->maxtermtransmits;
-       fsm_sdata(f, TERMREQ, f->reqid = ++f->id,
-                 (u_char *) f->term_reason, f->term_reason_len);
-       TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
-       --f->retransmits;
-
-       f->state = STOPPING;
+       terminate_layer(f, STOPPING);
        break;
 
     default:
-       FSMDEBUG((LOG_INFO, "%s: Protocol-reject event in state %d!",
+       FSMDEBUG(("%s: Protocol-reject event in state %d!",
                  PROTO_NAME(f), f->state));
     }
 }
@@ -716,13 +747,14 @@ fsm_sconfreq(f, retransmit)
     int retransmit;
 {
     u_char *outp;
-    int outlen, cilen;
+    int cilen;
 
     if( f->state != REQSENT && f->state != ACKRCVD && f->state != ACKSENT ){
        /* Not currently negotiating - reset options */
        if( f->callbacks->resetci )
            (*f->callbacks->resetci)(f);
        f->nakloops = 0;
+       f->rnakloops = 0;
     }
 
     if( !retransmit ){
@@ -751,10 +783,7 @@ fsm_sconfreq(f, retransmit)
 
     /* start the retransmit timer */
     --f->retransmits;
-    TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
-
-    FSMDEBUG((LOG_INFO, "%s: sending Configure-Request, id %d",
-             PROTO_NAME(f), f->reqid));
+    TIMEOUT(fsm_timeout, f, f->timeouttime);
 }
 
 
@@ -785,7 +814,4 @@ fsm_sdata(f, code, id, data, datalen)
     PUTCHAR(id, outp);
     PUTSHORT(outlen, outp);
     output(f->unit, outpacket_buf, outlen + PPP_HDRLEN);
-
-    FSMDEBUG((LOG_INFO, "fsm_sdata(%s): Sent code %d, id %d.",
-             PROTO_NAME(f), code, id));
 }