e07e38d2ee853698695e423425b0aa4ab3c80c5e
[ppp.git] / pppd / fsm.c
1 /*
2  * fsm.c - {Link, IP} Control Protocol Finite State Machine.
3  *
4  * Copyright (c) 1989 Carnegie Mellon University.
5  * All rights reserved.
6  *
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.
18  */
19
20 #ifndef lint
21 static char rcsid[] = "$Id: fsm.c,v 1.2 1994/04/18 04:01:50 paulus Exp $";
22 #endif
23
24 /*
25  * TODO:
26  * Randomize fsm id on link/init.
27  * Deal with variable outgoing MTU.
28  */
29
30 #include <stdio.h>
31 #include <sys/types.h>
32 #include <syslog.h>
33
34 #include "ppp.h"
35 #include "pppd.h"
36 #include "fsm.h"
37
38 extern char *proto_name();
39
40 static void fsm_timeout __ARGS((caddr_t));
41 static void fsm_rconfreq __ARGS((fsm *, int, u_char *, int));
42 static void fsm_rconfack __ARGS((fsm *, int, u_char *, int));
43 static void fsm_rconfnakrej __ARGS((fsm *, int, int, u_char *, int));
44 static void fsm_rtermreq __ARGS((fsm *, int));
45 static void fsm_rtermack __ARGS((fsm *));
46 static void fsm_rcoderej __ARGS((fsm *, u_char *, int));
47 static void fsm_sconfreq __ARGS((fsm *, int));
48
49 #define PROTO_NAME(f)   ((f)->callbacks->proto_name)
50
51 int peer_mru[NPPP];
52
53
54 /*
55  * fsm_init - Initialize fsm.
56  *
57  * Initialize fsm state.
58  */
59 void
60 fsm_init(f)
61     fsm *f;
62 {
63     f->state = INITIAL;
64     f->flags = 0;
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;
70 }
71
72
73 /*
74  * fsm_lowerup - The lower layer is up.
75  */
76 void
77 fsm_lowerup(f)
78     fsm *f;
79 {
80     switch( f->state ){
81     case INITIAL:
82         f->state = CLOSED;
83         break;
84
85     case STARTING:
86         if( f->flags & OPT_SILENT )
87             f->state = STOPPED;
88         else {
89             /* Send an initial configure-request */
90             fsm_sconfreq(f, 0);
91             f->state = REQSENT;
92         }
93         break;
94
95     default:
96         FSMDEBUG((LOG_INFO, "%s: Up event in state %d!",
97                   PROTO_NAME(f), f->state));
98     }
99 }
100
101
102 /*
103  * fsm_lowerdown - The lower layer is down.
104  *
105  * Cancel all timeouts and inform upper layers.
106  */
107 void
108 fsm_lowerdown(f)
109     fsm *f;
110 {
111     switch( f->state ){
112     case CLOSED:
113         f->state = INITIAL;
114         break;
115
116     case STOPPED:
117         f->state = STARTING;
118         if( f->callbacks->starting )
119             (*f->callbacks->starting)(f);
120         break;
121
122     case CLOSING:
123         f->state = INITIAL;
124         UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
125         break;
126
127     case STOPPING:
128     case REQSENT:
129     case ACKRCVD:
130     case ACKSENT:
131         f->state = STARTING;
132         UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
133         break;
134
135     case OPENED:
136         if( f->callbacks->down )
137             (*f->callbacks->down)(f);
138         f->state = STARTING;
139         break;
140
141     default:
142         FSMDEBUG((LOG_INFO, "%s: Down event in state %d!",
143                   PROTO_NAME(f), f->state));
144     }
145 }
146
147
148 /*
149  * fsm_open - Link is allowed to come up.
150  */
151 void
152 fsm_open(f)
153     fsm *f;
154 {
155     switch( f->state ){
156     case INITIAL:
157         f->state = STARTING;
158         if( f->callbacks->starting )
159             (*f->callbacks->starting)(f);
160         break;
161
162     case CLOSED:
163         if( f->flags & OPT_SILENT )
164             f->state = STOPPED;
165         else {
166             /* Send an initial configure-request */
167             fsm_sconfreq(f, 0);
168             f->state = REQSENT;
169         }
170         break;
171
172     case CLOSING:
173         f->state = STOPPING;
174         /* fall through */
175     case STOPPED:
176     case OPENED:
177         if( f->flags & OPT_RESTART ){
178             fsm_lowerdown(f);
179             fsm_lowerup(f);
180         }
181         break;
182     }
183 }
184
185
186 /*
187  * fsm_close - Start closing connection.
188  *
189  * Cancel timeouts and either initiate close or possibly go directly to
190  * the CLOSED state.
191  */
192 void
193 fsm_close(f)
194     fsm *f;
195 {
196     switch( f->state ){
197     case STARTING:
198         f->state = INITIAL;
199         break;
200     case STOPPED:
201         f->state = CLOSED;
202         break;
203     case STOPPING:
204         f->state = CLOSING;
205         break;
206
207     case REQSENT:
208     case ACKRCVD:
209     case ACKSENT:
210     case OPENED:
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 */
215
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);
220         --f->retransmits;
221
222         f->state = CLOSING;
223         break;
224     }
225 }
226
227
228 /*
229  * fsm_timeout - Timeout expired.
230  */
231 static void
232 fsm_timeout(arg)
233     caddr_t arg;
234 {
235     fsm *f = (fsm *) arg;
236
237     switch (f->state) {
238     case CLOSING:
239     case STOPPING:
240         if( f->retransmits <= 0 ){
241             /*
242              * We've waited for an ack long enough.  Peer probably heard us.
243              */
244             f->state = (f->state == CLOSING)? CLOSED: STOPPED;
245             if( f->callbacks->finished )
246                 (*f->callbacks->finished)(f);
247         } else {
248             /* Send Terminate-Request */
249             fsm_sdata(f, TERMREQ, f->reqid = ++f->id, NULL, 0);
250             TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
251             --f->retransmits;
252         }
253         break;
254
255     case REQSENT:
256     case ACKRCVD:
257     case ACKSENT:
258         if (f->retransmits <= 0) {
259             syslog(LOG_WARNING, "%s: timeout sending Config-Requests",
260                    PROTO_NAME(f));
261             f->state = STOPPED;
262             if( (f->flags & OPT_PASSIVE) == 0 && f->callbacks->finished )
263                 (*f->callbacks->finished)(f);
264
265         } else {
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 )
271                 f->state = REQSENT;
272         }
273         break;
274
275     default:
276         FSMDEBUG((LOG_INFO, "%s: Timeout event in state %d!",
277                   PROTO_NAME(f), f->state));
278     }
279 }
280
281
282 /*
283  * fsm_input - Input packet.
284  */
285 void
286 fsm_input(f, inpacket, l)
287     fsm *f;
288     u_char *inpacket;
289     int l;
290 {
291     u_char *inp, *outp;
292     u_char code, id;
293     int len;
294
295     /*
296      * Parse header (code, id and length).
297      * If packet too short, drop it.
298      */
299     inp = inpacket;
300     if (l < HEADERLEN) {
301         FSMDEBUG((LOG_WARNING, "fsm_input(%x): Rcvd short header.",
302                   f->protocol));
303         return;
304     }
305     GETCHAR(code, inp);
306     GETCHAR(id, inp);
307     GETSHORT(len, inp);
308     if (len < HEADERLEN) {
309         FSMDEBUG((LOG_INFO, "fsm_input(%x): Rcvd illegal length.",
310                   f->protocol));
311         return;
312     }
313     if (len > l) {
314         FSMDEBUG((LOG_INFO, "fsm_input(%x): Rcvd short packet.",
315                   f->protocol));
316         return;
317     }
318     len -= HEADERLEN;           /* subtract header length */
319
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));
323         return;
324     }
325
326     /*
327      * Action depends on code.
328      */
329     switch (code) {
330     case CONFREQ:
331         fsm_rconfreq(f, id, inp, len);
332         break;
333     
334     case CONFACK:
335         fsm_rconfack(f, id, inp, len);
336         break;
337     
338     case CONFNAK:
339     case CONFREJ:
340         fsm_rconfnakrej(f, code, id, inp, len);
341         break;
342     
343     case TERMREQ:
344         fsm_rtermreq(f, id);
345         break;
346     
347     case TERMACK:
348         fsm_rtermack(f);
349         break;
350     
351     case CODEREJ:
352         fsm_rcoderej(f, inp, len);
353         break;
354     
355     default:
356         if( !f->callbacks->extcode
357            || !(*f->callbacks->extcode)(f, code, id, inp, len) )
358             fsm_sdata(f, CODEREJ, ++f->id, inpacket, len + HEADERLEN);
359         break;
360     }
361 }
362
363
364 /*
365  * fsm_rconfreq - Receive Configure-Request.
366  */
367 static void
368 fsm_rconfreq(f, id, inp, len)
369     fsm *f;
370     u_char id;
371     u_char *inp;
372     int len;
373 {
374     u_char *outp;
375     int code, reject_if_disagree;
376
377     FSMDEBUG((LOG_INFO, "fsm_rconfreq(%s): Rcvd id %d.", PROTO_NAME(f), id));
378     switch( f->state ){
379     case CLOSED:
380         /* Go away, we're closed */
381         fsm_sdata(f, TERMACK, id, NULL, 0);
382         return;
383     case CLOSING:
384     case STOPPING:
385         return;
386
387     case OPENED:
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 */
392         break;
393
394     case STOPPED:
395         /* Negotiation started by our peer */
396         fsm_sconfreq(f, 0);             /* Send initial Configure-Request */
397         f->state = REQSENT;
398         break;
399     }
400
401     /*
402      * Pass the requested configuration options
403      * to protocol-specific code for checking.
404      */
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);
408     } else if (len)
409         code = CONFREJ;                 /* Reject all CI */
410
411     /* send the Ack, Nak or Rej to the peer */
412     fsm_sdata(f, code, id, inp, len);
413
414     if (code == CONFACK) {
415         if (f->state == ACKRCVD) {
416             UNTIMEOUT(fsm_timeout, (caddr_t) f);        /* Cancel timeout */
417             f->state = OPENED;
418             if (f->callbacks->up)
419                 (*f->callbacks->up)(f); /* Inform upper layers */
420         } else
421             f->state = ACKSENT;
422         f->nakloops = 0;
423
424     } else {
425         /* we sent CONFACK or CONFREJ */
426         if (f->state != ACKRCVD)
427             f->state = REQSENT;
428         if( code == CONFNAK )
429             ++f->nakloops;
430     }
431 }
432
433
434 /*
435  * fsm_rconfack - Receive Configure-Ack.
436  */
437 static void
438 fsm_rconfack(f, id, inp, len)
439     fsm *f;
440     int id;
441     u_char *inp;
442     int len;
443 {
444     FSMDEBUG((LOG_INFO, "fsm_rconfack(%s): Rcvd id %d.",
445               PROTO_NAME(f), id));
446
447     if (id != f->reqid)         /* Expected id? */
448         return;                 /* Nope, toss... */
449     if( !(f->callbacks->ackci? (*f->callbacks->ackci)(f, inp, len): (len == 0)) ){
450         /* Ack is bad - ignore it */
451         FSMDEBUG((LOG_INFO, "%s: received bad Ack (length %d)",
452                   PROTO_NAME(f), len));
453         return;
454     }
455     f->reqid = -1;
456
457     switch (f->state) {
458     case CLOSED:
459     case STOPPED:
460         fsm_sdata(f, TERMACK, id, NULL, 0);
461         break;
462
463     case REQSENT:
464         f->state = ACKRCVD;
465         f->retransmits = f->maxconfreqtransmits;
466         break;
467
468     case ACKRCVD:
469         /* Huh? an extra Ack? oh well... */
470         fsm_sconfreq(f, 0);
471         f->state = REQSENT;
472         break;
473
474     case ACKSENT:
475         UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
476         f->state = OPENED;
477         f->retransmits = f->maxconfreqtransmits;
478         if (f->callbacks->up)
479             (*f->callbacks->up)(f);     /* Inform upper layers */
480         break;
481
482     case OPENED:
483         /* Go down and restart negotiation */
484         if (f->callbacks->down)
485             (*f->callbacks->down)(f);   /* Inform upper layers */
486         fsm_sconfreq(f, 0);             /* Send initial Configure-Request */
487         f->state = REQSENT;
488         break;
489     }
490 }
491
492
493 /*
494  * fsm_rconfnakrej - Receive Configure-Nak or Configure-Reject.
495  */
496 static void
497 fsm_rconfnakrej(f, code, id, inp, len)
498     fsm *f;
499     int code, id;
500     u_char *inp;
501     int len;
502 {
503     int (*proc)();
504
505     FSMDEBUG((LOG_INFO, "fsm_rconfnakrej(%s): Rcvd id %d.",
506               PROTO_NAME(f), id));
507
508     if (id != f->reqid)         /* Expected id? */
509         return;                 /* Nope, toss... */
510     proc = (code == CONFNAK)? f->callbacks->nakci: f->callbacks->rejci;
511     if( !proc || !proc(f, inp, len) ){
512         /* Nak/reject is bad - ignore it */
513         FSMDEBUG((LOG_INFO, "%s: received bad %s (length %d)",
514                   PROTO_NAME(f), (code==CONFNAK? "Nak": "reject"), len));
515         return;
516     }
517     f->reqid = -1;
518
519     switch (f->state) {
520     case CLOSED:
521     case STOPPED:
522         fsm_sdata(f, TERMACK, id, NULL, 0);
523         break;
524
525     case REQSENT:
526     case ACKSENT:
527         /* They didn't agree to what we wanted - try another request */
528         UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
529         fsm_sconfreq(f, 0);             /* Send Configure-Request */
530         break;
531
532     case ACKRCVD:
533         /* Got a Nak/reject when we had already had an Ack?? oh well... */
534         fsm_sconfreq(f, 0);
535         f->state = REQSENT;
536         break;
537
538     case OPENED:
539         /* Go down and restart negotiation */
540         if (f->callbacks->down)
541             (*f->callbacks->down)(f);   /* Inform upper layers */
542         fsm_sconfreq(f, 0);             /* Send initial Configure-Request */
543         f->state = REQSENT;
544         break;
545     }
546 }
547
548
549 /*
550  * fsm_rtermreq - Receive Terminate-Req.
551  */
552 static void
553 fsm_rtermreq(f, id)
554     fsm *f;
555     int id;
556 {
557     FSMDEBUG((LOG_INFO, "fsm_rtermreq(%s): Rcvd id %d.",
558               PROTO_NAME(f), id));
559
560     switch (f->state) {
561     case ACKRCVD:
562     case ACKSENT:
563         f->state = REQSENT;             /* Start over but keep trying */
564         break;
565
566     case OPENED:
567         syslog(LOG_INFO, "%s terminated at peer's request", PROTO_NAME(f));
568         if (f->callbacks->down)
569             (*f->callbacks->down)(f);   /* Inform upper layers */
570         f->retransmits = 0;
571         f->state = STOPPING;
572         TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
573         break;
574     }
575
576     fsm_sdata(f, TERMACK, id, NULL, 0);
577 }
578
579
580 /*
581  * fsm_rtermack - Receive Terminate-Ack.
582  */
583 static void
584 fsm_rtermack(f)
585     fsm *f;
586 {
587     FSMDEBUG((LOG_INFO, "fsm_rtermack(%s).", PROTO_NAME(f)));
588
589     switch (f->state) {
590     case CLOSING:
591         f->state = CLOSED;
592         if( f->callbacks->finished )
593             (*f->callbacks->finished)(f);
594         break;
595     case STOPPING:
596         f->state = STOPPED;
597         if( f->callbacks->finished )
598             (*f->callbacks->finished)(f);
599         break;
600
601     case ACKRCVD:
602         f->state = REQSENT;
603         break;
604
605     case OPENED:
606         if (f->callbacks->down)
607             (*f->callbacks->down)(f);   /* Inform upper layers */
608         fsm_sconfreq(f, 0);
609         break;
610     }
611 }
612
613
614 /*
615  * fsm_rcoderej - Receive an Code-Reject.
616  */
617 static void
618 fsm_rcoderej(f, inp, len)
619     fsm *f;
620     u_char *inp;
621     int len;
622 {
623     u_char code, id;
624
625     FSMDEBUG((LOG_INFO, "fsm_rcoderej(%s).", PROTO_NAME(f)));
626
627     if (len < HEADERLEN) {
628         FSMDEBUG((LOG_INFO, "fsm_rcoderej: Rcvd short Code-Reject packet!"));
629         return;
630     }
631     GETCHAR(code, inp);
632     GETCHAR(id, inp);
633     syslog(LOG_WARNING, "%s: Rcvd Code-Reject for code %d, id %d",
634            PROTO_NAME(f), code, id);
635
636     if( f->state == ACKRCVD )
637         f->state = REQSENT;
638 }
639
640
641 /*
642  * fsm_protreject - Peer doesn't speak this protocol.
643  *
644  * Treat this as a catastrophic error (RXJ-).
645  */
646 void
647 fsm_protreject(f)
648     fsm *f;
649 {
650     switch( f->state ){
651     case CLOSING:
652         UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
653         /* fall through */
654     case CLOSED:
655         f->state = CLOSED;
656         if( f->callbacks->finished )
657             (*f->callbacks->finished)(f);
658         break;
659
660     case STOPPING:
661     case REQSENT:
662     case ACKRCVD:
663     case ACKSENT:
664         UNTIMEOUT(fsm_timeout, (caddr_t) f);    /* Cancel timeout */
665         /* fall through */
666     case STOPPED:
667         f->state = STOPPED;
668         if( f->callbacks->finished )
669             (*f->callbacks->finished)(f);
670         break;
671
672     case OPENED:
673         if( f->callbacks->down )
674             (*f->callbacks->down)(f);
675
676         /* Init restart counter, send Terminate-Request */
677         f->retransmits = f->maxtermtransmits;
678         fsm_sdata(f, TERMREQ, f->reqid = ++f->id, NULL, 0);
679         TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
680         --f->retransmits;
681
682         f->state = STOPPING;
683         break;
684
685     default:
686         FSMDEBUG((LOG_INFO, "%s: Protocol-reject event in state %d!",
687                   PROTO_NAME(f), f->state));
688     }
689 }
690
691
692 /*
693  * fsm_sconfreq - Send a Configure-Request.
694  */
695 static void
696 fsm_sconfreq(f, retransmit)
697     fsm *f;
698     int retransmit;
699 {
700     u_char *outp;
701     int outlen, cilen;
702
703     if( f->state != REQSENT && f->state != ACKRCVD && f->state != ACKSENT ){
704         /* Not currently negotiating - reset options */
705         if( f->callbacks->resetci )
706             (*f->callbacks->resetci)(f);
707         f->nakloops = 0;
708     }
709
710     if( !retransmit ){
711         /* New request - reset retransmission counter, use new ID */
712         f->retransmits = f->maxconfreqtransmits;
713         f->reqid = ++f->id;
714     }
715
716     /*
717      * Make up the request packet
718      */
719     if( f->callbacks->cilen && f->callbacks->addci ){
720         cilen = (*f->callbacks->cilen)(f);
721         if( cilen > peer_mru[f->unit] - HEADERLEN )
722             cilen = peer_mru[f->unit] - HEADERLEN;
723         outp = outpacket_buf + DLLHEADERLEN + HEADERLEN;
724         if (f->callbacks->addci)
725             (*f->callbacks->addci)(f, outp, &cilen);
726     } else
727         cilen = 0;
728
729     /* send the request to our peer */
730     fsm_sdata(f, CONFREQ, f->reqid, outp, cilen);
731
732     /* start the retransmit timer */
733     --f->retransmits;
734     TIMEOUT(fsm_timeout, (caddr_t) f, f->timeouttime);
735
736     FSMDEBUG((LOG_INFO, "%s: sending Configure-Request, id %d",
737               PROTO_NAME(f), f->reqid));
738 }
739
740
741 /*
742  * fsm_sdata - Send some data.
743  *
744  * Used for all packets sent to our peer by this module.
745  */
746 void
747 fsm_sdata(f, code, id, data, datalen)
748     fsm *f;
749     u_char code, id;
750     u_char *data;
751     int datalen;
752 {
753     u_char *outp;
754     int outlen;
755
756     /* Adjust length to be smaller than MTU */
757     outp = outpacket_buf;
758     if (datalen > peer_mru[f->unit] - HEADERLEN)
759         datalen = peer_mru[f->unit] - HEADERLEN;
760     if (datalen && data != outp + DLLHEADERLEN + HEADERLEN)
761         BCOPY(data, outp + DLLHEADERLEN + HEADERLEN, datalen);
762     outlen = datalen + HEADERLEN;
763     MAKEHEADER(outp, f->protocol);
764     PUTCHAR(code, outp);
765     PUTCHAR(id, outp);
766     PUTSHORT(outlen, outp);
767     output(f->unit, outpacket_buf, outlen + DLLHEADERLEN);
768
769     FSMDEBUG((LOG_INFO, "fsm_sdata(%s): Sent code %d, id %d.",
770               PROTO_NAME(f), code, id));
771 }