introduce cbc_data.h with core data model of CBC

Change-Id: I5afecfede6c0b718d71bd9c825d4074d3c6635ca

src/cbc_data.h

@@ -0,0 +1,113 @@
+#pragma once
+#include <stdint.h>
+#include <stdbool.h>
+#include <osmocom/core/linuxlist.h>
+
+struct osmo_cbsp_cbc_client;
+struct osmo_sabp_cbc_client;
+
+/*********************************************************************************
+ * CBC Peer
+ *********************************************************************************/
+
+enum cbc_peer_protocol {
+	CBC_PEER_PROTO_CBSP,
+	CBC_PEER_PROTO_SABP,
+};
+
+struct cbc_peer {
+	struct llist_head list;		/* linked to cbc.peers */
+	const char *name;
+
+	enum cbc_peer_protocol proto;
+	union {
+		struct osmo_cbsp_cbc_client *cbsp;
+		struct osmo_sabp_cbc_client *sabp;
+	} client;
+};
+
+/*********************************************************************************
+ * CBC Message
+ *********************************************************************************/
+
+/* a single SMSCB page of 82 user bytes (excluding any GSM specific header) */
+#define SMSCB_RAW_PAGE_LEN	82
+#define SMSCB_MAX_NUM_PAGES	15
+
+/* representation of a plain SMSCB message without any metadata such as cell lists */
+struct smscb_message {
+	uint16_t message_id;
+	uint16_t serial_nr;
+
+	bool is_etws;
+	union {
+		struct {
+			/* data coding scheme */
+			uint8_t dcs;
+			/* number of pages containing valid information */
+			unsigned int num_pages;
+			/* actual page data, concatenated */
+			uint8_t data[SMSCB_RAW_PAGE_LEN][SMSCB_MAX_NUM_PAGES];
+			/* FIXME: do we need information on the total length to
+			 * determine which is the last block used in [at least the last]
+			 * page? */
+		} cbs;
+		struct {
+			/* WarningType 16bit parameter as per 23.041 9.3.24 */
+			uint16_t warning_type;
+			uint8_t warning_sec_info[50];
+		} etws;
+	};
+};
+
+enum cbc_message_prio {
+	CBC_MSG_PRIO_NORMAL,
+	CBC_MSG_PRIO_HIGH,
+	CBC_MSG_PRIO_BACKGRROUND,
+};
+
+enum cbc_message_scope {
+	CBC_MSG_SCOPE_PLMN,
+	/* FIXME: more local/regional scopes than PLMN-wide */
+};
+
+/* link between a SMSCB message and a peer (BSC, RNC, MME) */
+struct cbc_message_peer {
+	struct llist_head list;		/* lined to cbc_message.peers */
+	struct cbc_peer *peer;		/* peer */
+	bool acknowledged;		/* did peer acknowledge this message yet? */
+};
+
+/* internal representation of a CBC message */
+struct cbc_message {
+	struct llist_head list;		 /* global list of currently active CBCs */
+
+	enum cbc_message_prio priority;
+	uint16_t rep_period;		/* repetition period (1..4095) */
+	bool extended_cbch;		/* basic (false) or extended (true) CBCH */
+	uint16_t warning_period_sec;	/* warning period in seconds */
+	uint16_t num_bcast;		/* number of broadcasts requested */
+
+	enum cbc_message_scope scope;
+	/* FIXME: data for other scopes than PLMN-wide */
+
+	/* SMSCB message with id, serial, dcs, pages, ... */
+	struct smscb_message msg;
+
+	/* CBC peers (BSCs, RNCs, MMEs) to which this message has already been sent */
+	struct llist_head peers;
+};
+
+/*********************************************************************************
+ * CBC itself
+ *********************************************************************************/
+
+struct cbc {
+	struct {
+	} config;
+
+	struct llist_head messages;	/* cbc_message.list */
+	struct llist_head peers;	/* cbc_peer.list */
+};
+
+extern struct cbc *g_cbc;

src/cbc_main.c

@@ -46,8 +46,10 @@
 
 #include "internal.h"
 #include "cbsp_server.h"
+#include "cbc_data.h"
 
 static void *tall_cbc_ctx;
+struct cbc *g_cbc;
 
 static const struct log_info_cat log_info_cat[] = {
 	[DCBSP] = {
@@ -160,6 +162,10 @@ int main(int argc, char **argv)
 	osmo_stats_init(tall_cbc_ctx);
 	vty_init(&vty_info);
 
+	g_cbc = talloc_zero(tall_cbc_ctx, struct cbc);
+	INIT_LLIST_HEAD(&g_cbc->peers);
+	INIT_LLIST_HEAD(&g_cbc->messages);
+
 	handle_options(argc, argv);
 
 	logging_vty_add_cmds();

src/rest_api.c

@@ -34,38 +34,7 @@
 
 #include "internal.h"
 #include "charset.h"
-//#include "rest_api.h"
+#include "cbc_data.h"
-
-/* a single SMSCB page of 82 user bytes (excluding any GSM specific header) */
-#define SMSCB_RAW_PAGE_LEN	82
-#define SMSCB_MAX_NUM_PAGES	15
-
-/* representation of a plain SMSCB message without any metadata such as cell lists */
-struct smscb_message {
-	uint16_t message_id;
-	uint16_t serial_nr;
-
-	bool is_etws;
-	union {
-		struct {
-			/* data coding scheme */
-			uint8_t dcs;
-			/* number of pages containing valid information */
-			unsigned int num_pages;
-			/* actual page data, concatenated */
-			uint8_t data[SMSCB_RAW_PAGE_LEN][SMSCB_MAX_NUM_PAGES];
-			/* FIXME: do we need information on the total length to
-			 * determine which is the last block used in [at least the last]
-			 * page? */
-		} cbs;
-		struct {
-			/* WarningType 16bit parameter as per 23.041 9.3.24 */
-			uint16_t warning_type;
-			uint8_t warning_sec_info[50];
-		} etws;
-	};
-};
-
 
 /* get an integer value for field "key" in object "parent" */
 static int json_get_integer(int *out, json_t *parent, const char *key)