gprs_ns2_internal.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdbool.h>
#include <stdint.h>
 
#include <osmocom/core/logging.h>
#include <osmocom/core/rate_ctr.h>
#include <osmocom/gprs/protocol/gsm_08_16.h>
#include <osmocom/gprs/gprs_ns2.h>
 
#define LOGNSE(nse, lvl, fmt, args ...) \
        LOGP(DLNS, lvl, "NSE(%05u) " fmt, (nse)->nsei, ## args)
 
#define LOGBIND(bind, lvl, fmt, args ...) \
        LOGP(DLNS, lvl, "BIND(%s) " fmt, (bind)->name, ## args)
 
#define LOGNSVC_SS(ss, nsvc, lvl, fmt, args ...)                                \
        do {                                                                    \
                if ((nsvc)->nsvci_is_valid) {                                   \
                        LOGP(ss, lvl, "NSE(%05u)-NSVC(%05u) " fmt,              \
                             (nsvc)->nse->nsei, (nsvc)->nsvci, ## args);        \
                } else {                                                        \
                        LOGP(ss, lvl, "NSE(%05u)-NSVC(none) " fmt,              \
                             (nsvc)->nse->nsei, ## args);                       \
                }                                                               \
        } while (0)
 
#define LOGNSVC(nsvc, lvl, fmt, args ...)                                       \
        LOGNSVC_SS(DLNS, nsvc, lvl, fmt, ## args)
 
#define LOG_NS_SIGNAL(nsvc, direction, pdu_type, lvl, fmt, args ...)    \
        LOGNSVC_SS(DLNSSIGNAL, nsvc, lvl, "%s %s" fmt, direction, get_value_string(gprs_ns_pdu_strings, pdu_type), ## args)
 
#define LOG_NS_DATA(nsvc, direction, pdu_type, lvl, fmt, args ...)      \
        LOGNSVC_SS(DLNSDATA, nsvc, lvl, "%s %s" fmt, direction, get_value_string(gprs_ns_pdu_strings, pdu_type), ## args)
 
#define LOG_NS_RX_SIGNAL(nsvc, pdu_type) LOG_NS_SIGNAL(nsvc, "Rx", pdu_type, LOGL_INFO, "\n")
#define LOG_NS_TX_SIGNAL(nsvc, pdu_type) LOG_NS_SIGNAL(nsvc, "Tx", pdu_type, LOGL_INFO, "\n")
 
#define RATE_CTR_INC_NS(nsvc, ctr) \
        do { \
                struct gprs_ns2_vc *_nsvc = (nsvc); \
                rate_ctr_inc(rate_ctr_group_get_ctr(_nsvc->ctrg, ctr)); \
                rate_ctr_inc(rate_ctr_group_get_ctr(_nsvc->nse->ctrg, ctr)); \
        } while (0)
 
#define RATE_CTR_ADD_NS(nsvc, ctr, val) \
        do { \
                struct gprs_ns2_vc *_nsvc = (nsvc); \
                rate_ctr_add(rate_ctr_group_get_ctr(_nsvc->ctrg, ctr), val); \
                rate_ctr_add(rate_ctr_group_get_ctr(_nsvc->nse->ctrg, ctr), val); \
        } while (0)
 
 
struct osmo_fsm_inst;
struct tlv_parsed;
struct vty;
 
struct gprs_ns2_vc_driver;
struct gprs_ns2_vc_bind;
 
#define NS_TIMERS_COUNT 11
 
#define TNS_BLOCK_STR "tns-block"
#define TNS_BLOCK_RETRIES_STR "tns-block-retries"
#define TNS_RESET_STR "tns-reset"
#define TNS_RESET_RETRIES_STR "tns-reset-retries"
#define TNS_TEST_STR "tns-test"
#define TNS_ALIVE_STR "tns-alive"
#define TNS_ALIVE_RETRIES_STR "tns-alive-retries"
#define TSNS_PROV_STR "tsns-prov"
#define TSNS_SIZE_RETRIES_STR "tsns-size-retries"
#define TSNS_CONFIG_RETRIES_STR "tsns-config-retries"
#define TSNS_PROCEDURES_RETRIES_STR "tsns-procedures-retries"
#define NS_TIMERS "(" TNS_BLOCK_STR "|" TNS_BLOCK_RETRIES_STR "|" TNS_RESET_STR "|" TNS_RESET_RETRIES_STR "|" TNS_TEST_STR "|"\
        TNS_ALIVE_STR "|" TNS_ALIVE_RETRIES_STR "|" TSNS_PROV_STR "|" TSNS_SIZE_RETRIES_STR "|" TSNS_CONFIG_RETRIES_STR "|"\
        TSNS_PROCEDURES_RETRIES_STR ")"
 
#define NS_TIMERS_HELP  \
        "(un)blocking Timer (Tns-block) timeout\n"              \
        "(un)blocking Timer (Tns-block) number of retries\n"    \
        "Reset Timer (Tns-reset) timeout\n"                     \
        "Reset Timer (Tns-reset) number of retries\n"           \
        "Test Timer (Tns-test) timeout\n"                       \
        "Alive Timer (Tns-alive) timeout\n"                     \
        "Alive Timer (Tns-alive) number of retries\n"           \
        "SNS Provision Timer (Tsns-prov) timeout\n"             \
        "SNS Size number of retries\n"                          \
        "SNS Config number of retries\n"                        \
        "SNS Procedures number of retries\n"                    \
 
/* Educated guess - LLC user payload is 1500 bytes plus possible headers */
#define NS_ALLOC_SIZE   3072
#define NS_ALLOC_HEADROOM 20
 
#define NS_DEFAULT_TXQUEUE_MAX_LENGTH 128
 
enum ns2_timeout {
        NS_TOUT_TNS_BLOCK,
        NS_TOUT_TNS_BLOCK_RETRIES,
        NS_TOUT_TNS_RESET,
        NS_TOUT_TNS_RESET_RETRIES,
        NS_TOUT_TNS_TEST,
        NS_TOUT_TNS_ALIVE,
        NS_TOUT_TNS_ALIVE_RETRIES,
        NS_TOUT_TSNS_PROV,
        NS_TOUT_TSNS_SIZE_RETRIES,
        NS_TOUT_TSNS_CONFIG_RETRIES,
        NS_TOUT_TSNS_PROCEDURES_RETRIES,
};
 
enum nsvc_timer_mode {
        /* standard timers */
        NSVC_TIMER_TNS_TEST,
        NSVC_TIMER_TNS_ALIVE,
        NSVC_TIMER_TNS_RESET,
        _NSVC_TIMER_NR,
};
 
enum ns2_vc_stat {
        NS_STAT_ALIVE_DELAY,
};
 
enum ns2_bind_stat {
        NS2_BIND_STAT_BACKLOG_LEN,
};
 
enum ns2_cs {
        NS2_CS_CREATED,     
        NS2_CS_FOUND,       
        NS2_CS_REJECTED,    
        NS2_CS_SKIPPED,     
        NS2_CS_ERROR,       
};
 
enum ns_ctr {
        NS_CTR_PKTS_IN,
        NS_CTR_PKTS_OUT,
        NS_CTR_PKTS_OUT_DROP,
        NS_CTR_BYTES_IN,
        NS_CTR_BYTES_OUT,
        NS_CTR_BYTES_OUT_DROP,
        NS_CTR_BLOCKED,
        NS_CTR_UNBLOCKED,
        NS_CTR_DEAD,
        NS_CTR_REPLACED,
        NS_CTR_NSEI_CHG,
        NS_CTR_INV_VCI,
        NS_CTR_INV_NSEI,
        NS_CTR_LOST_ALIVE,
        NS_CTR_LOST_RESET,
};
 
#define NSE_S_BLOCKED   0x0001
#define NSE_S_ALIVE     0x0002
#define NSE_S_RESET     0x0004
 
#define NS_DESC_B(st) ((st) & NSE_S_BLOCKED ? "BLOCKED" : "UNBLOCKED")
#define NS_DESC_A(st) ((st) & NSE_S_ALIVE ? "ALIVE" : "DEAD")
#define NS_DESC_R(st) ((st) & NSE_S_RESET ? "RESET" : "UNRESET")
 
struct gprs_ns2_inst {
        osmo_prim_cb cb;
 
        void *cb_data;
 
        struct llist_head binding;
 
        struct llist_head nse;
 
        uint16_t timeout[NS_TIMERS_COUNT];
 
        uint32_t nsvc_rate_ctr_idx;
        uint32_t bind_rate_ctr_idx;
 
        uint32_t txqueue_max_length;
};
 
 
struct gprs_ns2_nse {
        uint16_t nsei;
 
        struct gprs_ns2_inst *nsi;
 
        struct llist_head list;
 
        struct llist_head nsvc;
 
        int nsvc_count;
 
        bool persistent;
 
        bool first;
 
        bool alive;
 
        enum gprs_ns2_ll ll;
 
        enum gprs_ns2_dialect dialect;
 
        struct osmo_fsm_inst *bss_sns_fi;
 
        uint32_t sum_data_weight;
 
        uint32_t sum_sig_weight;
 
        uint16_t mtu;
 
        bool ip_sns_role_sgsn;
 
        struct rate_ctr_group *ctrg;
 
        bool freed;
 
        struct timespec ts_alive_change;
};
 
struct gprs_ns2_vc {
        struct llist_head list;
 
        struct llist_head blist;
 
        struct gprs_ns2_nse *nse;
 
        struct gprs_ns2_vc_bind *bind;
 
        bool persistent;
 
        uint16_t nsvci;
 
        uint8_t sig_weight;
 
        uint8_t sig_counter;
 
        uint8_t data_weight;
 
        void *priv;
 
        bool nsvci_is_valid;
        bool sns_only;
 
        struct rate_ctr_group *ctrg;
        struct osmo_stat_item_group *statg;
 
        enum gprs_ns2_vc_mode mode;
 
        struct osmo_fsm_inst *fi;
 
        bool freed;
 
        bool om_blocked;
 
        struct timespec ts_alive_change;
};
 
struct gprs_ns2_vc_bind {
        const char *name;
        struct llist_head list;
        struct llist_head nsvc;
        void *priv;
        struct gprs_ns2_inst *nsi;
        struct gprs_ns2_vc_driver *driver;
 
        bool accept_ipaccess;
        bool accept_sns;
 
        int transfer_capability;
 
        uint16_t mtu;
 
        enum gprs_ns2_ll ll;
 
        int (*send_vc)(struct gprs_ns2_vc *nsvc, struct msgb *msg);
 
        void (*free_vc)(struct gprs_ns2_vc *nsvc);
 
        void (*dump_vty)(const struct gprs_ns2_vc_bind *bind,
                         struct vty *vty, bool stats);
 
        uint8_t sns_sig_weight;
        uint8_t sns_data_weight;
 
        struct osmo_stat_item_group *statg;
 
        bool freed;
};
 
struct gprs_ns2_vc_driver {
        const char *name;
        void *priv;
        void (*free_bind)(struct gprs_ns2_vc_bind *driver);
};
 
enum ns2_sns_event {
        NS2_SNS_EV_REQ_SELECT_ENDPOINT, 
        NS2_SNS_EV_RX_SIZE,
        NS2_SNS_EV_RX_SIZE_ACK,
        NS2_SNS_EV_RX_CONFIG,
        NS2_SNS_EV_RX_CONFIG_END,               
        NS2_SNS_EV_RX_CONFIG_ACK,
        NS2_SNS_EV_RX_ADD,
        NS2_SNS_EV_RX_DELETE,
        NS2_SNS_EV_RX_CHANGE_WEIGHT,
        NS2_SNS_EV_RX_ACK,                      
        NS2_SNS_EV_REQ_NO_NSVC,         
        NS2_SNS_EV_REQ_FREE_NSVCS,              
        NS2_SNS_EV_REQ_NSVC_ALIVE,              
        NS2_SNS_EV_REQ_ADD_BIND,                
        NS2_SNS_EV_REQ_DELETE_BIND,             
        NS2_SNS_EV_REQ_CHANGE_WEIGHT,           
};
 
enum ns2_cs ns2_create_vc(struct gprs_ns2_vc_bind *bind,
                               struct msgb *msg,
                               const struct osmo_sockaddr *remote,
                               const char *logname,
                               struct msgb **reject,
                               struct gprs_ns2_vc **success);
 
int ns2_recv_vc(struct gprs_ns2_vc *nsvc,
                struct msgb *msg);
 
struct gprs_ns2_vc *ns2_vc_alloc(struct gprs_ns2_vc_bind *bind,
                                 struct gprs_ns2_nse *nse,
                                 bool initiater,
                                 enum gprs_ns2_vc_mode vc_mode,
                                 const char *id);
 
void ns2_free_nsvcs(struct gprs_ns2_nse *nse);
int ns2_bind_alloc(struct gprs_ns2_inst *nsi, const char *name,
                   struct gprs_ns2_vc_bind **result);
 
struct msgb *ns2_msgb_alloc(void);
 
void ns2_sns_write_vty(struct vty *vty, const struct gprs_ns2_nse *nse);
void ns2_sns_dump_vty(struct vty *vty, const char *prefix, const struct gprs_ns2_nse *nse, bool stats);
void ns2_prim_status_ind(struct gprs_ns2_nse *nse,
                         struct gprs_ns2_vc *nsvc,
                         uint16_t bvci,
                         enum gprs_ns2_affecting_cause cause);
void ns2_nse_notify_alive(struct gprs_ns2_vc *nsvc, bool alive);
void ns2_nse_update_mtu(struct gprs_ns2_nse *nse);
int ns2_nse_set_dialect(struct gprs_ns2_nse *nse, enum gprs_ns2_dialect dialect);
 
/* message */
int ns2_validate(struct gprs_ns2_vc *nsvc,
                 uint8_t pdu_type,
                 struct msgb *msg,
                 struct tlv_parsed *tp,
                 uint8_t *cause);
 
/* SNS messages */
int ns2_tx_sns_ack(struct gprs_ns2_vc *nsvc, uint8_t trans_id, uint8_t *cause,
                        const struct gprs_ns_ie_ip4_elem *ip4_elems,
                        unsigned int num_ip4_elems,
                        const struct gprs_ns_ie_ip6_elem *ip6_elems,
                        unsigned int num_ip6_elems);
int ns2_tx_sns_config(struct gprs_ns2_vc *nsvc, bool end_flag,
                           const struct gprs_ns_ie_ip4_elem *ip4_elems,
                           unsigned int num_ip4_elems,
                           const struct gprs_ns_ie_ip6_elem *ip6_elems,
                           unsigned int num_ip6_elems);
int ns2_tx_sns_config_ack(struct gprs_ns2_vc *nsvc, uint8_t *cause);
int ns2_tx_sns_size(struct gprs_ns2_vc *nsvc, bool reset_flag, uint16_t max_nr_nsvc,
                         int ip4_ep_nr, int ip6_ep_nr);
int ns2_tx_sns_size_ack(struct gprs_ns2_vc *nsvc, uint8_t *cause);
 
int ns2_tx_sns_add(struct gprs_ns2_vc *nsvc,
                   uint8_t trans_id,
                   const struct gprs_ns_ie_ip4_elem *ip4_elems,
                   unsigned int num_ip4_elems,
                   const struct gprs_ns_ie_ip6_elem *ip6_elems,
                   unsigned int num_ip6_elems);
int ns2_tx_sns_change_weight(struct gprs_ns2_vc *nsvc,
                             uint8_t trans_id,
                             const struct gprs_ns_ie_ip4_elem *ip4_elems,
                             unsigned int num_ip4_elems,
                             const struct gprs_ns_ie_ip6_elem *ip6_elems,
                             unsigned int num_ip6_elems);
int ns2_tx_sns_del(struct gprs_ns2_vc *nsvc,
                   uint8_t trans_id,
                   const struct gprs_ns_ie_ip4_elem *ip4_elems,
                   unsigned int num_ip4_elems,
                   const struct gprs_ns_ie_ip6_elem *ip6_elems,
                   unsigned int num_ip6_elems);
 
/* transmit message over a VC */
int ns2_tx_block(struct gprs_ns2_vc *nsvc, uint8_t cause, uint16_t *nsvci);
int ns2_tx_block_ack(struct gprs_ns2_vc *nsvc, uint16_t *nsvci);
 
int ns2_tx_reset(struct gprs_ns2_vc *nsvc, uint8_t cause);
int ns2_tx_reset_ack(struct gprs_ns2_vc *nsvc);
 
int ns2_tx_unblock(struct gprs_ns2_vc *nsvc);
int ns2_tx_unblock_ack(struct gprs_ns2_vc *nsvc);
 
int ns2_tx_alive(struct gprs_ns2_vc *nsvc);
int ns2_tx_alive_ack(struct gprs_ns2_vc *nsvc);
 
int ns2_tx_unit_data(struct gprs_ns2_vc *nsvc,
                     uint16_t bvci, uint8_t sducontrol,
                     struct msgb *msg);
 
int ns2_tx_status(struct gprs_ns2_vc *nsvc, uint8_t cause,
                  uint16_t bvci, struct msgb *orig_msg, uint16_t *nsvci);
 
/* driver */
struct gprs_ns2_vc *ns2_ip_bind_connect(struct gprs_ns2_vc_bind *bind,
                                        struct gprs_ns2_nse *nse,
                                        const struct osmo_sockaddr *remote);
int ns2_ip_count_bind(struct gprs_ns2_inst *nsi, struct osmo_sockaddr *remote);
struct gprs_ns2_vc_bind *ns2_ip_get_bind_by_index(struct gprs_ns2_inst *nsi,
                                                  struct osmo_sockaddr *remote,
                                                  int index);
void ns2_ip_set_txqueue_max_length(struct gprs_ns2_vc_bind *bind, unsigned int max_length);
 
/* sns */
int ns2_sns_rx(struct gprs_ns2_vc *nsvc, struct msgb *msg, struct tlv_parsed *tp);
struct osmo_fsm_inst *ns2_sns_bss_fsm_alloc(struct gprs_ns2_nse *nse,
                                             const char *id);
struct osmo_fsm_inst *ns2_sns_sgsn_fsm_alloc(struct gprs_ns2_nse *nse, const char *id);
void ns2_sns_replace_nsvc(struct gprs_ns2_vc *nsvc);
void ns2_sns_notify_alive(struct gprs_ns2_nse *nse, struct gprs_ns2_vc *nsvc, bool alive);
void ns2_sns_update_weights(struct gprs_ns2_vc_bind *bind);
 
/* vc */
struct osmo_fsm_inst *ns2_vc_fsm_alloc(struct gprs_ns2_vc *nsvc,
                                            const char *id, bool initiate);
int ns2_vc_fsm_start(struct gprs_ns2_vc *nsvc);
int ns2_vc_force_unconfigured(struct gprs_ns2_vc *nsvc);
int ns2_vc_rx(struct gprs_ns2_vc *nsvc, struct msgb *msg, struct tlv_parsed *tp);
int ns2_vc_is_alive(struct gprs_ns2_vc *nsvc);
int ns2_vc_is_unblocked(struct gprs_ns2_vc *nsvc);
int ns2_vc_block(struct gprs_ns2_vc *nsvc);
int ns2_vc_reset(struct gprs_ns2_vc *nsvc);
int ns2_vc_unblock(struct gprs_ns2_vc *nsvc);
void ns2_vty_dump_nsvc(struct vty *vty, struct gprs_ns2_vc *nsvc, bool stats);
 
/* nse */
void ns2_nse_notify_unblocked(struct gprs_ns2_vc *nsvc, bool unblocked);
enum gprs_ns2_vc_mode ns2_dialect_to_vc_mode(enum gprs_ns2_dialect dialect);
int ns2_count_transfer_cap(struct gprs_ns2_nse *nse,
                           uint16_t bvci);
 
/* vty */
int ns2_sns_add_sns_default_binds(struct gprs_ns2_nse *nse);