#pragma once #include #include #include #include #include #include #include #include #include extern struct llist_head osmo_ss7_instances; struct osmo_ss7_instance; struct osmo_ss7_user; struct osmo_sccp_instance; struct osmo_mtp_prim; struct osmo_xua_layer_manager; int osmo_ss7_init(void); int osmo_ss7_find_free_rctx(struct osmo_ss7_instance *inst); bool osmo_ss7_pc_is_local(struct osmo_ss7_instance *inst, uint32_t pc); int osmo_ss7_pointcode_parse(struct osmo_ss7_instance *inst, const char *str); int osmo_ss7_pointcode_parse_mask_or_len(struct osmo_ss7_instance *inst, const char *in); const char *osmo_ss7_pointcode_print_buf(char *buf, size_t buf_len, const struct osmo_ss7_instance *inst, uint32_t pc); const char *osmo_ss7_pointcode_print(const struct osmo_ss7_instance *inst, uint32_t pc); const char *osmo_ss7_pointcode_print2(const struct osmo_ss7_instance *inst, uint32_t pc); /* All known point-code formats have a length of or below 24 bit. * A point-code value exceeding that is used to indicate an unset PC. */ #define OSMO_SS7_PC_INVALID 0xffffffff static inline bool osmo_ss7_pc_is_valid(uint32_t pc) { return pc <= 0x00ffffff; } /*********************************************************************** * SS7 Routing Tables ***********************************************************************/ struct osmo_ss7_route_table { /*! member in list of routing tables */ struct llist_head list; /*! \ref osmo_ss7_instance to which we belong */ struct osmo_ss7_instance *inst; /*! list of \ref osmo_ss7_route */ struct llist_head routes; struct { char *name; char *description; } cfg; }; struct osmo_ss7_route_table * osmo_ss7_route_table_find(struct osmo_ss7_instance *inst, const char *name); struct osmo_ss7_route_table * osmo_ss7_route_table_find_or_create(struct osmo_ss7_instance *inst, const char *name); void osmo_ss7_route_table_destroy(struct osmo_ss7_route_table *rtbl); /*********************************************************************** * SS7 Instances ***********************************************************************/ struct osmo_ss7_pc_fmt { char delimiter; uint8_t component_len[3]; }; struct osmo_ss7_instance { /*! member of global list of instances */ struct llist_head list; /*! list of \ref osmo_ss7_linkset */ struct llist_head linksets; /*! list of \ref osmo_ss7_as */ struct llist_head as_list; /*! list of \ref osmo_ss7_asp */ struct llist_head asp_list; /*! list of \ref osmo_ss7_route_table */ struct llist_head rtable_list; /*! list of \ref osmo_xua_servers */ struct llist_head xua_servers; /* array for faster lookup of user (indexed by service * indicator) */ const struct osmo_ss7_user *user[16]; struct osmo_ss7_route_table *rtable_system; struct osmo_sccp_instance *sccp; struct { uint32_t id; char *name; char *description; uint32_t primary_pc; /* secondary PCs */ /* capability PCs */ uint8_t network_indicator; struct osmo_ss7_pc_fmt pc_fmt; bool permit_dyn_rkm_alloc; struct llist_head sccp_address_book; } cfg; }; struct osmo_ss7_instance *osmo_ss7_instance_find(uint32_t id); struct osmo_ss7_instance * osmo_ss7_instance_find_or_create(void *ctx, uint32_t id); void osmo_ss7_instance_destroy(struct osmo_ss7_instance *inst); int osmo_ss7_instance_set_pc_fmt(struct osmo_ss7_instance *inst, uint8_t c0, uint8_t c1, uint8_t c2); struct osmo_sccp_instance *osmo_ss7_ensure_sccp(struct osmo_ss7_instance *inst); uint8_t osmo_ss7_pc_width(const struct osmo_ss7_pc_fmt *pc_fmt); uint32_t osmo_ss7_pc_normalize(const struct osmo_ss7_pc_fmt *pc_fmt, uint32_t pc); /*********************************************************************** * MTP Users (Users of MTP, such as SCCP or ISUP) ***********************************************************************/ struct osmo_ss7_user { /* pointer back to SS7 instance */ struct osmo_ss7_instance *inst; /* name of the user */ const char *name; /* primitive call-back for incoming MTP primitives */ osmo_prim_cb prim_cb; /* private data */ void *priv; }; int osmo_ss7_user_register(struct osmo_ss7_instance *inst, uint8_t service_ind, struct osmo_ss7_user *user); int osmo_ss7_user_unregister(struct osmo_ss7_instance *inst, uint8_t service_ind, struct osmo_ss7_user *user); int osmo_ss7_mtp_to_user(struct osmo_ss7_instance *inst, struct osmo_mtp_prim *omp); /* SS7 User wants to issue MTP-TRANSFER.req */ int osmo_ss7_user_mtp_xfer_req(struct osmo_ss7_instance *inst, struct osmo_mtp_prim *omp); /*********************************************************************** * SS7 Links ***********************************************************************/ enum osmo_ss7_link_adm_state { OSMO_SS7_LS_SHUTDOWN, OSMO_SS7_LS_INHIBITED, OSMO_SS7_LS_ENABLED, _NUM_OSMO_SS7_LS }; struct osmo_ss7_linkset; struct osmo_ss7_link; struct osmo_ss7_link { /*! \ref osmo_ss7_linkset to which we belong */ struct osmo_ss7_linkset *linkset; struct { char *name; char *description; uint32_t id; enum osmo_ss7_link_adm_state adm_state; } cfg; }; void osmo_ss7_link_destroy(struct osmo_ss7_link *link); struct osmo_ss7_link * osmo_ss7_link_find_or_create(struct osmo_ss7_linkset *lset, uint32_t id); /*********************************************************************** * SS7 Linksets ***********************************************************************/ struct osmo_ss7_linkset { struct llist_head list; /*! \ref osmo_ss7_instance to which we belong */ struct osmo_ss7_instance *inst; /*! array of \ref osmo_ss7_link */ struct osmo_ss7_link *links[16]; struct { char *name; char *description; uint32_t adjacent_pc; uint32_t local_pc; } cfg; }; void osmo_ss7_linkset_destroy(struct osmo_ss7_linkset *lset); struct osmo_ss7_linkset * osmo_ss7_linkset_find_by_name(struct osmo_ss7_instance *inst, const char *name); struct osmo_ss7_linkset * osmo_ss7_linkset_find_or_create(struct osmo_ss7_instance *inst, const char *name, uint32_t pc); /*********************************************************************** * SS7 Routes ***********************************************************************/ struct osmo_ss7_route { /*! member in \ref osmo_ss7_route_table.routes */ struct llist_head list; /*! \ref osmo_ss7_route_table to which we belong */ struct osmo_ss7_route_table *rtable; struct { /*! pointer to linkset (destination) of route */ struct osmo_ss7_linkset *linkset; /*! pointer to Application Server */ struct osmo_ss7_as *as; } dest; struct { /* FIXME: presence? */ uint32_t pc; uint32_t mask; /*! human-specified linkset name */ char *linkset_name; /*! lower priority is higher */ uint32_t priority; uint8_t qos_class; } cfg; }; struct osmo_ss7_route * osmo_ss7_route_find_dpc(struct osmo_ss7_route_table *rtbl, uint32_t dpc); struct osmo_ss7_route * osmo_ss7_route_find_dpc_mask(struct osmo_ss7_route_table *rtbl, uint32_t dpc, uint32_t mask); struct osmo_ss7_route * osmo_ss7_route_lookup(struct osmo_ss7_instance *inst, uint32_t dpc); struct osmo_ss7_route * osmo_ss7_route_create(struct osmo_ss7_route_table *rtbl, uint32_t dpc, uint32_t mask, const char *linkset_name); void osmo_ss7_route_destroy(struct osmo_ss7_route *rt); const char *osmo_ss7_route_print(const struct osmo_ss7_route *rt); const char *osmo_ss7_route_name(struct osmo_ss7_route *rt, bool list_asps); /*********************************************************************** * SS7 Application Servers ***********************************************************************/ struct osmo_ss7_routing_key { uint32_t context; uint32_t l_rk_id; uint32_t pc; uint8_t si; uint32_t ssn; /* FIXME: more complex routing keys */ }; enum osmo_ss7_as_traffic_mode { OSMO_SS7_AS_TMOD_OVERRIDE = 0, /* default */ OSMO_SS7_AS_TMOD_BCAST, OSMO_SS7_AS_TMOD_LOADSHARE, OSMO_SS7_AS_TMOD_ROUNDROBIN, _NUM_OSMO_SS7_ASP_TMOD }; extern struct value_string osmo_ss7_as_traffic_mode_vals[]; static inline const char * osmo_ss7_as_traffic_mode_name(enum osmo_ss7_as_traffic_mode mode) { return get_value_string(osmo_ss7_as_traffic_mode_vals, mode); } enum osmo_ss7_asp_protocol { OSMO_SS7_ASP_PROT_NONE, OSMO_SS7_ASP_PROT_SUA, OSMO_SS7_ASP_PROT_M3UA, OSMO_SS7_ASP_PROT_IPA, _NUM_OSMO_SS7_ASP_PROT }; extern struct value_string osmo_ss7_asp_protocol_vals[]; static inline const char * osmo_ss7_asp_protocol_name(enum osmo_ss7_asp_protocol mode) { return get_value_string(osmo_ss7_asp_protocol_vals, mode); } int osmo_ss7_asp_protocol_port(enum osmo_ss7_asp_protocol prot); enum osmo_ss7_as_patch_sccp_mode { OSMO_SS7_PATCH_NONE, /* no patching of SCCP */ OSMO_SS7_PATCH_BOTH, /* patch both OPC and DPC into SCCP addresses */ }; struct osmo_ss7_as { /*! entry in 'ref osmo_ss7_instance.as_list */ struct llist_head list; struct osmo_ss7_instance *inst; /*! AS FSM */ struct osmo_fsm_inst *fi; /*! Were we dynamically allocated by RKM? */ bool rkm_dyn_allocated; /*! Were we allocated by "simple client" support? */ bool simple_client_allocated; /*! Rate Counter Group */ struct rate_ctr_group *ctrg; struct { char *name; char *description; enum osmo_ss7_asp_protocol proto; struct osmo_ss7_routing_key routing_key; enum osmo_ss7_as_traffic_mode mode; /* traffic mode was configured by VTY / config file */ bool mode_set_by_vty; /* traffic mode was configured by RKM (routing key management) or first ASPAC */ bool mode_set_by_peer; uint32_t recovery_timeout_msec; uint8_t qos_class; struct { uint32_t dpc; enum osmo_ss7_as_patch_sccp_mode sccp_mode; } pc_override; struct osmo_ss7_asp *asps[16]; uint8_t last_asp_idx_sent; /* used for load-sharing traffic mode (round robin implementation) */ } cfg; }; struct osmo_ss7_as * osmo_ss7_as_find_by_name(struct osmo_ss7_instance *inst, const char *name); struct osmo_ss7_as * osmo_ss7_as_find_by_rctx(struct osmo_ss7_instance *inst, uint32_t rctx); struct osmo_ss7_as * osmo_ss7_as_find_by_l_rk_id(struct osmo_ss7_instance *inst, uint32_t l_rk_id); struct osmo_ss7_as *osmo_ss7_as_find_by_proto(struct osmo_ss7_instance *inst, enum osmo_ss7_asp_protocol proto); struct osmo_ss7_as * osmo_ss7_as_find_or_create(struct osmo_ss7_instance *inst, const char *name, enum osmo_ss7_asp_protocol proto); int osmo_ss7_as_add_asp(struct osmo_ss7_as *as, const char *asp_name); int osmo_ss7_as_del_asp(struct osmo_ss7_as *as, const char *asp_name); void osmo_ss7_as_destroy(struct osmo_ss7_as *as); bool osmo_ss7_as_has_asp(const struct osmo_ss7_as *as, const struct osmo_ss7_asp *asp); bool osmo_ss7_as_down(const struct osmo_ss7_as *as); bool osmo_ss7_as_active(const struct osmo_ss7_as *as); bool osmo_ss7_as_tmode_compatible_xua(struct osmo_ss7_as *as, uint32_t m3ua_tmt); void osmo_ss7_asp_disconnect(struct osmo_ss7_asp *asp); /*********************************************************************** * SS7 Application Server Processes ***********************************************************************/ struct osmo_ss7_asp_peer { char *host[OSMO_SOCK_MAX_ADDRS]; size_t host_cnt; uint16_t port; /* index in "hosts" array marking the SCTP Primary Address, -1 if no explicit Primary Address set */ int idx_primary; }; enum osmo_ss7_asp_admin_state { /*! no SCTP association with peer */ OSMO_SS7_ASP_ADM_S_SHUTDOWN, /*! SCP association, but reject ASP-ACTIVE */ OSMO_SS7_ASP_ADM_S_BLOCKED, /*! in normal operation */ OSMO_SS7_ASP_ADM_S_ENABLED, }; enum osmo_ss7_asp_role { OSMO_SS7_ASP_ROLE_ASP, OSMO_SS7_ASP_ROLE_SG, OSMO_SS7_ASP_ROLE_IPSP, }; extern const struct value_string osmo_ss7_asp_role_names[]; struct osmo_ss7_asp { /*! entry in \ref osmo_ss7_instance.asp_list */ struct llist_head list; struct osmo_ss7_instance *inst; /*! ASP FSM */ struct osmo_fsm_inst *fi; /*! \ref osmo_xua_server over which we were established */ struct osmo_xua_server *xua_server; struct llist_head siblings; /*! osmo_stream / libosmo-netif handles */ struct osmo_stream_cli *client; struct osmo_stream_srv *server; /*! pre-formatted human readable local/remote socket name */ char *sock_name; /* ASP Identifier for ASP-UP + NTFY */ uint32_t asp_id; bool asp_id_present; /* Layer Manager to which we talk */ const struct osmo_xua_layer_manager *lm; void *lm_priv; /*! Were we dynamically allocated */ bool dyn_allocated; /*! Were we allocated by "simple client" support? */ bool simple_client_allocated; /*! Rate Counter Group */ struct rate_ctr_group *ctrg; /*! Pending message for non-blocking IPA read */ struct msgb *pending_msg; struct { char *name; char *description; enum osmo_ss7_asp_protocol proto; enum osmo_ss7_asp_admin_state adm_state; bool is_server; enum osmo_ss7_asp_role role; bool role_set_by_vty; bool trans_role_set_by_vty; struct osmo_ss7_asp_peer local; struct osmo_ss7_asp_peer remote; uint8_t qos_class; uint32_t quirks; /* T_defs used by the default_lm: */ struct osmo_tdef *T_defs_lm; struct { bool num_ostreams_present; bool max_instreams_present; bool max_attempts_present; bool max_init_timeo_present; uint16_t num_ostreams_value; uint16_t max_instreams_value; uint16_t max_attempts_value; uint16_t max_init_timeo_value; /* ms */ } sctp_init; /*! The underlaying transport protocol (one of IPPROTO_*) */ int trans_proto; } cfg; }; /*! Peer SG doesn't send NTFY(AS-INACTIVE) after ASP-UP procedure */ #define OSMO_SS7_ASP_QUIRK_NO_NOTIFY 0x00000001 /*! Accept DAUD in ASP role (RFC states only permitted in ASP->SG role) */ #define OSMO_SS7_ASP_QUIRK_DAUD_IN_ASP 0x00000002 /*! Accept SSNM even if ASP is in AS-INACTIVE state */ #define OSMO_SS7_ASP_QUIRK_SNM_INACTIVE 0x00000004 int osmo_ss7_asp_peer_snprintf(char* buf, size_t buf_len, struct osmo_ss7_asp_peer *peer); void osmo_ss7_asp_peer_init(struct osmo_ss7_asp_peer *peer); int osmo_ss7_asp_peer_set_hosts(struct osmo_ss7_asp_peer *peer, void *talloc_ctx, const char *const*hosts, size_t host_cnt); int osmo_ss7_asp_peer_set_hosts2(struct osmo_ss7_asp_peer *peer, void *talloc_ctx, const char *const*hosts, size_t host_cnt, int idx_primary); int osmo_ss7_asp_peer_add_host(struct osmo_ss7_asp_peer *peer, void *talloc_ctx, const char *host); int osmo_ss7_asp_peer_add_host2(struct osmo_ss7_asp_peer *peer, void *talloc_ctx, const char *host, bool is_primary_addr); int osmo_ss7_asp_peer_del_host(struct osmo_ss7_asp_peer *peer, const char *host); struct osmo_ss7_asp * osmo_ss7_asp_find_by_name(struct osmo_ss7_instance *inst, const char *name); struct osmo_ss7_asp * osmo_ss7_asp_find_by_proto(struct osmo_ss7_as *as, enum osmo_ss7_asp_protocol proto); struct osmo_ss7_asp * osmo_ss7_asp_find(struct osmo_ss7_instance *inst, const char *name, uint16_t remote_port, uint16_t local_port, enum osmo_ss7_asp_protocol proto) OSMO_DEPRECATED("Use osmo_ss7_asp_find2() instead"); struct osmo_ss7_asp * osmo_ss7_asp_find2(struct osmo_ss7_instance *inst, const char *name, uint16_t remote_port, uint16_t local_port, int trans_proto, enum osmo_ss7_asp_protocol proto); struct osmo_ss7_asp * osmo_ss7_asp_find_or_create(struct osmo_ss7_instance *inst, const char *name, uint16_t remote_port, uint16_t local_port, enum osmo_ss7_asp_protocol proto) OSMO_DEPRECATED("Use osmo_ss7_asp_find_or_create2() instead"); struct osmo_ss7_asp * osmo_ss7_asp_find_or_create2(struct osmo_ss7_instance *inst, const char *name, uint16_t remote_port, uint16_t local_port, int trans_proto, enum osmo_ss7_asp_protocol proto); void osmo_ss7_asp_destroy(struct osmo_ss7_asp *asp); int osmo_ss7_asp_send(struct osmo_ss7_asp *asp, struct msgb *msg); int osmo_ss7_asp_restart(struct osmo_ss7_asp *asp); int osmo_ss7_asp_use_default_lm(struct osmo_ss7_asp *asp, int log_level); bool osmo_ss7_asp_active(const struct osmo_ss7_asp *asp); int osmo_ss7_asp_get_log_subsys(const struct osmo_ss7_asp *asp); const char *osmo_ss7_asp_get_name(const struct osmo_ss7_asp *asp); enum osmo_ss7_asp_protocol osmo_ss7_asp_get_proto(const struct osmo_ss7_asp *asp); int osmo_ss7_asp_get_trans_proto(const struct osmo_ss7_asp *asp); /*! Weak function to handle payload for unknown/unsupported PPID or IPA StreamID. * This function can be overridden by application code to implement whatever handling * it wants for such additional payloads/streams. * \param[in] asp Application Server Process through which data was received * \param[in] ppid_sid SCTP PPID (in sigtran case) or IPA Stream ID * \param[in] msg Message buffer containing received data. Continues to be owned by caller! * \return 0 on success; negative on error */ typedef int osmo_ss7_asp_rx_unknown_cb(struct osmo_ss7_asp *asp, int ppid_mux, struct msgb *msg); void osmo_ss7_register_rx_unknown_cb(osmo_ss7_asp_rx_unknown_cb *cb); #define _LOGSS7(inst, subsys, level, fmt, args ...) \ LOGP(subsys, level, "%u: " fmt, inst ? (inst)->cfg.id : 0, ## args) #define LOGSS7(inst, level, fmt, args ...) _LOGSS7(inst, DLSS7, level, fmt, ## args) #define LOGPASP(asp, subsys, level, fmt, args ...) \ _LOGSS7((asp)->inst, subsys, level, "asp-%s: " fmt, (asp)->cfg.name, ## args) #define LOGPAS(as, subsys, level, fmt, args ...) \ _LOGSS7((as)->inst, subsys, level, "as-%s: " fmt, (as)->cfg.name, ## args) /*********************************************************************** * xUA Servers ***********************************************************************/ struct osmo_xua_layer_manager { osmo_prim_cb prim_cb; }; struct osmo_xua_server { struct llist_head list; struct osmo_ss7_instance *inst; /* list of ASPs established via this server */ struct llist_head asp_list; struct osmo_stream_srv_link *server; struct { bool accept_dyn_reg; struct osmo_ss7_asp_peer local; enum osmo_ss7_asp_protocol proto; struct { bool num_ostreams_present; bool max_instreams_present; uint16_t num_ostreams_value; uint16_t max_instreams_value; } sctp_init; /*! The underlaying transport protocol (one of IPPROTO_*) */ int trans_proto; } cfg; }; struct osmo_xua_server * osmo_ss7_xua_server_find(struct osmo_ss7_instance *inst, enum osmo_ss7_asp_protocol proto, uint16_t local_port) OSMO_DEPRECATED("Use osmo_ss7_xua_server_find2() instead"); struct osmo_xua_server * osmo_ss7_xua_server_find2(struct osmo_ss7_instance *inst, int trans_proto, enum osmo_ss7_asp_protocol proto, uint16_t local_port); struct osmo_xua_server * osmo_ss7_xua_server_create(struct osmo_ss7_instance *inst, enum osmo_ss7_asp_protocol proto, uint16_t local_port, const char *local_host) OSMO_DEPRECATED("Use osmo_ss7_xua_server_create2() instead"); struct osmo_xua_server * osmo_ss7_xua_server_create2(struct osmo_ss7_instance *inst, int trans_proto, enum osmo_ss7_asp_protocol proto, uint16_t local_port, const char *local_host); int osmo_ss7_xua_server_bind(struct osmo_xua_server *xs); int osmo_ss7_xua_server_set_local_host(struct osmo_xua_server *xs, const char *local_host); int osmo_ss7_xua_server_set_local_hosts(struct osmo_xua_server *xs, const char **local_hosts, size_t local_host_cnt); int osmo_ss7_xua_server_add_local_host(struct osmo_xua_server *xs, const char *local_host); int osmo_ss7_xua_server_del_local_host(struct osmo_xua_server *xs, const char *local_host); void osmo_ss7_xua_server_destroy(struct osmo_xua_server *xs); struct osmo_sccp_instance * osmo_sccp_simple_client(void *ctx, const char *name, uint32_t default_pc, enum osmo_ss7_asp_protocol prot, int default_local_port, const char *default_local_ip, int default_remote_port, const char *default_remote_ip); struct osmo_sccp_instance * osmo_sccp_simple_client_on_ss7_id(void *ctx, uint32_t ss7_id, const char *name, uint32_t default_pc, enum osmo_ss7_asp_protocol prot, int default_local_port, const char *default_local_ip, int default_remote_port, const char *default_remote_ip); struct osmo_sccp_instance * osmo_sccp_simple_server(void *ctx, uint32_t pc, enum osmo_ss7_asp_protocol prot, int local_port, const char *local_ip); struct osmo_sccp_instance * osmo_sccp_simple_server_on_ss7_id(void *ctx, uint32_t ss7_id, uint32_t pc, enum osmo_ss7_asp_protocol prot, int local_port, const char *local_ip); struct osmo_sccp_instance * osmo_sccp_simple_server_add_clnt(struct osmo_sccp_instance *inst, enum osmo_ss7_asp_protocol prot, const char *name, uint32_t pc, int local_port, int remote_port, const char *remote_ip); void osmo_sccp_set_max_optional_data(struct osmo_sccp_instance *inst, int val); enum osmo_ss7_as_traffic_mode osmo_ss7_tmode_from_xua(uint32_t in); int osmo_ss7_tmode_to_xua(enum osmo_ss7_as_traffic_mode tmod); /* VTY related */ struct vty; void osmo_ss7_vty_init_asp(void *ctx); void osmo_ss7_vty_init_sg(void *ctx); int osmo_ss7_vty_go_parent(struct vty *vty); int osmo_ss7_is_config_node(struct vty *vty, int node);