2 * fsm.c - {Link, IP} Control Protocol Finite State Machine.
4 * Copyright (c) 1989 Carnegie Mellon University.
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.
21 static char rcsid[] = "$Id: fsm.c,v 1.9 1995/10/27 03:43:46 paulus Exp $";
26 * Randomize fsm id on link/init.
27 * Deal with variable outgoing MTU.
32 #include <sys/types.h>
38 extern char *proto_name();
40 static void fsm_timeout __P((caddr_t));
41 static void fsm_rconfreq __P((fsm *, int, u_char *, int));
42 static void fsm_rconfack __P((fsm *, int, u_char *, int));
43 static void fsm_rconfnakrej __P((fsm *, int, int, u_char *, int));
44 static void fsm_rtermreq __P((fsm *, int));
45 static void fsm_rtermack __P((fsm *));
46 static void fsm_rcoderej __P((fsm *, u_char *, int));
47 static void fsm_sconfreq __P((fsm *, int));
49 #define PROTO_NAME(f) ((f)->callbacks->proto_name)
51 int peer_mru[NUM_PPP];
55 * fsm_init - Initialize fsm.
57 * Initialize fsm state.
65 f->id = 0; /* XXX Start with random id? */
66 f->timeouttime = DEFTIMEOUT;
67 f->maxconfreqtransmits = DEFMAXCONFREQS;
68 f->maxtermtransmits = DEFMAXTERMREQS;
69 f->maxnakloops = DEFMAXNAKLOOPS;
74 * fsm_lowerup - The lower layer is up.
86 if( f->flags & OPT_SILENT )
89 /* Send an initial configure-request */
96 FSMDEBUG((LOG_INFO, "%s: Up event in state %d!",
97 PROTO_NAME(f), f->state));
103 * fsm_lowerdown - The lower layer is down.
105 * Cancel all timeouts and inform upper layers.
118 if( f->callbacks->starting )
119 (*f->callbacks->starting)(f);
124 UNTIMEOUT(fsm_timeout, (caddr_t) f); /* Cancel timeout */
132 UNTIMEOUT(fsm_timeout, (caddr_t) f); /* Cancel timeout */
136 if( f->callbacks->down )
137 (*f->callbacks->down)(f);
142 FSMDEBUG((LOG_INFO, "%s: Down event in state %d!",
143 PROTO_NAME(f), f->state));
149 * fsm_open - Link is allowed to come up.
158 if( f->callbacks->starting )
159 (*f->callbacks->starting)(f);
163 if( f->flags & OPT_SILENT )
166 /* Send an initial configure-request */
177 if( f->flags & OPT_RESTART ){
187 * fsm_close - Start closing connection.
189 * Cancel timeouts and either initiate close or possibly go directly to
211 if( f->state != OPENED )
212 UNTIMEOUT(fsm_timeout, (caddr_t) f); /* Cancel timeout */
213 else if( f->callbacks->down )
214 (*f->callbacks->down)(f); /* Inform upper layers we're down */
216 /* Init restart counter, send Terminate-Request */
217 f->retransmits = f->maxtermtransmits;
218 fsm_sdata(f, TERMREQ, f->reqid = ++f->id, NULL, 0);
219 TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
229 * fsm_timeout - Timeout expired.
235 fsm *f = (fsm *) arg;
240 if( f->retransmits <= 0 ){
242 * We've waited for an ack long enough. Peer probably heard us.
244 f->state = (f->state == CLOSING)? CLOSED: STOPPED;
245 if( f->callbacks->finished )
246 (*f->callbacks->finished)(f);
248 /* Send Terminate-Request */
249 fsm_sdata(f, TERMREQ, f->reqid = ++f->id, NULL, 0);
250 TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
258 if (f->retransmits <= 0) {
259 syslog(LOG_WARNING, "%s: timeout sending Config-Requests",
262 if( (f->flags & OPT_PASSIVE) == 0 && f->callbacks->finished )
263 (*f->callbacks->finished)(f);
266 /* Retransmit the configure-request */
267 if (f->callbacks->retransmit)
268 (*f->callbacks->retransmit)(f);
269 fsm_sconfreq(f, 1); /* Re-send Configure-Request */
270 if( f->state == ACKRCVD )
276 FSMDEBUG((LOG_INFO, "%s: Timeout event in state %d!",
277 PROTO_NAME(f), f->state));
283 * fsm_input - Input packet.
286 fsm_input(f, inpacket, l)
296 * Parse header (code, id and length).
297 * If packet too short, drop it.
301 FSMDEBUG((LOG_WARNING, "fsm_input(%x): Rcvd short header.",
308 if (len < HEADERLEN) {
309 FSMDEBUG((LOG_INFO, "fsm_input(%x): Rcvd illegal length.",
314 FSMDEBUG((LOG_INFO, "fsm_input(%x): Rcvd short packet.",
318 len -= HEADERLEN; /* subtract header length */
320 if( f->state == INITIAL || f->state == STARTING ){
321 FSMDEBUG((LOG_INFO, "fsm_input(%x): Rcvd packet in state %d.",
322 f->protocol, f->state));
327 * Action depends on code.
331 fsm_rconfreq(f, id, inp, len);
335 fsm_rconfack(f, id, inp, len);
340 fsm_rconfnakrej(f, code, id, inp, len);
352 fsm_rcoderej(f, inp, len);
356 if( !f->callbacks->extcode
357 || !(*f->callbacks->extcode)(f, code, id, inp, len) )
358 fsm_sdata(f, CODEREJ, ++f->id, inpacket, len + HEADERLEN);
365 * fsm_rconfreq - Receive Configure-Request.
368 fsm_rconfreq(f, id, inp, len)
375 int code, reject_if_disagree;
377 FSMDEBUG((LOG_INFO, "fsm_rconfreq(%s): Rcvd id %d.", PROTO_NAME(f), id));
380 /* Go away, we're closed */
381 fsm_sdata(f, TERMACK, id, NULL, 0);
388 /* Go down and restart negotiation */
389 if( f->callbacks->down )
390 (*f->callbacks->down)(f); /* Inform upper layers */
391 fsm_sconfreq(f, 0); /* Send initial Configure-Request */
395 /* Negotiation started by our peer */
396 fsm_sconfreq(f, 0); /* Send initial Configure-Request */
402 * Pass the requested configuration options
403 * to protocol-specific code for checking.
405 if (f->callbacks->reqci){ /* Check CI */
406 reject_if_disagree = (f->nakloops >= f->maxnakloops);
407 code = (*f->callbacks->reqci)(f, inp, &len, reject_if_disagree);
409 code = CONFREJ; /* Reject all CI */
413 /* send the Ack, Nak or Rej to the peer */
414 fsm_sdata(f, code, id, inp, len);
416 if (code == CONFACK) {
417 if (f->state == ACKRCVD) {
418 UNTIMEOUT(fsm_timeout, (caddr_t) f); /* Cancel timeout */
420 if (f->callbacks->up)
421 (*f->callbacks->up)(f); /* Inform upper layers */
427 /* we sent CONFACK or CONFREJ */
428 if (f->state != ACKRCVD)
430 if( code == CONFNAK )
437 * fsm_rconfack - Receive Configure-Ack.
440 fsm_rconfack(f, id, inp, len)
446 FSMDEBUG((LOG_INFO, "fsm_rconfack(%s): Rcvd id %d.",
449 if (id != f->reqid || f->seen_ack) /* Expected id? */
450 return; /* Nope, toss... */
451 if( !(f->callbacks->ackci? (*f->callbacks->ackci)(f, inp, len):
453 /* Ack is bad - ignore it */
454 FSMDEBUG((LOG_INFO, "%s: received bad Ack (length %d)",
455 PROTO_NAME(f), len));
463 fsm_sdata(f, TERMACK, id, NULL, 0);
468 f->retransmits = f->maxconfreqtransmits;
472 /* Huh? an extra valid Ack? oh well... */
473 UNTIMEOUT(fsm_timeout, (caddr_t) f); /* Cancel timeout */
479 UNTIMEOUT(fsm_timeout, (caddr_t) f); /* Cancel timeout */
481 f->retransmits = f->maxconfreqtransmits;
482 if (f->callbacks->up)
483 (*f->callbacks->up)(f); /* Inform upper layers */
487 /* Go down and restart negotiation */
488 if (f->callbacks->down)
489 (*f->callbacks->down)(f); /* Inform upper layers */
490 fsm_sconfreq(f, 0); /* Send initial Configure-Request */
498 * fsm_rconfnakrej - Receive Configure-Nak or Configure-Reject.
501 fsm_rconfnakrej(f, code, id, inp, len)
510 FSMDEBUG((LOG_INFO, "fsm_rconfnakrej(%s): Rcvd id %d.",
513 if (id != f->reqid || f->seen_ack) /* Expected id? */
514 return; /* Nope, toss... */
515 proc = (code == CONFNAK)? f->callbacks->nakci: f->callbacks->rejci;
516 if (!proc || !(ret = proc(f, inp, len))) {
517 /* Nak/reject is bad - ignore it */
518 FSMDEBUG((LOG_INFO, "%s: received bad %s (length %d)",
519 PROTO_NAME(f), (code==CONFNAK? "Nak": "reject"), len));
527 fsm_sdata(f, TERMACK, id, NULL, 0);
532 /* They didn't agree to what we wanted - try another request */
533 UNTIMEOUT(fsm_timeout, (caddr_t) f); /* Cancel timeout */
535 f->state = STOPPED; /* kludge for stopping CCP */
537 fsm_sconfreq(f, 0); /* Send Configure-Request */
541 /* Got a Nak/reject when we had already had an Ack?? oh well... */
542 UNTIMEOUT(fsm_timeout, (caddr_t) f); /* Cancel timeout */
548 /* Go down and restart negotiation */
549 if (f->callbacks->down)
550 (*f->callbacks->down)(f); /* Inform upper layers */
551 fsm_sconfreq(f, 0); /* Send initial Configure-Request */
559 * fsm_rtermreq - Receive Terminate-Req.
566 FSMDEBUG((LOG_INFO, "fsm_rtermreq(%s): Rcvd id %d.",
572 f->state = REQSENT; /* Start over but keep trying */
576 syslog(LOG_INFO, "%s terminated at peer's request", PROTO_NAME(f));
577 if (f->callbacks->down)
578 (*f->callbacks->down)(f); /* Inform upper layers */
581 TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
585 fsm_sdata(f, TERMACK, id, NULL, 0);
590 * fsm_rtermack - Receive Terminate-Ack.
596 FSMDEBUG((LOG_INFO, "fsm_rtermack(%s).", PROTO_NAME(f)));
600 UNTIMEOUT(fsm_timeout, (caddr_t) f);
602 if( f->callbacks->finished )
603 (*f->callbacks->finished)(f);
606 UNTIMEOUT(fsm_timeout, (caddr_t) f);
608 if( f->callbacks->finished )
609 (*f->callbacks->finished)(f);
617 if (f->callbacks->down)
618 (*f->callbacks->down)(f); /* Inform upper layers */
626 * fsm_rcoderej - Receive an Code-Reject.
629 fsm_rcoderej(f, inp, len)
636 FSMDEBUG((LOG_INFO, "fsm_rcoderej(%s).", PROTO_NAME(f)));
638 if (len < HEADERLEN) {
639 FSMDEBUG((LOG_INFO, "fsm_rcoderej: Rcvd short Code-Reject packet!"));
644 syslog(LOG_WARNING, "%s: Rcvd Code-Reject for code %d, id %d",
645 PROTO_NAME(f), code, id);
647 if( f->state == ACKRCVD )
653 * fsm_protreject - Peer doesn't speak this protocol.
655 * Treat this as a catastrophic error (RXJ-).
663 UNTIMEOUT(fsm_timeout, (caddr_t) f); /* Cancel timeout */
667 if( f->callbacks->finished )
668 (*f->callbacks->finished)(f);
675 UNTIMEOUT(fsm_timeout, (caddr_t) f); /* Cancel timeout */
679 if( f->callbacks->finished )
680 (*f->callbacks->finished)(f);
684 if( f->callbacks->down )
685 (*f->callbacks->down)(f);
687 /* Init restart counter, send Terminate-Request */
688 f->retransmits = f->maxtermtransmits;
689 fsm_sdata(f, TERMREQ, f->reqid = ++f->id, NULL, 0);
690 TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
697 FSMDEBUG((LOG_INFO, "%s: Protocol-reject event in state %d!",
698 PROTO_NAME(f), f->state));
704 * fsm_sconfreq - Send a Configure-Request.
707 fsm_sconfreq(f, retransmit)
714 if( f->state != REQSENT && f->state != ACKRCVD && f->state != ACKSENT ){
715 /* Not currently negotiating - reset options */
716 if( f->callbacks->resetci )
717 (*f->callbacks->resetci)(f);
722 /* New request - reset retransmission counter, use new ID */
723 f->retransmits = f->maxconfreqtransmits;
730 * Make up the request packet
732 outp = outpacket_buf + PPP_HDRLEN + HEADERLEN;
733 if( f->callbacks->cilen && f->callbacks->addci ){
734 cilen = (*f->callbacks->cilen)(f);
735 if( cilen > peer_mru[f->unit] - HEADERLEN )
736 cilen = peer_mru[f->unit] - HEADERLEN;
737 if (f->callbacks->addci)
738 (*f->callbacks->addci)(f, outp, &cilen);
742 /* send the request to our peer */
743 fsm_sdata(f, CONFREQ, f->reqid, outp, cilen);
745 /* start the retransmit timer */
747 TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
749 FSMDEBUG((LOG_INFO, "%s: sending Configure-Request, id %d",
750 PROTO_NAME(f), f->reqid));
755 * fsm_sdata - Send some data.
757 * Used for all packets sent to our peer by this module.
760 fsm_sdata(f, code, id, data, datalen)
769 /* Adjust length to be smaller than MTU */
770 outp = outpacket_buf;
771 if (datalen > peer_mru[f->unit] - HEADERLEN)
772 datalen = peer_mru[f->unit] - HEADERLEN;
773 if (datalen && data != outp + PPP_HDRLEN + HEADERLEN)
774 BCOPY(data, outp + PPP_HDRLEN + HEADERLEN, datalen);
775 outlen = datalen + HEADERLEN;
776 MAKEHEADER(outp, f->protocol);
779 PUTSHORT(outlen, outp);
780 output(f->unit, outpacket_buf, outlen + PPP_HDRLEN);
782 FSMDEBUG((LOG_INFO, "fsm_sdata(%s): Sent code %d, id %d.",
783 PROTO_NAME(f), code, id));