2 * Copyright (c) 1996-2003
3 * Fraunhofer Institute for Open Communication Systems (FhG Fokus).
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * Author: Hartmut Brandt <harti@freebsd.org>
29 * $Begemot: libunimsg/netnatm/saal/saal_sscfu.c,v 1.4 2004/07/08 08:22:10 brandt Exp $
34 #include <netnatm/saal/sscfu.h>
35 #include <netnatm/saal/sscfupriv.h>
39 static const char *const sscf_sigs[] = {
40 MKSTR(SAAL_ESTABLISH_request),
41 MKSTR(SAAL_ESTABLISH_indication),
42 MKSTR(SAAL_ESTABLISH_confirm),
43 MKSTR(SAAL_RELEASE_request),
44 MKSTR(SAAL_RELEASE_confirm),
45 MKSTR(SAAL_RELEASE_indication),
46 MKSTR(SAAL_DATA_request),
47 MKSTR(SAAL_DATA_indication),
48 MKSTR(SAAL_UDATA_request),
49 MKSTR(SAAL_UDATA_indication),
52 static const char *const sscf_states[] = {
54 MKSTR(SSCF_AWAITING_ESTABLISH),
55 MKSTR(SSCF_AWAITING_RELEASE),
56 MKSTR(SSCF_ESTABLISHED),
60 #define AA_SIG(S,G,M) \
61 ((S)->funcs->send_upper((S), (S)->aarg, (G), (M)))
63 #define SSCOP_AASIG(S,G,M,P) \
64 ((S)->funcs->send_lower((S), (S)->aarg, (G), (M), (P)))
68 static void sscfu_unqueue(struct sscfu *sscf);
70 /************************************************************/
72 * INSTANCE AND CLASS MANAGEMENT
79 sscfu_create(void *a, const struct sscfu_funcs *funcs)
83 MEMZALLOC(sscf, struct sscfu *, sizeof(struct sscfu));
89 sscf->state = SSCFU_RELEASED;
91 SIGQ_INIT(&sscf->sigs);
98 * Reset the instance. Call only if you know, what you're doing.
101 sscfu_reset(struct sscfu *sscf)
103 sscf->state = SSCFU_RELEASED;
105 SIGQ_CLEAR(&sscf->sigs);
112 sscfu_destroy(struct sscfu *sscf)
114 SIGQ_CLEAR(&sscf->sigs);
119 sscfu_getstate(const struct sscfu *sscf)
121 return (sscf->state);
125 sscfu_getdefparam(struct sscop_param *p)
127 memset(p, 0, sizeof(*p));
131 p->timer_keep_alive = 2000;
132 p->timer_no_response = 7000;
133 p->timer_idle = 15000;
139 return (SSCOP_SET_TCC | SSCOP_SET_TPOLL | SSCOP_SET_TKA |
140 SSCOP_SET_TNR | SSCOP_SET_TIDLE | SSCOP_SET_MAXK |
141 SSCOP_SET_MAXJ | SSCOP_SET_MAXCC | SSCOP_SET_MAXPD);
145 sscfu_signame(enum saal_sig sig)
149 if (sig >= sizeof(sscf_sigs)/sizeof(sscf_sigs[0])) {
150 sprintf(str, "BAD SAAL_SIGNAL %u", sig);
153 return (sscf_sigs[sig]);
158 sscfu_statename(enum sscfu_state s)
162 if (s >= sizeof(sscf_states)/sizeof(sscf_states[0])) {
163 sprintf(str, "BAD SSCFU state %u", s);
166 return (sscf_states[s]);
170 /************************************************************/
172 * EXTERNAL INPUT SIGNAL MAPPING
175 set_state(struct sscfu *sscf, enum sscfu_state state)
177 VERBOSE(sscf, SSCFU_DBG_STATE, (sscf, sscf->aarg,
178 "change state from %s to %s",
179 sscf_states[sscf->state], sscf_states[state]));
184 * signal from SSCOP to SSCF
185 * Message must be freed by the user specified handler, if
189 sscfu_input(struct sscfu *sscf, enum sscop_aasig sig,
190 struct SSCFU_MBUF_T *m, u_int arg __unused)
194 VERBOSE(sscf, SSCFU_DBG_LSIG, (sscf, sscf->aarg,
195 "SSCF got signal %d. in state %s", sig, sscf_states[sscf->state]));
199 case SSCOP_RELEASE_indication:
200 /* arg is: UU, SRC */
201 switch (sscf->state) {
208 case SSCFU_AWAITING_ESTABLISH:
209 set_state(sscf, SSCFU_RELEASED);
210 AA_SIG(sscf, SAAL_RELEASE_indication, m);
213 case SSCFU_AWAITING_RELEASE:
218 case SSCFU_ESTABLISHED:
219 set_state(sscf, SSCFU_RELEASED);
220 AA_SIG(sscf, SAAL_RELEASE_indication, m);
224 set_state(sscf, SSCFU_RELEASED);
225 AA_SIG(sscf, SAAL_RELEASE_indication, m);
230 case SSCOP_ESTABLISH_indication:
232 switch (sscf->state) {
235 set_state(sscf, SSCFU_ESTABLISHED);
236 SSCOP_AASIG(sscf, SSCOP_ESTABLISH_response, NULL, 1);
237 AA_SIG(sscf, SAAL_ESTABLISH_indication, m);
240 case SSCFU_AWAITING_ESTABLISH:
241 case SSCFU_AWAITING_RELEASE:
242 case SSCFU_ESTABLISHED:
250 case SSCOP_ESTABLISH_confirm:
252 switch (sscf->state) {
259 case SSCFU_AWAITING_ESTABLISH:
260 set_state(sscf, SSCFU_ESTABLISHED);
261 AA_SIG(sscf, SAAL_ESTABLISH_confirm, m);
264 case SSCFU_AWAITING_RELEASE:
265 case SSCFU_ESTABLISHED:
273 case SSCOP_RELEASE_confirm:
275 switch (sscf->state) {
278 case SSCFU_AWAITING_ESTABLISH:
281 case SSCFU_AWAITING_RELEASE:
282 set_state(sscf, SSCFU_RELEASED);
283 AA_SIG(sscf, SAAL_RELEASE_confirm, NULL);
286 case SSCFU_ESTABLISHED:
292 case SSCOP_DATA_indication:
294 sscf->funcs->window(sscf, sscf->aarg, 1);
295 switch (sscf->state) {
298 case SSCFU_AWAITING_ESTABLISH:
299 case SSCFU_AWAITING_RELEASE:
303 case SSCFU_ESTABLISHED:
304 AA_SIG(sscf, SAAL_DATA_indication, m);
313 case SSCOP_RECOVER_indication:
315 switch (sscf->state) {
318 case SSCFU_AWAITING_ESTABLISH:
319 case SSCFU_AWAITING_RELEASE:
322 case SSCFU_ESTABLISHED:
323 SSCOP_AASIG(sscf, SSCOP_RECOVER_response, NULL, 0);
324 AA_SIG(sscf, SAAL_ESTABLISH_indication, NULL);
332 case SSCOP_RESYNC_indication:
334 switch (sscf->state) {
337 case SSCFU_AWAITING_ESTABLISH:
338 case SSCFU_AWAITING_RELEASE:
343 case SSCFU_ESTABLISHED:
344 SSCOP_AASIG(sscf, SSCOP_RESYNC_response, NULL, 0);
345 AA_SIG(sscf, SAAL_ESTABLISH_indication, m);
355 case SSCOP_RESYNC_confirm:
357 switch (sscf->state) {
360 case SSCFU_AWAITING_ESTABLISH:
361 case SSCFU_AWAITING_RELEASE:
362 case SSCFU_ESTABLISHED:
365 set_state(sscf, SSCFU_ESTABLISHED);
366 AA_SIG(sscf, SAAL_ESTABLISH_confirm, NULL);
371 case SSCOP_UDATA_indication:
373 AA_SIG(sscf, SAAL_UDATA_indication, m);
377 case SSCOP_RETRIEVE_indication:
382 case SSCOP_RETRIEVE_COMPL_indication:
385 case SSCOP_ESTABLISH_request:
386 case SSCOP_RELEASE_request:
387 case SSCOP_ESTABLISH_response:
388 case SSCOP_DATA_request:
389 case SSCOP_RECOVER_response:
390 case SSCOP_RESYNC_request:
391 case SSCOP_RESYNC_response:
392 case SSCOP_UDATA_request:
393 case SSCOP_RETRIEVE_request:
402 VERBOSE(sscf, SSCFU_DBG_ERR, (sscf, sscf->aarg,
403 "bad signal %d. in state %s", sig, sscf_states[sscf->state]));
409 * Handle signals from the user
412 sscfu_dosig(struct sscfu *sscf, enum saal_sig sig, struct SSCFU_MBUF_T *m)
414 VERBOSE(sscf, SSCFU_DBG_EXEC, (sscf, sscf->aarg,
415 "executing signal %s(%s)",
416 sscf_sigs[sig], sscf_states[sscf->state]));
420 case SAAL_ESTABLISH_request:
422 switch (sscf->state) {
425 set_state(sscf, SSCFU_AWAITING_ESTABLISH);
426 SSCOP_AASIG(sscf, SSCOP_ESTABLISH_request, m, 1);
429 case SSCFU_AWAITING_ESTABLISH:
434 case SSCFU_AWAITING_RELEASE:
435 set_state(sscf, SSCFU_AWAITING_ESTABLISH);
436 SSCOP_AASIG(sscf, SSCOP_ESTABLISH_request, m, 1);
439 case SSCFU_ESTABLISHED:
440 set_state(sscf, SSCFU_RESYNC);
441 SSCOP_AASIG(sscf, SSCOP_RESYNC_request, m, 0);
451 case SAAL_RELEASE_request:
453 switch(sscf->state) {
458 AA_SIG(sscf, SAAL_RELEASE_confirm, NULL);
461 case SSCFU_AWAITING_ESTABLISH:
462 set_state(sscf, SSCFU_AWAITING_RELEASE);
463 SSCOP_AASIG(sscf, SSCOP_RELEASE_request, m, 0);
466 case SSCFU_AWAITING_RELEASE:
471 case SSCFU_ESTABLISHED:
472 set_state(sscf, SSCFU_AWAITING_RELEASE);
473 SSCOP_AASIG(sscf, SSCOP_RELEASE_request, m, 0);
477 set_state(sscf, SSCFU_AWAITING_RELEASE);
478 SSCOP_AASIG(sscf, SSCOP_RELEASE_request, m, 0);
483 case SAAL_DATA_request:
485 switch (sscf->state) {
488 case SSCFU_AWAITING_ESTABLISH:
489 case SSCFU_AWAITING_RELEASE:
493 case SSCFU_ESTABLISHED:
494 SSCOP_AASIG(sscf, SSCOP_DATA_request, m, 0);
503 case SAAL_UDATA_request:
505 SSCOP_AASIG(sscf, SSCOP_UDATA_request, m, 0);
508 case SAAL_ESTABLISH_indication:
509 case SAAL_ESTABLISH_confirm:
510 case SAAL_RELEASE_confirm:
511 case SAAL_RELEASE_indication:
512 case SAAL_DATA_indication:
513 case SAAL_UDATA_indication:
520 VERBOSE(sscf, SSCFU_DBG_ERR, (sscf, sscf->aarg,
521 "bad signal %s in state %s", sscf_sigs[sig],
522 sscf_states[sscf->state]));
526 * Handle user signal.
529 sscfu_saalsig(struct sscfu *sscf, enum saal_sig sig, struct SSCFU_MBUF_T *m)
534 VERBOSE(sscf, SSCFU_DBG_EXEC, (sscf, sscf->aarg,
535 "queuing user signal %s(%s)",
536 sscf_sigs[sig], sscf_states[sscf->state]));
542 SIGQ_APPEND(&sscf->sigs, s);
547 sscfu_dosig(sscf, sig, m);
553 * Unqueue all qeueued signals. Must be called with inhand==1.
556 sscfu_unqueue(struct sscfu *sscf)
560 while ((s = SIGQ_GET(&sscf->sigs)) != NULL) {
561 sscfu_dosig(sscf, s->sig, s->m);
568 sscfu_setdebug(struct sscfu *sscf, u_int n)
574 sscfu_getdebug(const struct sscfu *sscf)
576 return (sscf->debug);