2 * Copyright (c) 1998 Brian Somers <brian@Awfulhak.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/param.h>
40 #include "descriptor.h"
45 #include "throughput.h"
60 cbcp_Init(struct cbcp *cbcp, struct physical *p)
63 cbcp->fsm.state = CBCP_CLOSED;
66 *cbcp->fsm.phone = '\0';
67 memset(&cbcp->fsm.timer, '\0', sizeof cbcp->fsm.timer);
71 static void cbcp_SendReq(struct cbcp *);
72 static void cbcp_SendResponse(struct cbcp *);
73 static void cbcp_SendAck(struct cbcp *);
78 struct cbcp *cbcp = (struct cbcp *)v;
80 timer_Stop(&cbcp->fsm.timer);
81 if (cbcp->fsm.restart) {
82 switch (cbcp->fsm.state) {
85 log_Printf(LogCBCP, "%s: Urk - unexpected CBCP timeout !\n",
93 cbcp_SendResponse(cbcp);
102 switch (cbcp->fsm.state) {
113 missed = "Terminate REQ";
116 log_Printf(LogCBCP, "%s: Urk - unexpected CBCP timeout !\n",
122 log_Printf(LogCBCP, "%s: Timeout waiting for peer %s\n",
123 cbcp->p->dl->name, missed);
124 datalink_CBCPFailed(cbcp->p->dl);
129 cbcp_StartTimer(struct cbcp *cbcp, int timeout)
131 timer_Stop(&cbcp->fsm.timer);
132 cbcp->fsm.timer.func = cbcp_Timeout;
133 cbcp->fsm.timer.name = "cbcp";
134 cbcp->fsm.timer.load = timeout * SECTICKS;
135 cbcp->fsm.timer.arg = cbcp;
136 timer_Start(&cbcp->fsm.timer);
139 #define CBCP_CLOSED (0) /* Not in use */
140 #define CBCP_STOPPED (1) /* Waiting for a REQ */
141 #define CBCP_REQSENT (2) /* Waiting for a RESP */
142 #define CBCP_RESPSENT (3) /* Waiting for an ACK */
143 #define CBCP_ACKSENT (4) /* Waiting for an LCP Term REQ */
145 static const char *cbcpname[] = {
146 "closed", "stopped", "req-sent", "resp-sent", "ack-sent"
152 if (s < sizeof cbcpname / sizeof cbcpname[0])
158 cbcp_NewPhase(struct cbcp *cbcp, int new)
160 if (cbcp->fsm.state != new) {
161 log_Printf(LogCBCP, "%s: State change %s --> %s\n", cbcp->p->dl->name,
162 cbcpstate(cbcp->fsm.state), cbcpstate(new));
163 cbcp->fsm.state = new;
170 u_int16_t length; /* Network byte order */
174 /* cbcp_header::code values */
176 #define CBCP_RESPONSE (2)
183 char addr_start[253]; /* max cbcp_data length 255 + 1 for NULL */
186 /* cbcp_data::type values */
187 #define CBCP_NONUM (1)
188 #define CBCP_CLIENTNUM (2)
189 #define CBCP_SERVERNUM (3)
190 #define CBCP_LISTNUM (4)
193 cbcp_Output(struct cbcp *cbcp, u_char code, struct cbcp_data *data)
195 struct cbcp_header *head;
198 bp = mbuf_Alloc(sizeof *head + data->length, MB_CBCPOUT);
199 head = (struct cbcp_header *)MBUF_CTOP(bp);
201 head->id = cbcp->fsm.id;
202 head->length = htons(sizeof *head + data->length);
203 memcpy(MBUF_CTOP(bp) + sizeof *head, data, data->length);
204 log_DumpBp(LogDEBUG, "cbcp_Output", bp);
205 link_PushPacket(&cbcp->p->link, bp, cbcp->p->dl->bundle,
206 LINK_QUEUES(&cbcp->p->link) - 1, PROTO_CBCP);
210 cbcp_data_Type(int type)
212 static const char *types[] = {
213 "No callback", "User-spec", "Server-spec", "list"
216 if (type < 1 || type > sizeof types / sizeof types[0])
218 return types[type-1];
223 char addr[1]; /* Really ASCIIZ */
226 /* cbcp_data::type values */
227 #define CBCP_ADDR_PSTN (1)
230 cbcp_data_Show(struct cbcp_data *data)
232 struct cbcp_addr *addr;
235 addr = (struct cbcp_addr *)data->addr_start;
236 end = (char *)data + data->length;
239 log_Printf(LogCBCP, " TYPE %s\n", cbcp_data_Type(data->type));
240 if ((char *)&data->delay < end) {
241 log_Printf(LogCBCP, " DELAY %d\n", data->delay);
242 while (addr->addr < end) {
243 if (addr->type == CBCP_ADDR_PSTN)
244 log_Printf(LogCBCP, " ADDR %s\n", addr->addr);
246 log_Printf(LogCBCP, " ADDR type %d ??\n", (int)addr->type);
247 addr = (struct cbcp_addr *)(addr->addr + strlen(addr->addr) + 1);
253 cbcp_SendReq(struct cbcp *cbcp)
255 struct cbcp_data data;
256 struct cbcp_addr *addr;
257 char list[sizeof cbcp->fsm.phone], *next;
260 /* Only callees send REQs */
262 log_Printf(LogCBCP, "%s: SendReq(%d) state = %s\n", cbcp->p->dl->name,
263 cbcp->fsm.id, cbcpstate(cbcp->fsm.state));
264 data.type = cbcp->fsm.type;
266 strncpy(list, cbcp->fsm.phone, sizeof list - 1);
267 list[sizeof list - 1] = '\0';
271 addr = (struct cbcp_addr *)data.addr_start;
272 addr->type = CBCP_ADDR_PSTN;
274 data.length = addr->addr - (char *)&data;
278 addr = (struct cbcp_addr *)data.addr_start;
279 for (next = strtok(list, ","); next; next = strtok(NULL, ",")) {
281 max = data.addr_start + sizeof data.addr_start - addr->addr - 1;
283 addr->type = CBCP_ADDR_PSTN;
284 strcpy(addr->addr, next);
285 addr = (struct cbcp_addr *)((char *)addr + len + 2);
287 log_Printf(LogWARN, "CBCP ADDR \"%s\" skipped - packet too large\n",
290 data.length = (char *)addr - (char *)&data;
294 data.length = data.addr_start - (char *)&data;
298 data.length = (char *)&data.delay - (char *)&data;
302 cbcp_data_Show(&data);
303 cbcp_Output(cbcp, CBCP_REQ, &data);
305 cbcp_StartTimer(cbcp, cbcp->fsm.delay);
306 cbcp_NewPhase(cbcp, CBCP_REQSENT); /* Wait for a RESPONSE */
310 cbcp_Up(struct cbcp *cbcp)
312 struct lcp *lcp = &cbcp->p->link.lcp;
314 cbcp->fsm.delay = cbcp->p->dl->cfg.cbcp.delay;
315 if (*cbcp->p->dl->peer.authname == '\0' ||
316 !auth_SetPhoneList(cbcp->p->dl->peer.authname, cbcp->fsm.phone,
317 sizeof cbcp->fsm.phone)) {
318 strncpy(cbcp->fsm.phone, cbcp->p->dl->cfg.cbcp.phone,
319 sizeof cbcp->fsm.phone - 1);
320 cbcp->fsm.phone[sizeof cbcp->fsm.phone - 1] = '\0';
323 if (lcp->want_callback.opmask) {
324 if (*cbcp->fsm.phone == '\0')
325 cbcp->fsm.type = CBCP_NONUM;
326 else if (!strcmp(cbcp->fsm.phone, "*")) {
327 cbcp->fsm.type = CBCP_SERVERNUM;
328 *cbcp->fsm.phone = '\0';
330 cbcp->fsm.type = CBCP_CLIENTNUM;
331 cbcp_NewPhase(cbcp, CBCP_STOPPED); /* Wait for a REQ */
332 cbcp_StartTimer(cbcp, cbcp->fsm.delay * DEF_FSMTRIES);
334 if (*cbcp->fsm.phone == '\0')
335 cbcp->fsm.type = CBCP_NONUM;
336 else if (!strcmp(cbcp->fsm.phone, "*")) {
337 cbcp->fsm.type = CBCP_CLIENTNUM;
338 *cbcp->fsm.phone = '\0';
339 } else if (strchr(cbcp->fsm.phone, ','))
340 cbcp->fsm.type = CBCP_LISTNUM;
342 cbcp->fsm.type = CBCP_SERVERNUM;
343 cbcp->fsm.restart = DEF_FSMTRIES;
349 cbcp_AdjustResponse(struct cbcp *cbcp, struct cbcp_data *data)
352 * We've received a REQ (data). Adjust our reponse (cbcp->fsm.*)
353 * so that we (hopefully) agree with the peer
355 struct cbcp_addr *addr;
357 switch (data->type) {
359 if (cbcp->p->dl->cfg.callback.opmask & CALLBACK_BIT(CALLBACK_NONE))
361 * if ``none'' is a configured callback possibility
362 * (ie, ``set callback cbcp none''), go along with the callees
365 cbcp->fsm.type = CBCP_NONUM;
368 * Otherwise, we send our desired response anyway. This seems to be
369 * what Win95 does - although I can't find this behaviour documented
370 * in the CBCP spec....
376 if (cbcp->fsm.type == CBCP_CLIENTNUM) {
379 if (data->length > data->addr_start - (char *)data) {
381 * The peer has given us an address type spec - make sure we
384 addr = (struct cbcp_addr *)data->addr_start;
385 if (addr->type != CBCP_ADDR_PSTN) {
386 log_Printf(LogPHASE, "CBCP: Unrecognised address type %d !\n",
391 /* we accept the REQ even if the peer didn't specify an addr->type */
392 ptr = strchr(cbcp->fsm.phone, ',');
394 *ptr = '\0'; /* Just use the first number in our list */
397 log_Printf(LogPHASE, "CBCP: no number to pass to the peer !\n");
401 if (cbcp->fsm.type == CBCP_SERVERNUM) {
402 *cbcp->fsm.phone = '\0';
405 if (data->length > data->addr_start - (char *)data) {
407 * This violates the spec, but if the peer has told us the
408 * number it wants to call back, take advantage of this fact
409 * and allow things to proceed if we've specified the same
412 addr = (struct cbcp_addr *)data->addr_start;
413 if (addr->type != CBCP_ADDR_PSTN) {
414 log_Printf(LogPHASE, "CBCP: Unrecognised address type %d !\n",
417 } else if (cbcp->fsm.type == CBCP_CLIENTNUM) {
419 * If the peer's insisting on deciding the number, make sure
420 * it's one of the ones in our list. If it is, let the peer
421 * think it's in control :-)
423 char list[sizeof cbcp->fsm.phone], *next;
425 strncpy(list, cbcp->fsm.phone, sizeof list - 1);
426 list[sizeof list - 1] = '\0';
427 for (next = strtok(list, ","); next; next = strtok(NULL, ","))
428 if (!strcmp(next, addr->addr)) {
429 cbcp->fsm.type = CBCP_SERVERNUM;
430 strcpy(cbcp->fsm.phone, next);
435 log_Printf(LogPHASE, "CBCP: Peer won't allow local decision !\n");
439 if (cbcp->fsm.type == CBCP_CLIENTNUM || cbcp->fsm.type == CBCP_LISTNUM) {
441 * Search through ``data''s addresses and see if cbcp->fsm.phone
442 * contains any of them
444 char list[sizeof cbcp->fsm.phone], *next, *end;
446 addr = (struct cbcp_addr *)data->addr_start;
447 end = (char *)data + data->length;
449 while (addr->addr < end) {
450 if (addr->type == CBCP_ADDR_PSTN) {
451 strncpy(list, cbcp->fsm.phone, sizeof list - 1);
452 list[sizeof list - 1] = '\0';
453 for (next = strtok(list, ","); next; next = strtok(NULL, ","))
454 if (!strcmp(next, addr->addr)) {
455 cbcp->fsm.type = CBCP_LISTNUM;
456 strcpy(cbcp->fsm.phone, next);
460 log_Printf(LogCBCP, "Warning: Unrecognised address type %d !\n",
462 addr = (struct cbcp_addr *)(addr->addr + strlen(addr->addr) + 1);
465 log_Printf(LogPHASE, "CBCP: no good number to pass to the peer !\n");
469 log_Printf(LogCBCP, "Unrecognised REQ type %d !\n", (int)data->type);
474 cbcp_SendResponse(struct cbcp *cbcp)
476 struct cbcp_data data;
477 struct cbcp_addr *addr;
479 /* Only callers send RESPONSEs */
481 log_Printf(LogCBCP, "%s: SendResponse(%d) state = %s\n", cbcp->p->dl->name,
482 cbcp->fsm.id, cbcpstate(cbcp->fsm.state));
484 data.type = cbcp->fsm.type;
485 data.delay = cbcp->fsm.delay;
486 addr = (struct cbcp_addr *)data.addr_start;
487 if (data.type == CBCP_NONUM)
488 data.length = (char *)&data.delay - (char *)&data;
489 else if (*cbcp->fsm.phone) {
490 addr->type = CBCP_ADDR_PSTN;
491 strcpy(addr->addr, cbcp->fsm.phone);
492 data.length = (addr->addr + strlen(addr->addr) + 1) - (char *)&data;
494 data.length = data.addr_start - (char *)&data;
496 cbcp_data_Show(&data);
497 cbcp_Output(cbcp, CBCP_RESPONSE, &data);
499 cbcp_StartTimer(cbcp, cbcp->fsm.delay);
500 cbcp_NewPhase(cbcp, CBCP_RESPSENT); /* Wait for an ACK */
503 /* What to do after checking an incoming response */
504 #define CBCP_ACTION_DOWN (0)
505 #define CBCP_ACTION_REQ (1)
506 #define CBCP_ACTION_ACK (2)
509 cbcp_CheckResponse(struct cbcp *cbcp, struct cbcp_data *data)
512 * We've received a RESPONSE (data). Check if it agrees with
513 * our REQ (cbcp->fsm)
515 struct cbcp_addr *addr;
517 addr = (struct cbcp_addr *)data->addr_start;
519 if (data->type == cbcp->fsm.type) {
520 switch (cbcp->fsm.type) {
522 return CBCP_ACTION_ACK;
525 if ((char *)data + data->length <= addr->addr)
526 log_Printf(LogPHASE, "CBCP: peer didn't respond with a number !\n");
527 else if (addr->type != CBCP_ADDR_PSTN)
528 log_Printf(LogPHASE, "CBCP: Unrecognised address type %d !\n",
531 strcpy(cbcp->fsm.phone, addr->addr);
532 cbcp->fsm.delay = data->delay;
533 return CBCP_ACTION_ACK;
535 return CBCP_ACTION_DOWN;
538 cbcp->fsm.delay = data->delay;
539 return CBCP_ACTION_ACK;
542 if ((char *)data + data->length <= addr->addr)
543 log_Printf(LogPHASE, "CBCP: peer didn't respond with a number !\n");
544 else if (addr->type != CBCP_ADDR_PSTN)
545 log_Printf(LogPHASE, "CBCP: Unrecognised address type %d !\n",
548 char list[sizeof cbcp->fsm.phone], *next;
550 strncpy(list, cbcp->fsm.phone, sizeof list - 1);
551 list[sizeof list - 1] = '\0';
552 for (next = strtok(list, ","); next; next = strtok(NULL, ","))
553 if (!strcmp(addr->addr, next)) {
554 strcpy(cbcp->fsm.phone, next);
555 cbcp->fsm.delay = data->delay;
556 return CBCP_ACTION_ACK;
558 log_Printf(LogPHASE, "CBCP: peer didn't respond with a "
561 return CBCP_ACTION_DOWN;
563 log_Printf(LogPHASE, "Internal CBCP error - agreed on %d ??!?\n",
564 (int)cbcp->fsm.type);
565 return CBCP_ACTION_DOWN;
566 } else if (data->type == CBCP_NONUM && cbcp->fsm.type == CBCP_CLIENTNUM) {
568 * Client doesn't want CBCP after all....
569 * We only allow this when ``set cbcp *'' has been specified.
571 cbcp->fsm.type = CBCP_NONUM;
572 return CBCP_ACTION_ACK;
574 log_Printf(LogCBCP, "Invalid peer RESPONSE\n");
575 return CBCP_ACTION_REQ;
579 cbcp_SendAck(struct cbcp *cbcp)
581 struct cbcp_data data;
582 struct cbcp_addr *addr;
584 /* Only callees send ACKs */
586 log_Printf(LogCBCP, "%s: SendAck(%d) state = %s\n", cbcp->p->dl->name,
587 cbcp->fsm.id, cbcpstate(cbcp->fsm.state));
589 data.type = cbcp->fsm.type;
592 data.length = (char *)&data.delay - (char *)&data;
595 addr = (struct cbcp_addr *)data.addr_start;
596 addr->type = CBCP_ADDR_PSTN;
597 strcpy(addr->addr, cbcp->fsm.phone);
598 data.delay = cbcp->fsm.delay;
599 data.length = addr->addr + strlen(addr->addr) + 1 - (char *)&data;
602 data.delay = cbcp->fsm.delay;
603 data.length = data.addr_start - (char *)&data;
607 cbcp_data_Show(&data);
608 cbcp_Output(cbcp, CBCP_ACK, &data);
610 cbcp_StartTimer(cbcp, cbcp->fsm.delay);
611 cbcp_NewPhase(cbcp, CBCP_ACKSENT); /* Wait for an ACK */
615 cbcp_Input(struct bundle *bundle, struct link *l, struct mbuf *bp)
617 struct physical *p = link2physical(l);
618 struct cbcp_header *head;
619 struct cbcp_data *data;
620 struct cbcp *cbcp = &p->dl->cbcp;
624 log_Printf(LogERROR, "cbcp_Input: Not a physical link - dropped\n");
629 bp = mbuf_Contiguous(bp);
630 len = mbuf_Length(bp);
631 if (len < sizeof(struct cbcp_header)) {
635 head = (struct cbcp_header *)MBUF_CTOP(bp);
636 if (ntohs(head->length) != len) {
637 log_Printf(LogWARN, "Corrupt CBCP packet (code %d, length %d not %d)"
638 " - ignored\n", head->code, ntohs(head->length), len);
642 mbuf_SetType(bp, MB_CBCPIN);
644 /* XXX check the id */
646 bp->offset += sizeof(struct cbcp_header);
647 bp->cnt -= sizeof(struct cbcp_header);
648 data = (struct cbcp_data *)MBUF_CTOP(bp);
650 switch (head->code) {
652 log_Printf(LogCBCP, "%s: RecvReq(%d) state = %s\n",
653 p->dl->name, head->id, cbcpstate(cbcp->fsm.state));
654 cbcp_data_Show(data);
655 if (cbcp->fsm.state == CBCP_STOPPED || cbcp->fsm.state == CBCP_RESPSENT) {
656 timer_Stop(&cbcp->fsm.timer);
657 if (cbcp_AdjustResponse(cbcp, data)) {
658 cbcp->fsm.restart = DEF_FSMTRIES;
659 cbcp->fsm.id = head->id;
660 cbcp_SendResponse(cbcp);
662 datalink_CBCPFailed(cbcp->p->dl);
664 log_Printf(LogCBCP, "%s: unexpected REQ dropped\n", p->dl->name);
668 log_Printf(LogCBCP, "%s: RecvResponse(%d) state = %s\n",
669 p->dl->name, head->id, cbcpstate(cbcp->fsm.state));
670 cbcp_data_Show(data);
671 if (cbcp->fsm.id != head->id) {
672 log_Printf(LogCBCP, "Warning: Expected id was %d, not %d\n",
673 cbcp->fsm.id, head->id);
674 cbcp->fsm.id = head->id;
676 if (cbcp->fsm.state == CBCP_REQSENT || cbcp->fsm.state == CBCP_ACKSENT) {
677 timer_Stop(&cbcp->fsm.timer);
678 switch (cbcp_CheckResponse(cbcp, data)) {
679 case CBCP_ACTION_REQ:
683 case CBCP_ACTION_ACK:
684 cbcp->fsm.restart = DEF_FSMTRIES;
686 if (cbcp->fsm.type == CBCP_NONUM) {
688 * Don't change state in case the peer doesn't get our ACK,
689 * just bring the layer up.
691 timer_Stop(&cbcp->fsm.timer);
692 datalink_NCPUp(cbcp->p->dl);
697 datalink_CBCPFailed(cbcp->p->dl);
701 log_Printf(LogCBCP, "%s: unexpected RESPONSE dropped\n", p->dl->name);
705 log_Printf(LogCBCP, "%s: RecvAck(%d) state = %s\n",
706 p->dl->name, head->id, cbcpstate(cbcp->fsm.state));
707 cbcp_data_Show(data);
708 if (cbcp->fsm.id != head->id) {
709 log_Printf(LogCBCP, "Warning: Expected id was %d, not %d\n",
710 cbcp->fsm.id, head->id);
711 cbcp->fsm.id = head->id;
713 if (cbcp->fsm.type == CBCP_NONUM) {
715 * Don't change state in case the peer doesn't get our ACK,
716 * just bring the layer up.
718 timer_Stop(&cbcp->fsm.timer);
719 datalink_NCPUp(cbcp->p->dl);
720 } else if (cbcp->fsm.state == CBCP_RESPSENT) {
721 timer_Stop(&cbcp->fsm.timer);
722 datalink_CBCPComplete(cbcp->p->dl);
723 log_Printf(LogPHASE, "%s: CBCP: Peer will dial back\n", p->dl->name);
725 log_Printf(LogCBCP, "%s: unexpected ACK dropped\n", p->dl->name);
729 log_Printf(LogWARN, "Unrecognised CBCP packet (code %d, length %d)\n",
739 cbcp_Down(struct cbcp *cbcp)
741 timer_Stop(&cbcp->fsm.timer);
742 cbcp_NewPhase(cbcp, CBCP_CLOSED);
747 cbcp_ReceiveTerminateReq(struct physical *p)
749 if (p->dl->cbcp.fsm.state == CBCP_ACKSENT) {
750 /* Don't change our state in case the peer doesn't get the ACK */
751 p->dl->cbcp.required = 1;
752 log_Printf(LogPHASE, "%s: CBCP: Will dial back on %s\n", p->dl->name,
753 p->dl->cbcp.fsm.phone);
755 cbcp_NewPhase(&p->dl->cbcp, CBCP_CLOSED);