cellular-infrastructure
/
osmo-cbc
mirror of https://gerrit.osmocom.org/osmo-cbc
9
0
Fork 0
Code Issues Releases Wiki Activity

Split cbc_message related code to its own .c and .h file 

Change-Id: I41f6e169b1ee6731cd472f6b72ea922260e30ceb
This commit is contained in:
Pau Espin 2022-07-20 16:57:08 +02:00
parent 28ccced217
commit 36be606dd4
13 changed files with 120 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
include/osmocom/cbc/Makefile.am
View File

@ -1,6 +1,7 @@
noinst_HEADERS = \
cbc_data.h \
cbc_peer.h \
cbc_message.h \
cbc_vty.h \
cbsp_server.h \
charset.h \

99
include/osmocom/cbc/cbc_data.h
View File

@ -1,7 +1,6 @@
#pragma once
#include <stdint.h>
#include <stdbool.h>
#include <time.h>
#include <osmocom/core/linuxlist.h>
#include <osmocom/core/it_q.h>
#include <osmocom/gsm/protocol/gsm_48_049.h>
@ -42,97 +41,6 @@ struct cbc_cell_id {
} num_compl;
};
/*********************************************************************************
* 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_MAX_NUM_PAGES][SMSCB_RAW_PAGE_LEN];
/* total number of octets user data over _all_ the pages */
uint16_t data_user_len;
} cbs;
struct {
/* WarningTypeValue 7bit parameter as per 23.041 9.3.24 */
uint16_t warning_type;
/* Emergency User Alert */
bool user_alert;
/* Popup on Display */
bool popup_on_display;
uint8_t warning_sec_info[50];
} etws;
};
};
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 */
/* 'cbcmsg' is not really needed, as the fsm instance parent points to
* the fsm instance of cbc_message, so we could also dereference those */
struct cbc_message *cbcmsg; /* the SMSCB this relates to */
struct cbc_peer *peer; /* the peer thos relates to */
struct osmo_fsm_inst *fi; /* the FSM instance representing our state */
/* cells in which this message has been established/installed */
struct llist_head cell_list;
/* cells in which this message has NOT been established/installed */
struct llist_head fail_list;
/* number of broadcasts completed in cells of this peer */
struct llist_head num_compl_list;
};
/* internal representation of a CBC message */
struct cbc_message {
struct llist_head list; /* global list of currently active CBCs */
const char *cbe_name; /* name of the CBE originating this SMSCB */
enum cbsp_category priority;
uint16_t rep_period; /* repetition period (1..4095) in units of 1.883s */
bool extended_cbch; /* basic (false) or extended (true) CBCH */
uint32_t warning_period_sec; /* warning period in seconds (0xffffffff = unlimited) */
uint16_t num_bcast; /* number of broadcasts requested (0=unlimited) */
enum cbc_message_scope scope;
/* FIXME: data for other scopes than PLMN-wide */
/* SMSCB message with id, serial, dcs, pages, ... */
struct smscb_message msg;
struct osmo_fsm_inst *fi; /* FSM instance (smscb_message_fsm) */
/* CBC peers (BSCs, RNCs, MMEs) to which this message has already been sent */
struct llist_head peers;
struct rest_it_op *it_op; /* inter-thread queue operation currently processing */
struct {
time_t created; /* when was this message created? */
time_t expired; /* when has this message expired? */
} time;
};
/*********************************************************************************
* CBC itself
*********************************************************************************/
@ -164,10 +72,3 @@ struct cbc {
};
extern struct cbc *g_cbc;
int cbc_message_del_peer(struct cbc_message *cbcmsg, struct cbc_peer *peer);
int cbc_message_add_peer(struct cbc_message *cbcmsg, struct cbc_peer *peer);
struct cbc_message_peer *smscb_peer_fsm_alloc(struct cbc_peer *peer, struct cbc_message *cbcmsg);
struct cbc_message_peer *cbc_message_peer_get(struct cbc_message *cbcmsg, struct cbc_peer *peer);

110
include/osmocom/cbc/cbc_message.h Normal file
View File

@ -0,0 +1,110 @@
#pragma once
#include <stdint.h>
#include <stdbool.h>
#include <time.h>
#include <osmocom/core/linuxlist.h>
#include <osmocom/core/it_q.h>
#include <osmocom/gsm/protocol/gsm_48_049.h>
#include <osmocom/gsm/gsm23003.h>
/*********************************************************************************
* 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_MAX_NUM_PAGES][SMSCB_RAW_PAGE_LEN];
/* total number of octets user data over _all_ the pages */
uint16_t data_user_len;
} cbs;
struct {
/* WarningTypeValue 7bit parameter as per 23.041 9.3.24 */
uint16_t warning_type;
/* Emergency User Alert */
bool user_alert;
/* Popup on Display */
bool popup_on_display;
uint8_t warning_sec_info[50];
} etws;
};
};
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 */
/* 'cbcmsg' is not really needed, as the fsm instance parent points to
* the fsm instance of cbc_message, so we could also dereference those */
struct cbc_message *cbcmsg; /* the SMSCB this relates to */
struct cbc_peer *peer; /* the peer thos relates to */
struct osmo_fsm_inst *fi; /* the FSM instance representing our state */
/* cells in which this message has been established/installed */
struct llist_head cell_list;
/* cells in which this message has NOT been established/installed */
struct llist_head fail_list;
/* number of broadcasts completed in cells of this peer */
struct llist_head num_compl_list;
};
/* internal representation of a CBC message */
struct cbc_message {
struct llist_head list; /* global list of currently active CBCs */
const char *cbe_name; /* name of the CBE originating this SMSCB */
enum cbsp_category priority;
uint16_t rep_period; /* repetition period (1..4095) in units of 1.883s */
bool extended_cbch; /* basic (false) or extended (true) CBCH */
uint32_t warning_period_sec; /* warning period in seconds (0xffffffff = unlimited) */
uint16_t num_bcast; /* number of broadcasts requested (0=unlimited) */
enum cbc_message_scope scope;
/* FIXME: data for other scopes than PLMN-wide */
/* SMSCB message with id, serial, dcs, pages, ... */
struct smscb_message msg;
struct osmo_fsm_inst *fi; /* FSM instance (smscb_message_fsm) */
/* CBC peers (BSCs, RNCs, MMEs) to which this message has already been sent */
struct llist_head peers;
struct rest_it_op *it_op; /* inter-thread queue operation currently processing */
struct {
time_t created; /* when was this message created? */
time_t expired; /* when has this message expired? */
} time;
};
struct cbc_message *cbc_message_alloc(void *ctx, const struct cbc_message *cbcmsg);
int cbc_message_new(const struct cbc_message *cbcmsg, struct rest_it_op *op);
void cbc_message_delete(struct cbc_message *cbcmsg, struct rest_it_op *op);
struct cbc_message *cbc_message_by_id(uint16_t message_id);
int peer_new_cbc_message(struct cbc_peer *peer, struct cbc_message *cbcmsg);
int cbc_message_del_peer(struct cbc_message *cbcmsg, struct cbc_peer *peer);
int cbc_message_add_peer(struct cbc_message *cbcmsg, struct cbc_peer *peer);
struct cbc_message_peer *smscb_peer_fsm_alloc(struct cbc_peer *peer, struct cbc_message *cbcmsg);
struct cbc_message_peer *cbc_message_peer_get(struct cbc_message *cbcmsg, struct cbc_peer *peer);

7
include/osmocom/cbc/internal.h
View File

@ -41,13 +41,6 @@ enum sbcap_server_event {
int rest_api_init(void *ctx, const char *bind_addr, uint16_t port);
void rest_api_fin(void);
/* message_handling.c */
struct cbc_message *cbc_message_alloc(void *ctx, const struct cbc_message *cbcmsg);
int cbc_message_new(const struct cbc_message *cbcmsg, struct rest_it_op *op);
void cbc_message_delete(struct cbc_message *cbcmsg, struct rest_it_op *op);
struct cbc_message *cbc_message_by_id(uint16_t message_id);
int peer_new_cbc_message(struct cbc_peer *peer, struct cbc_message *cbcmsg);
/* smscb_*fsm.c */
enum smscb_fsm_event {

2
include/osmocom/cbc/rest_it_op.h
View File

@ -7,7 +7,7 @@
#include <osmocom/core/linuxlist.h>
#include <osmocom/core/it_q.h>
#include <osmocom/cbc/cbc_data.h>
#include <osmocom/cbc/cbc_message.h>
enum rest_it_operation {
REST_IT_OP_NONE,

2
src/Makefile.am
View File

@ -11,7 +11,7 @@ bin_PROGRAMS = osmo-cbc
osmo_cbc_SOURCES = \
cbc_main.c \
cbc_data.c \
cbc_message.c \
cbc_peer.c \
cbc_vty.c \
cbsp_server.c \

3
src/cbc_data.c → src/cbc_message.c
View File

@ -28,8 +28,7 @@
#include <osmocom/core/talloc.h>
#include <osmocom/core/utils.h>
#include <osmocom/cbc/cbc_data.h>
#include <osmocom/cbc/cbsp_server.h>
#include <osmocom/cbc/cbc_message.h>
/* remove a peer from the message */
int cbc_message_del_peer(struct cbc_message *cbcmsg, struct cbc_peer *peer)

1
src/cbc_peer.c
View File

@ -28,6 +28,7 @@
#include <osmocom/core/talloc.h>
#include <osmocom/core/utils.h>
#include <osmocom/cbc/cbc_message.h>
#include <osmocom/cbc/cbc_peer.h>
#include <osmocom/cbc/cbsp_server.h>
#include <osmocom/cbc/sbcap_server.h>

1
src/cbc_vty.c
View File

@ -31,6 +31,7 @@
#include <osmocom/vty/vty.h>
#include <osmocom/cbc/cbc_data.h>
#include <osmocom/cbc/cbc_message.h>
#include <osmocom/cbc/cbc_peer.h>
#include <osmocom/cbc/cbc_vty.h>
#include <osmocom/cbc/internal.h>

1
src/cbsp_server_fsm.c
View File

@ -22,6 +22,7 @@
#include <osmocom/gsm/cbsp.h>
#include <osmocom/cbc/cbc_message.h>
#include <osmocom/cbc/cbc_peer.h>
#include <osmocom/cbc/cbsp_server.h>
#include <osmocom/cbc/internal.h>

2
src/sbcap_msg.c
View File

@ -31,7 +31,7 @@
#include <osmocom/sbcap/sbcap_common.h>
#include <osmocom/cbc/cbc_data.h>
#include <osmocom/cbc/cbc_message.h>
#include <osmocom/cbc/sbcap_server.h>
#include <osmocom/cbc/internal.h>

1
src/sbcap_server_fsm.c
View File

@ -25,6 +25,7 @@
#include <osmocom/sbcap/sbcap_common.h>
#include <osmocom/cbc/cbc_message.h>
#include <osmocom/cbc/sbcap_server.h>
#include <osmocom/cbc/internal.h>
#include <osmocom/cbc/cbc_peer.h>

2
src/smscb_peer_fsm.c
View File

@ -34,7 +34,7 @@
#include <osmocom/sbcap/sbcap_common.h>
#include <osmocom/cbc/cbc_data.h>
#include <osmocom/cbc/cbc_message.h>
#include <osmocom/cbc/cbc_peer.h>
#include <osmocom/cbc/cbsp_server.h>
#include <osmocom/cbc/sbcap_server.h>