aboutsummaryrefslogtreecommitdiffstats
path: root/src/osmo-bsc/mgw_endpoint_fsm.c
blob: c3b3f40fb988140eaf0ff36a9a21416e71916239 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
/* osmo-bsc API to manage all sides of an MGW endpoint
 *
 * (C) 2017 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
 * All Rights Reserved
 *
 * Author: Neels Hofmeyr <neels@hofmeyr.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>

#include <osmocom/core/fsm.h>
#include <osmocom/core/byteswap.h>

#include <osmocom/bsc/debug.h>
#include <osmocom/bsc/gsm_timers.h>

#include <osmocom/bsc/mgw_endpoint_fsm.h>

#define LOG_CI(ci, level, fmt, args...) do { \
	if (!ci || !ci->mgwep) \
		LOGP(DLGLOBAL, level, "(unknown MGW endpoint) " fmt, ## args); \
	else \
		LOG_MGWEP(ci->mgwep, level, "CI[%d] %s%s%s: " fmt, \
			(int)(ci - ci->mgwep->ci), \
			ci->label ? : "-", \
			ci->mgcp_ci_str[0] ? " CI=" : "", \
			ci->mgcp_ci_str[0] ? ci->mgcp_ci_str : "", \
			## args); \
	} while(0)

#define FIRST_CI_EVENT (_MGWEP_EV_LAST + (_MGWEP_EV_LAST & 1)) /* rounded up to even nr */
#define USABLE_CI ((32 - FIRST_CI_EVENT)/2)
#define EV_TO_CI_IDX(event) ((event - FIRST_CI_EVENT) / 2)

#define CI_EV_SUCCESS(ci) (FIRST_CI_EVENT + (((ci) - ci->mgwep->ci) * 2))
#define CI_EV_FAILURE(ci) (CI_EV_SUCCESS(ci) + 1)

static struct osmo_fsm mgwep_fsm;

struct mgwep_ci {
	struct mgw_endpoint *mgwep;

	bool occupied;
	char label[64];
	struct osmo_fsm_inst *mgcp_client_fi;

	bool pending;
	bool sent;
	enum mgcp_verb verb;
	struct mgcp_conn_peer verb_info;
	struct osmo_fsm_inst *notify;
	uint32_t notify_success;
	uint32_t notify_failure;
	void *notify_data;

	bool got_port_info;
	struct mgcp_conn_peer rtp_info;
	char mgcp_ci_str[MGCP_CONN_ID_LENGTH];
};

struct mgw_endpoint {
	struct mgcp_client *mgcp_client;
	struct osmo_fsm_inst *fi;
	char endpoint[MGCP_ENDPOINT_MAXLEN];

	struct mgwep_ci ci[USABLE_CI];
};

static const struct value_string mgcp_verb_names[] = {
	{ MGCP_VERB_CRCX, "CRCX" },
	{ MGCP_VERB_MDCX, "MDCX" },
	{ MGCP_VERB_DLCX, "DLCX" },
	{ MGCP_VERB_AUEP, "AUEP" },
	{ MGCP_VERB_RSIP, "RSIP" },
	{}
};

static inline const char *mgcp_verb_name(enum mgcp_verb val)
{ return get_value_string(mgcp_verb_names, val); }

static struct mgwep_ci *mgwep_check_ci(struct mgwep_ci *ci)
{
	if (!ci)
		return NULL;
	if (!ci->mgwep)
		return NULL;
	if (ci < ci->mgwep->ci || ci >= &ci->mgwep->ci[USABLE_CI])
		return NULL;
	return ci;
}

static struct mgwep_ci *mgwep_ci_for_event(struct mgw_endpoint *mgwep, uint32_t event)
{
	int idx;
	if (event < FIRST_CI_EVENT)
		return NULL;
	idx = EV_TO_CI_IDX(event);
	if (idx >= sizeof(mgwep->ci))
		return NULL;
	return mgwep_check_ci(&mgwep->ci[idx]);
}

const char *mgw_endpoint_name(const struct mgw_endpoint *mgwep)
{
	if (!mgwep)
		return "NULL";
	if (mgwep->endpoint[0])
		return mgwep->endpoint;
	return osmo_fsm_inst_name(mgwep->fi);
}

const char *mgcp_conn_peer_name(const struct mgcp_conn_peer *info)
{
	static char buf[128];

	if (!info)
		return "NULL";

	if (info->endpoint[0]
	    && info->addr[0])
		snprintf(buf, sizeof(buf), "%s:%s:%u",
			 info->endpoint, info->addr, info->port);
	else if (info->endpoint[0])
		snprintf(buf, sizeof(buf), "%s", info->endpoint);
	else if (info->addr[0])
		snprintf(buf, sizeof(buf), "%s:%u", info->addr, info->port);
	else
		return "empty";
	return buf;
}

const char *mgwep_ci_name(const struct mgwep_ci *ci)
{
	const struct mgcp_conn_peer *rtp_info;

	if (!ci)
		return "NULL";

	rtp_info = mgwep_ci_get_rtp_info(ci);

	if (rtp_info)
		return mgcp_conn_peer_name(rtp_info);
	return mgw_endpoint_name(ci->mgwep);
}

static struct value_string mgwep_fsm_event_names[33] = {};

static char mgwep_fsm_event_name_bufs[32][32] = {};

static void fill_event_names()
{
	int i;
	for (i = 0; i < (ARRAY_SIZE(mgwep_fsm_event_names) - 1); i++) {
		if (i < _MGWEP_EV_LAST)
			continue;
		if (i < FIRST_CI_EVENT || EV_TO_CI_IDX(i) > USABLE_CI) {
			mgwep_fsm_event_names[i] = (struct value_string){i, "Unused"};
			continue;
		}
		snprintf(mgwep_fsm_event_name_bufs[i], sizeof(mgwep_fsm_event_name_bufs[i]),
			 "MGW Response for CI #%d", EV_TO_CI_IDX(i));
		mgwep_fsm_event_names[i] = (struct value_string){i, mgwep_fsm_event_name_bufs[i]};
	}
}

static struct T_def *g_T_defs = NULL;

void mgw_endpoint_fsm_init(struct T_def *T_defs)
{
	static bool g_initialized = false;
	g_T_defs = T_defs;
	if (!g_initialized) {
		OSMO_ASSERT(osmo_fsm_register(&mgwep_fsm) == 0);
		fill_event_names();
		g_initialized = true;
	}
}

/* From local var fi->priv, define local var mgewp. */
#define GET_MGWEP() \
	struct mgw_endpoint *mgwep = fi->priv; \
	OSMO_ASSERT((fi)->fsm == &mgwep_fsm && (fi)->priv)

struct mgw_endpoint *mgw_endpoint_alloc(struct osmo_fsm_inst *parent, uint32_t parent_term_event,
					struct mgcp_client *mgcp_client,
					const char *fsm_id,
					const char *endpoint_str_fmt, ...)
{
	va_list ap;
	struct osmo_fsm_inst *fi;
	struct mgw_endpoint *mgwep;
	int rc;

	if (!mgcp_client)
		return NULL;

	/* use mgcp_client as talloc ctx, so that the conn, lchan, ts can deallocate while MGCP DLCX are
	 * still going on. */
	fi = osmo_fsm_inst_alloc_child(&mgwep_fsm, parent, parent_term_event);
	OSMO_ASSERT(fi);

	osmo_fsm_inst_update_id(fi, fsm_id);

	mgwep = talloc_zero(fi, struct mgw_endpoint);
	OSMO_ASSERT(mgwep);

	va_start(ap, endpoint_str_fmt);
	rc = snprintf(mgwep->endpoint, sizeof(mgwep->endpoint), endpoint_str_fmt, ap);
	va_end(ap);

	if (rc <= 0 || rc >= sizeof(mgwep->endpoint)) {
		LOG_MGWEP(mgwep, LOGL_ERROR, "Endpoint name too long, truncated: %s",
			  mgwep->endpoint);
		osmo_fsm_inst_term(mgwep->fi, OSMO_FSM_TERM_ERROR, 0);
		return NULL;
	}

	mgwep->mgcp_client = mgcp_client;
	mgwep->fi = fi;
	mgwep->fi->priv = mgwep;
	return mgwep;
}

struct mgwep_ci *mgw_endpoint_ci_add(struct mgw_endpoint *mgwep,
				     const char *label_fmt, ...)
{
	va_list ap;
	int i;
	struct mgwep_ci *ci;

	for (i = 0; i < USABLE_CI; i++) {
		ci = &mgwep->ci[i];

		if (ci->occupied || ci->mgcp_client_fi)
			continue;

		*ci = (struct mgwep_ci){
			.mgwep = mgwep,
			.occupied = true,
		};
		if (label_fmt) {
			va_start(ap, label_fmt);
			vsnprintf(ci->label, sizeof(ci->label), label_fmt, ap);
			va_end(ap);
		}
		return ci;
	}

	LOG_MGWEP(mgwep, LOGL_ERROR,
		  "Cannot allocate another endpoint, all "
		  OSMO_STRINGIFY_VAL(USABLE_CI) " are in use");

	return NULL;
}

static void mgwep_fsm_check_state_chg_after_response(struct osmo_fsm_inst *fi);

static void on_failure(struct mgwep_ci *ci)
{
	if (!ci->occupied)
		return;

	if (ci->notify)
		osmo_fsm_inst_dispatch(ci->notify, ci->notify_failure, ci->notify_data);

	*ci = (struct mgwep_ci){
		.mgwep = ci->mgwep,
	};


	mgwep_fsm_check_state_chg_after_response(ci->mgwep->fi);
}

static void on_success(struct mgwep_ci *ci, void *data)
{
	struct mgcp_conn_peer *rtp_info;

	if (!ci->occupied)
		return;

	ci->pending = false;

	switch (ci->verb) {
	case MGCP_VERB_CRCX:
		/* If we sent a wildcarded endpoint name on CRCX, we need to store the resulting endpoint
		 * name here. Also, we receive the MGW's RTP port information. */
		rtp_info = data;
		OSMO_ASSERT(rtp_info);
		ci->got_port_info = true;
		ci->rtp_info = *rtp_info;
		osmo_strlcpy(ci->mgcp_ci_str, mgcp_conn_get_ci(ci->mgcp_client_fi),
			sizeof(ci->mgcp_ci_str));
		if (rtp_info->endpoint[0]) {
			int rc;
			rc = osmo_strlcpy(ci->mgwep->endpoint, rtp_info->endpoint,
					  sizeof(ci->mgwep->endpoint));
			if (rc <= 0 || rc >= sizeof(ci->mgwep->endpoint)) {
				LOG_CI(ci, LOGL_ERROR, "Unable to copy endpoint name '%s'",
				       rtp_info->endpoint);
				mgw_endpoint_ci_dlcx(ci);
				on_failure(ci);
				return;
			}
		}
		break;

	case MGCP_VERB_MDCX:
		/* If an MDCX succeeded, remember the new port information */
		ci->got_port_info = true;
		ci->rtp_info = ci->verb_info;
		break;

	default:
		break;
	}

	LOG_CI(ci, LOGL_DEBUG, "received successful response to %s RTP=%s%s",
	       mgcp_verb_name(ci->verb),
	       mgcp_conn_peer_name(ci->got_port_info? &ci->rtp_info : NULL),
	       ci->notify ? "" : " (not sending a notification)");

	if (ci->notify)
		osmo_fsm_inst_dispatch(ci->notify, ci->notify_success, ci->notify_data);

	mgwep_fsm_check_state_chg_after_response(ci->mgwep->fi);
}

const struct mgcp_conn_peer *mgwep_ci_get_rtp_info(const struct mgwep_ci *ci)
{
	ci = mgwep_check_ci((struct mgwep_ci*)ci);
	if (!ci)
		return NULL;
	if (!ci->got_port_info)
		return NULL;
	return &ci->rtp_info;
}

bool mgwep_ci_get_crcx_info_to_sockaddr(const struct mgwep_ci *ci, struct sockaddr_storage *dest)
{
	const struct mgcp_conn_peer *rtp_info;
	struct sockaddr_in *sin;

	rtp_info = mgwep_ci_get_rtp_info(ci);
	if (!rtp_info)
		return false;

        sin = (struct sockaddr_in *)dest;

        sin->sin_family = AF_INET;
        sin->sin_addr.s_addr = inet_addr(rtp_info->addr);
        sin->sin_port = osmo_ntohs(rtp_info->port);
	return true;
}


struct state_timeout mgwep_fsm_timeouts[32] = {
	[MGWEP_ST_WAIT_MGW_RESPONSE] = { .T=23042 },
};

/* Transition to a state, using the T timer defined in assignment_fsm_timeouts.
 * The actual timeout value is in turn obtained from g_T_defs.
 * Assumes local variable fi exists. */
#define mgwep_fsm_state_chg(state) \
	fsm_inst_state_chg_T(fi, state, mgwep_fsm_timeouts, g_T_defs, 5)

void mgw_endpoint_ci_request(struct mgwep_ci *ci,
			     enum mgcp_verb verb, const struct mgcp_conn_peer *verb_info,
			     struct osmo_fsm_inst *notify,
			     uint32_t event_success, uint32_t event_failure,
			     void *notify_data)
{
	struct mgw_endpoint *mgwep;
	struct osmo_fsm_inst *fi;
	struct mgwep_ci cleared_ci;
	ci = mgwep_check_ci(ci);

	if (!ci) {
		LOGP(DLGLOBAL, LOGL_ERROR, "Invalid MGW endpoint request: no ci\n");
		goto dispatch_error;
	}
	if (!verb_info && verb != MGCP_VERB_DLCX) {
		LOG_CI(ci, LOGL_ERROR, "Invalid MGW endpoint request: missing verb details for %s",
		       mgcp_verb_name(verb));
		goto dispatch_error;
	}
	if ((verb < 0) || (verb > MGCP_VERB_RSIP)) {
		LOG_CI(ci, LOGL_ERROR, "Invalid MGW endpoint request: unknown verb: %s",
		       mgcp_verb_name(verb));
		goto dispatch_error;
	}

	mgwep = ci->mgwep;
	fi = mgwep->fi;

	/* Clear volatile state by explicitly keeping those that should remain. Because we can't assign
	 * the char[] directly, dance through cleared_ci and copy back. */
	cleared_ci = (struct mgwep_ci){
		.mgwep = mgwep,
		.mgcp_client_fi = ci->mgcp_client_fi,
		.got_port_info = ci->got_port_info,
		.rtp_info = ci->rtp_info,

		.occupied = true,
		/* .pending = true follows below */
		.verb = verb,
		.notify = notify,
		.notify_success = event_success,
		.notify_failure = event_failure,
		.notify_data = notify_data,
	};
	osmo_strlcpy(cleared_ci.label, ci->label, sizeof(cleared_ci.label));
	osmo_strlcpy(cleared_ci.mgcp_ci_str, ci->mgcp_ci_str, sizeof(cleared_ci.mgcp_ci_str));
	*ci = cleared_ci;

	LOG_CI(ci, LOGL_ERROR, "%s, notify=%p %s", mgcp_verb_name(ci->verb), ci->notify, ci->notify ?
	       ci->notify->id : "");

	if (verb_info)
		ci->verb_info = *verb_info;

	if (mgwep->endpoint[0]) {
		if (ci->verb_info.endpoint[0] && strcmp(ci->verb_info.endpoint, mgwep->endpoint))
			LOG_CI(ci, LOGL_ERROR,
			       "Warning: Requested %s on endpoint %s, but this CI is on endpoint %s."
			       " Using the proper endpoint instead.",
			       mgcp_verb_name(verb), ci->verb_info.endpoint, mgwep->endpoint);
		osmo_strlcpy(ci->verb_info.endpoint, mgwep->endpoint, sizeof(ci->verb_info.endpoint));
	}

	switch (ci->verb) {
	case MGCP_VERB_CRCX:
		if (ci->mgcp_client_fi) {
			LOG_CI(ci, LOGL_ERROR, "CRCX can be called only once per MGW endpoint CI");
			on_failure(ci);
			return;
		}
		break;

	case MGCP_VERB_MDCX:
	case MGCP_VERB_DLCX:
		if (!ci->mgcp_client_fi) {
			LOG_CI(ci, LOGL_ERROR, "The first verb on an unused MGW endpoint CI must be CRCX, not %s",
			       mgcp_verb_name(ci->verb));
			on_failure(ci);
			return;
		}
		break;

	default:
		LOG_CI(ci, LOGL_ERROR, "This verb is not supported: %s", mgcp_verb_name(ci->verb));
		on_failure(ci);
		return;
	}

	ci->pending = true;

	LOG_CI(ci, LOGL_DEBUG, "Scheduling MGCP: %s (%s:%u)",
	       mgcp_verb_name(ci->verb), ci->verb_info.addr, ci->verb_info.port);

	if (mgwep->fi->state != MGWEP_ST_WAIT_MGW_RESPONSE)
		mgwep_fsm_state_chg(MGWEP_ST_WAIT_MGW_RESPONSE);

	return;
dispatch_error:
	if (notify)
		osmo_fsm_inst_dispatch(notify, event_failure, notify_data);
}

static int send_verb(struct mgwep_ci *ci)
{
	int rc;
	struct mgw_endpoint *mgwep = ci->mgwep;

	if (!ci->occupied || !ci->pending || ci->sent)
		return 0;

	switch (ci->verb) {

	case MGCP_VERB_CRCX:
		OSMO_ASSERT(!ci->mgcp_client_fi);
		LOG_CI(ci, LOGL_DEBUG, "Sending MGCP: %s %s:%u",
		       mgcp_verb_name(ci->verb), ci->verb_info.addr, ci->verb_info.port);
		ci->mgcp_client_fi = mgcp_conn_create(mgwep->mgcp_client, mgwep->fi,
						      CI_EV_FAILURE(ci), CI_EV_SUCCESS(ci),
						      &ci->verb_info);
		ci->sent = true;
		if (!ci->mgcp_client_fi){
			LOG_CI(ci, LOGL_ERROR, "Error sending MGCP: %s %s:%u (rc=%d %s)",
			       mgcp_verb_name(ci->verb), ci->verb_info.addr, ci->verb_info.port,
			       rc, strerror(-rc));
			on_failure(ci);
		}
		osmo_fsm_inst_update_id(ci->mgcp_client_fi, ci->label);
		break;

	case MGCP_VERB_MDCX:
		OSMO_ASSERT(ci->mgcp_client_fi);
		LOG_CI(ci, LOGL_DEBUG, "Sending MGCP: %s %s %s:%u",
		       mgcp_verb_name(ci->verb), ci->mgcp_ci_str, ci->verb_info.addr, ci->verb_info.port);
		rc = mgcp_conn_modify(ci->mgcp_client_fi, CI_EV_SUCCESS(ci), &ci->verb_info);
		ci->sent = true;
		if (rc) {
			LOG_CI(ci, LOGL_ERROR, "Error sending MGCP: %s %s:%u (rc=%d %s)",
			       mgcp_verb_name(ci->verb), ci->verb_info.addr, ci->verb_info.port,
			       rc, strerror(-rc));
			on_failure(ci);
		}
		break;

	case MGCP_VERB_DLCX:
		LOG_CI(ci, LOGL_DEBUG, "Sending MGCP: %s %s",
		       mgcp_verb_name(ci->verb), ci->mgcp_ci_str);
		/* The way this is designed, we actually need to forget all about the ci right away. */
		mgcp_conn_delete(ci->mgcp_client_fi);
		if (ci->notify)
			osmo_fsm_inst_dispatch(ci->notify, ci->notify_success, ci->notify_data);
		*ci = (struct mgwep_ci){
			.mgwep = mgwep,
		};
		break;

	default:
		OSMO_ASSERT(false);
	}

	return 1;
}

void mgw_endpoint_clear(struct mgw_endpoint *mgwep)
{
	if (!mgwep)
		return;
	osmo_fsm_inst_term(mgwep->fi, OSMO_FSM_TERM_REGULAR, 0);
}

/*

mgwep_st_unused#MGWEP_ST_UNUSED
mgwep_st_wait_mgw_response#MGWEP_ST_WAIT_MGW_RESPONSE
mgwep_st_in_use#MGWEP_ST_IN_USE


:s/\(.*\)_st_\(.*\)#\(.*_ST_\(.*\)\)/static void \1_fsm_\2_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state)\r{\r\tGET_MGWEP();\r}\r\rstatic void \1_fsm_\2(struct osmo_fsm_inst *fi, uint32_t event, void *data)\r{\r\tGET_MGWEP();\r\tswitch (event) {\r\tdefault:\r\t\tOSMO_ASSERT(false);\r\t}\r}\r




:s/\(.*\)_st_\(.*\)#\(MGWEP_ST_\(.*\)\)/\t[\3] = {\r\t\t.name = "\4",\r\t\t.onenter = \1_fsm_\2_onenter,\r\t\t.action = \1_fsm_\2,\r\t\t.in_event_mask = 0\r\t\t\t| S()\r\t\t\t,\r\t\t.out_state_mask = 0\r\t\t\t| S()\r\t\t\t,\r\t},


*/

static void mgwep_count(struct mgw_endpoint *mgwep, int *occupied, int *pending_not_sent,
			int *waiting_for_response)
{
	int i;

	if (occupied)
		*occupied = 0;

	if (pending_not_sent)
		*pending_not_sent = 0;

	if (waiting_for_response)
		*waiting_for_response = 0;

	for (i = 0; i < ARRAY_SIZE(mgwep->ci); i++) {
		struct mgwep_ci *ci = &mgwep->ci[i];
		if (ci->occupied) {
			if (occupied)
				(*occupied)++;
		} else
			continue;

		if (ci->pending)
			LOG_CI(ci, LOGL_DEBUG, "verb=%s, %s",
			       mgcp_verb_name(ci->verb),
			       ci->sent ? "waiting for response" : "waiting to be sent");
		else
			LOG_CI(ci, LOGL_DEBUG, "%s",
			       mgcp_conn_peer_name(mgwep_ci_get_rtp_info(ci)));

		if (ci->pending && ci->sent)
			if (waiting_for_response)
				(*waiting_for_response)++;
		if (ci->pending && !ci->sent)
			if (pending_not_sent)
				(*pending_not_sent)++;
	}
}

static void mgwep_fsm_check_state_chg_after_response(struct osmo_fsm_inst *fi)
{
	int waiting_for_response;
	int occupied;
	GET_MGWEP();

	mgwep_count(mgwep, &occupied, NULL, &waiting_for_response);
	LOG_MGWEP(mgwep, LOGL_DEBUG, "CI in use: %d, waiting for response: %d", occupied, waiting_for_response);

	if (!occupied)  {
		mgwep_fsm_state_chg(MGWEP_ST_UNUSED);
		return;
	}

	if (!waiting_for_response) {
		if (fi->state != MGWEP_ST_IN_USE)
			mgwep_fsm_state_chg(MGWEP_ST_IN_USE);
		return;
	}

}

static void mgwep_fsm_wait_mgw_response_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state)
{
	int count = 0;
	int i;
	GET_MGWEP();

	for (i = 0; i < ARRAY_SIZE(mgwep->ci); i++) {
		count += send_verb(&mgwep->ci[i]);
	}

	LOG_MGWEP(mgwep, LOGL_DEBUG, "Sent messages: %d", count);
	mgwep_fsm_check_state_chg_after_response(fi);

}

static void mgwep_fsm_handle_ci_events(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
	struct mgwep_ci *ci;
	GET_MGWEP();
	ci = mgwep_ci_for_event(mgwep, event);
	if (ci) {
		if (event == CI_EV_SUCCESS(ci))
			on_success(ci, data);
		else
			on_failure(ci);
	}
}

static void mgwep_fsm_in_use_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state)
{
	int pending_not_sent;
	GET_MGWEP();

	mgwep_count(mgwep, NULL, &pending_not_sent, NULL);
	if (pending_not_sent)
		mgwep_fsm_state_chg(MGWEP_ST_WAIT_MGW_RESPONSE);
}

#define S(x)	(1 << (x))

static const struct osmo_fsm_state mgwep_fsm_states[] = {
	[MGWEP_ST_UNUSED] = {
		.name = "UNUSED",
		.in_event_mask = 0,
		.out_state_mask = 0
			| S(MGWEP_ST_WAIT_MGW_RESPONSE)
			,
	},
	[MGWEP_ST_WAIT_MGW_RESPONSE] = {
		.name = "WAIT_MGW_RESPONSE",
		.onenter = mgwep_fsm_wait_mgw_response_onenter,
		.action = mgwep_fsm_handle_ci_events,
		.in_event_mask = 0xffffffff,
		.out_state_mask = 0
			| S(MGWEP_ST_IN_USE)
			| S(MGWEP_ST_UNUSED)
			,
	},
	[MGWEP_ST_IN_USE] = {
		.name = "IN_USE",
		.onenter = mgwep_fsm_in_use_onenter,
		.action = mgwep_fsm_handle_ci_events,
		.in_event_mask = 0xffffffff, /* mgcp_client_fsm may send parent term anytime */
		.out_state_mask = 0
			| S(MGWEP_ST_WAIT_MGW_RESPONSE)
			,
	},
};

int mgwep_fsm_timer_cb(struct osmo_fsm_inst *fi)
{
	int i;
	GET_MGWEP();

	switch (fi->T) {
	default:
		for (i = 0; i < ARRAY_SIZE(mgwep->ci); i++) {
			struct mgwep_ci *ci = &mgwep->ci[i];
			if (!ci->occupied)
				continue;
			if (!(ci->pending && ci->sent))
				continue;
			on_failure(ci);
		}
		return 0;
	}

	return 0;
}

static struct osmo_fsm mgwep_fsm = {
	.name = "mgw-endpoint",
	.states = mgwep_fsm_states,
	.num_states = ARRAY_SIZE(mgwep_fsm_states),
	.log_subsys = DRSL,
	.event_names = mgwep_fsm_event_names,
	.timer_cb = mgwep_fsm_timer_cb,
	/* The FSM termination will automatically trigger any mgcp_client_fsm instances to DLCX. */
};