2 * ccp.c - PPP Compression Control Protocol.
4 * Copyright (c) 1994 The Australian National University.
7 * Permission to use, copy, modify, and distribute this software and its
8 * documentation is hereby granted, provided that the above copyright
9 * notice appears in all copies. This software is provided without any
10 * warranty, express or implied. The Australian National University
11 * makes no representations about the suitability of this software for
14 * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
15 * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
16 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
17 * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
20 * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
21 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
22 * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
23 * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
24 * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
29 static char rcsid[] = "$Id: ccp.c,v 1.10 1995/06/06 01:52:23 paulus Exp $";
33 #include <sys/ioctl.h>
34 #include <net/ppp-comp.h>
41 ccp_options ccp_wantoptions[NUM_PPP]; /* what to request the peer to use */
42 ccp_options ccp_gotoptions[NUM_PPP]; /* what the peer agreed to do */
43 ccp_options ccp_allowoptions[NUM_PPP]; /* what we'll agree to do */
44 ccp_options ccp_hisoptions[NUM_PPP]; /* what we agreed to do */
47 * Callbacks for fsm code.
49 static void ccp_resetci __P((fsm *));
50 static int ccp_cilen __P((fsm *));
51 static void ccp_addci __P((fsm *, u_char *, int *));
52 static int ccp_ackci __P((fsm *, u_char *, int));
53 static int ccp_nakci __P((fsm *, u_char *, int));
54 static int ccp_rejci __P((fsm *, u_char *, int));
55 static int ccp_reqci __P((fsm *, u_char *, int *, int));
56 static void ccp_up __P((fsm *));
57 static void ccp_down __P((fsm *));
58 static int ccp_extcode __P((fsm *, int, int, u_char *, int));
59 static void ccp_rack_timeout __P(());
61 static fsm_callbacks ccp_callbacks = {
80 * Do we want / did we get any compression?
82 #define ANY_COMPRESS(opt) ((opt).bsd_compress)
85 * Local state (mainly for handling reset-reqs and reset-acks
87 static int ccp_localstate[NUM_PPP];
88 #define RACK_PENDING 1 /* waiting for reset-ack */
89 #define RREQ_REPEAT 2 /* send another reset-req if no reset-ack */
91 #define RACKTIMEOUT 1 /* second */
94 * ccp_init - initialize CCP.
100 fsm *f = &ccp_fsm[unit];
103 f->protocol = PPP_CCP;
104 f->callbacks = &ccp_callbacks;
107 memset(&ccp_wantoptions[unit], 0, sizeof(ccp_options));
108 memset(&ccp_gotoptions[unit], 0, sizeof(ccp_options));
109 memset(&ccp_allowoptions[unit], 0, sizeof(ccp_options));
110 memset(&ccp_hisoptions[unit], 0, sizeof(ccp_options));
112 ccp_wantoptions[0].bsd_compress = 1;
113 ccp_wantoptions[0].bsd_bits = 12; /* default value */
115 ccp_allowoptions[0].bsd_compress = 1;
116 ccp_allowoptions[0].bsd_bits = BSD_MAX_BITS;
120 * ccp_open - CCP is allowed to come up.
126 fsm *f = &ccp_fsm[unit];
128 if (f->state != OPENED)
129 ccp_flags_set(unit, 1, 0);
130 if (!ANY_COMPRESS(ccp_wantoptions[unit]))
131 f->flags |= OPT_SILENT;
136 * ccp_close - Terminate CCP.
142 ccp_flags_set(unit, 0, 0);
143 fsm_close(&ccp_fsm[unit]);
147 * ccp_lowerup - we may now transmit CCP packets.
153 fsm_lowerup(&ccp_fsm[unit]);
157 * ccp_lowerdown - we may not transmit CCP packets.
163 fsm_lowerdown(&ccp_fsm[unit]);
167 * ccp_input - process a received CCP packet.
170 ccp_input(unit, p, len)
175 fsm *f = &ccp_fsm[unit];
179 * Check for a terminate-request so we can print a message.
182 fsm_input(f, p, len);
183 if (oldstate == OPENED && p[0] == TERMREQ && f->state != OPENED)
184 syslog(LOG_NOTICE, "Compression disabled by peer.");
188 * Handle a CCP-specific code.
191 ccp_extcode(f, code, id, p, len)
199 if (f->state != OPENED)
201 /* send a reset-ack, which the transmitter will see and
202 reset its compression state. */
203 fsm_sdata(f, CCP_RESETACK, id, NULL, 0);
207 if (ccp_localstate[f->unit] & RACK_PENDING && id == f->reqid) {
208 ccp_localstate[f->unit] &= ~(RACK_PENDING | RREQ_REPEAT);
209 UNTIMEOUT(ccp_rack_timeout, (caddr_t) f);
221 * ccp_protrej - peer doesn't talk CCP.
227 ccp_flags_set(unit, 0, 0);
228 fsm_lowerdown(&ccp_fsm[unit]);
232 * ccp_resetci - initialize at start of negotiation.
238 ccp_options *go = &ccp_gotoptions[f->unit];
241 *go = ccp_wantoptions[f->unit];
242 if (go->bsd_compress) {
243 opt_buf[0] = CI_BSD_COMPRESS;
244 opt_buf[1] = CILEN_BSD_COMPRESS;
245 opt_buf[2] = BSD_MAKE_OPT(BSD_CURRENT_VERSION, go->bsd_bits);
246 if (!ccp_test(f->unit, opt_buf, CILEN_BSD_COMPRESS, 0))
247 go->bsd_compress = 0;
252 * ccp_cilen - Return total length of our configuration info.
258 ccp_options *go = &ccp_gotoptions[f->unit];
260 return (go->bsd_compress? CILEN_BSD_COMPRESS: 0);
264 * ccp_addci - put our requests in a packet.
267 ccp_addci(f, p, lenp)
272 ccp_options *go = &ccp_gotoptions[f->unit];
275 if (go->bsd_compress) {
276 p[0] = CI_BSD_COMPRESS;
277 p[1] = CILEN_BSD_COMPRESS;
278 p[2] = BSD_MAKE_OPT(BSD_CURRENT_VERSION, go->bsd_bits);
279 if (ccp_test(f->unit, p, CILEN_BSD_COMPRESS, 0))
280 p += CILEN_BSD_COMPRESS;
282 go->bsd_compress = 0;
288 * ccp_ackci - process a received configure-ack, and return
289 * 1 iff the packet was OK.
297 ccp_options *go = &ccp_gotoptions[f->unit];
299 if (go->bsd_compress) {
300 if (len < CILEN_BSD_COMPRESS
301 || p[0] != CI_BSD_COMPRESS || p[1] != CILEN_BSD_COMPRESS
302 || p[2] != BSD_MAKE_OPT(BSD_CURRENT_VERSION, go->bsd_bits))
304 p += CILEN_BSD_COMPRESS;
305 len -= CILEN_BSD_COMPRESS;
313 * ccp_nakci - process received configure-nak.
314 * Returns 1 iff the nak was OK.
322 ccp_options *go = &ccp_gotoptions[f->unit];
323 ccp_options no; /* options we've seen already */
324 ccp_options try; /* options to ask for next time */
326 memset(&no, 0, sizeof(no));
329 if (go->bsd_compress && !no.bsd_compress && len >= CILEN_BSD_COMPRESS
330 && p[0] == CI_BSD_COMPRESS && p[1] == CILEN_BSD_COMPRESS) {
333 * Peer wants us to use a different number of bits
334 * or a different version.
336 if (BSD_VERSION(p[2]) != BSD_CURRENT_VERSION)
337 try.bsd_compress = 0;
338 else if (BSD_NBITS(p[2]) < go->bsd_bits)
339 try.bsd_bits = BSD_NBITS(p[2]);
340 p += CILEN_BSD_COMPRESS;
341 len -= CILEN_BSD_COMPRESS;
345 * Have a look at any remaining options...???
351 if (f->state != OPENED)
357 * ccp_rejci - reject some of our suggested compression methods.
365 ccp_options *go = &ccp_gotoptions[f->unit];
366 ccp_options try; /* options to request next time */
370 if (go->bsd_compress && len >= CILEN_BSD_COMPRESS
371 && p[0] == CI_BSD_COMPRESS && p[1] == CILEN_BSD_COMPRESS) {
372 if (p[2] != BSD_MAKE_OPT(BSD_CURRENT_VERSION, go->bsd_bits))
374 try.bsd_compress = 0;
375 p += CILEN_BSD_COMPRESS;
376 len -= CILEN_BSD_COMPRESS;
382 if (f->state != OPENED)
389 * ccp_reqci - processed a received configure-request.
390 * Returns CONFACK, CONFNAK or CONFREJ and the packet modified
394 ccp_reqci(f, p, lenp, dont_nak)
402 int len, clen, type, nb;
403 ccp_options *ho = &ccp_hisoptions[f->unit];
404 ccp_options *ao = &ccp_allowoptions[f->unit];
410 memset(ho, 0, sizeof(ccp_options));
414 if (len < 2 || p[1] < 2 || p[1] > len) {
424 case CI_BSD_COMPRESS:
425 if (!ao->bsd_compress || clen != CILEN_BSD_COMPRESS) {
430 ho->bsd_compress = 1;
431 ho->bsd_bits = nb = BSD_NBITS(p[2]);
432 if (BSD_VERSION(p[2]) != BSD_CURRENT_VERSION
433 || nb > ao->bsd_bits) {
436 } else if (nb < BSD_MIN_BITS) {
438 } else if (!ccp_test(f->unit, p, CILEN_BSD_COMPRESS, 1)) {
439 if (nb > BSD_MIN_BITS) {
445 if (newret == CONFNAK && !dont_nak) {
446 p[2] = BSD_MAKE_OPT(BSD_CURRENT_VERSION, nb);
456 if (newret == CONFNAK && dont_nak)
458 if (!(newret == CONFACK || newret == CONFNAK && ret == CONFREJ)) {
459 /* we're returning this option */
460 if (newret == CONFREJ && ret == CONFNAK)
464 BCOPY(p, retp, clen);
478 * CCP has come up - inform the kernel driver.
484 ccp_options *go = &ccp_gotoptions[f->unit];
485 ccp_options *ho = &ccp_hisoptions[f->unit];
487 ccp_flags_set(f->unit, 1, 1);
488 if (go->bsd_compress || ho->bsd_compress)
489 syslog(LOG_NOTICE, "%s enabled",
490 go->bsd_compress? ho->bsd_compress? "Compression":
491 "Receive compression": "Transmit compression");
495 * CCP has gone down - inform the kernel driver.
501 if (ccp_localstate[f->unit] & RACK_PENDING)
502 UNTIMEOUT(ccp_rack_timeout, (caddr_t) f);
503 ccp_localstate[f->unit] = 0;
504 ccp_flags_set(f->unit, 1, 0);
508 * Print the contents of a CCP packet.
510 char *ccp_codenames[] = {
511 "ConfReq", "ConfAck", "ConfNak", "ConfRej",
512 "TermReq", "TermAck", "CodeRej",
513 NULL, NULL, NULL, NULL, NULL, NULL,
514 "ResetReq", "ResetAck",
518 ccp_printpkt(p, plen, printer, arg)
521 void (*printer) __P((void *, char *, ...));
529 if (plen < HEADERLEN)
533 len = (p[2] << 8) + p[3];
534 if (len < HEADERLEN || len > plen)
537 if (code >= 1 && code <= sizeof(ccp_codenames) / sizeof(char *)
538 && ccp_codenames[code-1] != NULL)
539 printer(arg, " %s", ccp_codenames[code-1]);
541 printer(arg, " code=0x%x", code);
542 printer(arg, " id=0x%x", id);
551 /* print list of possible compression methods */
555 if (optlen < 2 || optlen > len)
561 case CI_BSD_COMPRESS:
562 if (optlen >= CILEN_BSD_COMPRESS) {
563 printer(arg, "bsd v%d %d", BSD_VERSION(p[2]),
565 p += CILEN_BSD_COMPRESS;
570 printer(arg, " %.2x", *p++);
576 /* dump out the rest of the packet in hex */
578 printer(arg, " %.2x", *p++);
584 * We have received a packet that the decompressor failed to
585 * decompress. Here we would expect to issue a reset-request, but
586 * Motorola has a patent on resetting the compressor as a result of
587 * detecting an error in the decompressed data after decompression.
588 * (See US patent 5,130,993; international patent publication number
589 * WO 91/10289; Australian patent 73296/91.)
591 * So we ask the kernel whether the error was detected after
592 * decompression; if it was, we take CCP down, thus disabling
593 * compression :-(, otherwise we issue the reset-request.
596 ccp_datainput(unit, pkt, len)
604 if (f->state == OPENED) {
605 if (ccp_fatal_error(unit)) {
607 * Disable compression by taking CCP down.
609 syslog(LOG_ERR, "Lost compression sync: disabling compression");
613 * Send a reset-request to reset the peer's compressor.
614 * We don't do that if we are still waiting for an
615 * acknowledgement to a previous reset-request.
617 if (!(ccp_localstate[f->unit] & RACK_PENDING)) {
618 fsm_sdata(f, CCP_RESETREQ, f->reqid = ++f->id, NULL, 0);
619 TIMEOUT(ccp_rack_timeout, (caddr_t) f, RACKTIMEOUT);
620 ccp_localstate[f->unit] |= RACK_PENDING;
622 ccp_localstate[f->unit] |= RREQ_REPEAT;
628 * Timeout waiting for reset-ack.
631 ccp_rack_timeout(arg)
634 fsm *f = (fsm *) arg;
636 if (f->state == OPENED && ccp_localstate[f->unit] & RREQ_REPEAT) {
637 fsm_sdata(f, CCP_RESETREQ, f->reqid, NULL, 0);
638 TIMEOUT(ccp_rack_timeout, (caddr_t) f, RACKTIMEOUT);
639 ccp_localstate[f->unit] &= ~RREQ_REPEAT;
641 ccp_localstate[f->unit] &= ~RACK_PENDING;