libosmo-sigtran 2.0.0.50-b59d
Osmocom SIGTRAN library
osmo_ss7.h File Reference
#include <stdint.h>
#include <stdbool.h>
#include <osmocom/core/linuxlist.h>
#include <osmocom/core/utils.h>
#include <osmocom/core/fsm.h>
#include <osmocom/core/msgb.h>
#include <osmocom/core/prim.h>
#include <osmocom/core/socket.h>
#include <osmocom/core/rate_ctr.h>

Go to the source code of this file.

Data Structures

struct  osmo_ss7_routing_key
 

Macros

#define OSMO_SS7_PC_INVALID   0xffffffff
 
#define OSMO_SS7_ASP_QUIRK_NO_NOTIFY   0x00000001
 Peer SG doesn't send NTFY(AS-INACTIVE) after ASP-UP procedure. More...
 
#define OSMO_SS7_ASP_QUIRK_DAUD_IN_ASP   0x00000002
 Accept DAUD in ASP role (RFC states only permitted in ASP->SG role) More...
 
#define OSMO_SS7_ASP_QUIRK_SNM_INACTIVE   0x00000004
 Accept SSNM even if ASP is in AS-INACTIVE state. More...
 

Typedefs

typedef int osmo_ss7_asp_rx_unknown_cb(struct osmo_ss7_asp *asp, int ppid_mux, struct msgb *msg)
 Weak function to handle payload for unknown/unsupported PPID or IPA StreamID. More...
 

Enumerations

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
}
 
enum  osmo_ss7_as_traffic_mode {
  OSMO_SS7_AS_TMOD_OVERRIDE = 0 , OSMO_SS7_AS_TMOD_BCAST , OSMO_SS7_AS_TMOD_LOADSHARE , OSMO_SS7_AS_TMOD_ROUNDROBIN ,
  _NUM_OSMO_SS7_ASP_TMOD
}
 
enum  osmo_ss7_asp_admin_state { OSMO_SS7_ASP_ADM_S_SHUTDOWN , OSMO_SS7_ASP_ADM_S_BLOCKED , 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 }
 

Functions

struct osmo_ss7_instanceosmo_ss7_instances_llist_entry (struct llist_head *list)
 
int osmo_ss7_init (void)
 
static bool osmo_ss7_pc_is_valid (uint32_t pc)
 
struct osmo_ss7_instanceosmo_ss7_instance_find (uint32_t id)
 Find a SS7 Instance with given ID. More...
 
struct osmo_ss7_instanceosmo_ss7_instance_find_or_create (void *ctx, uint32_t id)
 Find or create a SS7 Instance. More...
 
void osmo_ss7_instance_destroy (struct osmo_ss7_instance *inst)
 Destroy a SS7 Instance. More...
 
uint32_t osmo_ss7_instance_get_id (const struct osmo_ss7_instance *inst)
 
const char * osmo_ss7_instance_get_name (const 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)
 Set the point code format used in given SS7 instance. More...
 
const struct osmo_ss7_pc_fmtosmo_ss7_instance_get_pc_fmt (const struct osmo_ss7_instance *inst)
 
uint32_t osmo_ss7_instance_get_primary_pc (const struct osmo_ss7_instance *inst)
 
struct osmo_sccp_instanceosmo_ss7_ensure_sccp (struct osmo_ss7_instance *inst)
 Allocate an SCCP instance, if not present yet. More...
 
struct osmo_sccp_instanceosmo_ss7_get_sccp (const struct osmo_ss7_instance *inst)
 Get the SCCP instance, if present. More...
 
int osmo_ss7_find_free_rctx (struct osmo_ss7_instance *inst)
 
bool osmo_ss7_pc_is_local (const struct osmo_ss7_instance *inst, uint32_t pc)
 
int osmo_ss7_pointcode_parse (const struct osmo_ss7_instance *inst, const char *str)
 
int osmo_ss7_pointcode_parse_mask_or_len (const 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)
 
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)
 
struct osmo_ss7_userosmo_ss7_user_create (struct osmo_ss7_instance *inst, const char *name)
 
void osmo_ss7_user_destroy (struct osmo_ss7_user *user)
 
struct osmo_ss7_instanceosmo_ss7_user_get_instance (const struct osmo_ss7_user *user)
 
void osmo_ss7_user_set_prim_cb (struct osmo_ss7_user *user, osmo_prim_cb prim_cb)
 
void osmo_ss7_user_set_priv (struct osmo_ss7_user *user, void *priv)
 
void * osmo_ss7_user_get_priv (const struct osmo_ss7_user *user)
 
int osmo_ss7_user_register (struct osmo_ss7_instance *inst, uint8_t service_ind, struct osmo_ss7_user *user)
 Register a MTP user for a given service indicator. More...
 
int osmo_ss7_user_unregister (struct osmo_ss7_instance *inst, uint8_t service_ind, struct osmo_ss7_user *user)
 Unregister a MTP user for a given service indicator. More...
 
int osmo_ss7_user_mtp_xfer_req (struct osmo_ss7_instance *inst, struct osmo_mtp_prim *omp)
 
void osmo_sccp_set_max_optional_data (struct osmo_sccp_instance *inst, int val)
 Adjust the upper bound for the optional data length (the payload) for CR, CC, CREF and RLSD messages. More...
 
struct osmo_ss7_routeosmo_ss7_route_lookup (struct osmo_ss7_instance *inst, uint32_t dpc)
 Find a SS7 route for given destination point code in given SS7. More...
 
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)
 Return human readable representation of the route, in a static buffer. More...
 
struct osmo_ss7_asosmo_ss7_route_get_dest_as (struct osmo_ss7_route *rt)
 Get destination AS of route. More...
 
static const char * osmo_ss7_asp_protocol_name (enum osmo_ss7_asp_protocol mode)
 
int osmo_ss7_asp_protocol_port (enum osmo_ss7_asp_protocol prot)
 
static const char * osmo_ss7_as_traffic_mode_name (enum osmo_ss7_as_traffic_mode mode)
 
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)
 
struct osmo_ss7_asosmo_ss7_as_find_by_name (struct osmo_ss7_instance *inst, const char *name)
 Find Application Server by given name. More...
 
struct osmo_ss7_asosmo_ss7_as_find_by_rctx (struct osmo_ss7_instance *inst, uint32_t rctx)
 Find Application Server by given routing context. More...
 
struct osmo_ss7_asosmo_ss7_as_find_by_l_rk_id (struct osmo_ss7_instance *inst, uint32_t l_rk_id)
 Find Application Server by given local routing key ID. More...
 
struct osmo_ss7_asosmo_ss7_as_find_by_proto (struct osmo_ss7_instance *inst, enum osmo_ss7_asp_protocol proto)
 Find Application Server (AS) by given protocol. More...
 
struct osmo_ss7_asosmo_ss7_as_find_or_create (struct osmo_ss7_instance *inst, const char *name, enum osmo_ss7_asp_protocol proto)
 Find or Create Application Server. More...
 
enum osmo_ss7_asp_protocol osmo_ss7_as_get_asp_protocol (const struct osmo_ss7_as *as)
 Get asp_protocol configuration of a given AS. More...
 
int osmo_ss7_as_add_asp (struct osmo_ss7_as *as, const char *asp_name)
 Add given ASP to given AS. More...
 
int osmo_ss7_as_del_asp (struct osmo_ss7_as *as, const char *asp_name)
 Delete given ASP from given AS. More...
 
void osmo_ss7_as_destroy (struct osmo_ss7_as *as)
 Destroy given Application Server. More...
 
bool osmo_ss7_as_has_asp (const struct osmo_ss7_as *as, const struct osmo_ss7_asp *asp)
 Determine if given AS contains ASP. More...
 
struct osmo_ss7_asposmo_ss7_as_select_asp (struct osmo_ss7_as *as)
 Select an AS to transmit a message, according to AS configuration and ASP availability. More...
 
bool osmo_ss7_as_down (const struct osmo_ss7_as *as)
 Determine if given AS is in the down state. More...
 
bool osmo_ss7_as_active (const struct osmo_ss7_as *as)
 Determine if given AS is in the active state. More...
 
bool osmo_ss7_as_tmode_compatible_xua (struct osmo_ss7_as *as, uint32_t m3ua_tmt)
 
struct osmo_ss7_asposmo_ss7_asp_find_by_name (struct osmo_ss7_instance *inst, const char *name)
 
struct osmo_ss7_asposmo_ss7_asp_find_by_proto (struct osmo_ss7_as *as, enum osmo_ss7_asp_protocol proto)
 Find an ASP that matches the given ASP protocol (xUA variant). More...
 
struct osmo_ss7_asposmo_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_asposmo_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_asposmo_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_asposmo_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_disconnect (struct osmo_ss7_asp *asp)
 
void osmo_ss7_asp_destroy (struct osmo_ss7_asp *asp)
 
int osmo_ss7_asp_send (struct osmo_ss7_asp *asp, struct msgb *msg)
 send a fully encoded msgb via a given ASP More...
 
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)
 Get the logging subsystem for a given ASP. More...
 
const char * osmo_ss7_asp_get_name (const struct osmo_ss7_asp *asp)
 Get the name of a given ASP. More...
 
enum osmo_ss7_asp_protocol osmo_ss7_asp_get_proto (const struct osmo_ss7_asp *asp)
 Get the proto of a given ASP. More...
 
int osmo_ss7_asp_get_trans_proto (const struct osmo_ss7_asp *asp)
 Get the transport proto of a given ASP. More...
 
void osmo_ss7_register_rx_unknown_cb (osmo_ss7_asp_rx_unknown_cb *cb)
 Register a call-back function for unknown SCTP PPID / IPA Stream ID. More...
 
struct osmo_sccp_instanceosmo_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)
 request an sccp client instance More...
 
struct osmo_sccp_instanceosmo_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)
 request an sccp client instance More...
 
struct osmo_sccp_instanceosmo_sccp_simple_server (void *ctx, uint32_t pc, enum osmo_ss7_asp_protocol prot, int local_port, const char *local_ip)
 
struct osmo_sccp_instanceosmo_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_instanceosmo_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_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)
 

Variables

struct llist_head osmo_ss7_instances
 
struct value_string osmo_ss7_asp_protocol_vals []
 
struct value_string osmo_ss7_as_traffic_mode_vals []
 
const struct value_string osmo_ss7_asp_role_names []
 

Macro Definition Documentation

◆ OSMO_SS7_ASP_QUIRK_DAUD_IN_ASP

#define OSMO_SS7_ASP_QUIRK_DAUD_IN_ASP   0x00000002

Accept DAUD in ASP role (RFC states only permitted in ASP->SG role)

◆ OSMO_SS7_ASP_QUIRK_NO_NOTIFY

#define OSMO_SS7_ASP_QUIRK_NO_NOTIFY   0x00000001

Peer SG doesn't send NTFY(AS-INACTIVE) after ASP-UP procedure.

◆ OSMO_SS7_ASP_QUIRK_SNM_INACTIVE

#define OSMO_SS7_ASP_QUIRK_SNM_INACTIVE   0x00000004

Accept SSNM even if ASP is in AS-INACTIVE state.

◆ OSMO_SS7_PC_INVALID

#define OSMO_SS7_PC_INVALID   0xffffffff

Typedef Documentation

◆ osmo_ss7_asp_rx_unknown_cb

typedef int osmo_ss7_asp_rx_unknown_cb(struct osmo_ss7_asp *asp, int ppid_mux, struct msgb *msg)

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.

Parameters
[in]aspApplication Server Process through which data was received
[in]ppid_sidSCTP PPID (in sigtran case) or IPA Stream ID
[in]msgMessage buffer containing received data. Continues to be owned by caller!
Returns
0 on success; negative on error

Enumeration Type Documentation

◆ osmo_ss7_as_traffic_mode

Enumerator
OSMO_SS7_AS_TMOD_OVERRIDE 
OSMO_SS7_AS_TMOD_BCAST 
OSMO_SS7_AS_TMOD_LOADSHARE 
OSMO_SS7_AS_TMOD_ROUNDROBIN 
_NUM_OSMO_SS7_ASP_TMOD 

◆ osmo_ss7_asp_admin_state

Enumerator
OSMO_SS7_ASP_ADM_S_SHUTDOWN 

no SCTP association with peer

OSMO_SS7_ASP_ADM_S_BLOCKED 

SCP association, but reject ASP-ACTIVE.

OSMO_SS7_ASP_ADM_S_ENABLED 

in normal operation

◆ osmo_ss7_asp_protocol

Enumerator
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 

◆ osmo_ss7_asp_role

Enumerator
OSMO_SS7_ASP_ROLE_ASP 
OSMO_SS7_ASP_ROLE_SG 
OSMO_SS7_ASP_ROLE_IPSP 

Function Documentation

◆ osmo_sccp_set_max_optional_data()

void osmo_sccp_set_max_optional_data ( struct osmo_sccp_instance inst,
int  val 
)

Adjust the upper bound for the optional data length (the payload) for CR, CC, CREF and RLSD messages.

For any Optional Data part larger than this value in octets, send CR, CC, CREF and RLSD messages without any payload, and send the data payload in a separate Data Form 1 message. ITU-T Q.713 sections 4.2 thru 4.5 define a limit of 130 bytes for the 'Data' parameter. This limit can be adjusted here. May be useful for interop with nonstandard SCCP peers.

Parameters
[in]sccpSCCP instance to reconfigure.
[in]valNumber of bytes to set as upper bound for the optional data length, or pass a negative value to set the standard value of SCCP_MAX_OPTIONAL_DATA == 130, which conforms to ITU-T Q.713.

References osmo_xua_server::inst.

Referenced by DEFUN_ATTR().

◆ osmo_sccp_simple_client()

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 
)

request an sccp client instance

Parameters
[in]ctxtalloc context
[in]namehuman readable name
[in]default_pcpointcode to be used on missing VTY setting
[in]protprotocol to be used (e.g OSMO_SS7_ASP_PROT_M3UA)
[in]default_local_portlocal port to be used on missing VTY setting
[in]default_local_iplocal IP-address to be used on missing VTY setting
[in]default_remote_portremote port to be used on missing VTY setting
[in]default_remote_ipremote IP-address to be used on missing VTY setting
Returns
callee-allocated SCCP instance on success; NULL on error

This is simplified version of osmo_sccp_simple_client_on_ss7_id(). the only difference is that the ID of the CS7 instance will be set to 0 statically

References osmo_sccp_simple_client_on_ss7_id().

◆ osmo_sccp_simple_client_on_ss7_id()

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 
)

request an sccp client instance

Parameters
[in]ctxtalloc context
[in]ss7_idof the SS7/CS7 instance
[in]namehuman readable name
[in]default_pcpointcode to be used on missing VTY setting
[in]protprotocol to be used (e.g OSMO_SS7_ASP_PROT_M3UA)
[in]default_local_portlocal port to be used on missing VTY setting
[in]default_local_iplocal IP-address to be used on missing VTY setting (NULL: use library own defaults)
[in]default_remote_portremote port to be used on missing VTY setting
[in]default_remote_ipremote IP-address to be used on missing VTY setting (NULL: use library own defaults)
Returns
callee-allocated SCCP instance on success; NULL on error

The function will examine the given CS7 instance and its sub components (as, asp, etc.). If necessary it will allocate the missing components. If no CS7 instance can be detected under the caller supplied ID, a new instance will be created beforehand.

References osmo_ss7_instance::as_list, osmo_ss7_instance::asp_list, osmo_ss7_as::cfg, osmo_ss7_asp::cfg, osmo_ss7_instance::cfg, osmo_ss7_instance::id, osmo_ss7_asp::is_server, osmo_ss7_as::list, osmo_ss7_asp::list, osmo_ss7_asp::local, osmo_ss7_as::name, osmo_ss7_asp::name, osmo_ss7_as_add_asp(), osmo_ss7_as_destroy(), osmo_ss7_as_find_by_proto(), osmo_ss7_as_find_or_create(), osmo_ss7_as_has_asp(), osmo_ss7_asp_destroy(), osmo_ss7_asp_find_by_proto(), osmo_ss7_asp_find_or_create2(), OSMO_SS7_ASP_PROT_IPA, osmo_ss7_asp_protocol_name(), osmo_ss7_asp_protocol_port(), osmo_ss7_asp_restart(), OSMO_SS7_ASP_ROLE_ASP, osmo_ss7_asp_use_default_lm(), osmo_ss7_ensure_sccp(), osmo_ss7_instance_destroy(), osmo_ss7_instance_find(), osmo_ss7_instance_find_or_create(), osmo_ss7_pc_is_valid(), osmo_ss7_pointcode_print(), osmo_ss7_routing_key::pc, osmo_ss7_asp_peer::port, osmo_ss7_instance::primary_pc, osmo_ss7_asp::proto, osmo_ss7_asp::remote, osmo_ss7_asp::role, osmo_ss7_asp::role_set_by_vty, osmo_ss7_as::routing_key, osmo_ss7_instance::rtable_system, osmo_ss7_instance::sccp, osmo_ss7_as::simple_client_allocated, osmo_ss7_asp::simple_client_allocated, ss7_asp_peer_set_hosts(), ss7_asp_set_default_peer_hosts(), ss7_default_trans_proto_for_asp_proto(), ss7_route_create(), ss7_route_destroy(), ss7_route_table_find_route_by_dpc_mask(), ss7_xua_server_find2(), osmo_ss7_asp::trans_proto, and osmo_ss7_asp::trans_role_set_by_vty.

Referenced by osmo_sccp_simple_client().

◆ osmo_sccp_simple_server()

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 
)

◆ osmo_sccp_simple_server_add_clnt()

◆ osmo_sccp_simple_server_on_ss7_id()

◆ osmo_ss7_as_active()

bool osmo_ss7_as_active ( const struct osmo_ss7_as as)

Determine if given AS is in the active state.

Parameters
[in]asApplication Server.
Returns
true in case as is active; false otherwise.

References osmo_ss7_as::fi, and XUA_AS_S_ACTIVE.

Referenced by DEFUN().

◆ osmo_ss7_as_add_asp()

int osmo_ss7_as_add_asp ( struct osmo_ss7_as as,
const char *  asp_name 
)

Add given ASP to given AS.

Parameters
[in]asApplication Server to which asp is added
[in]aspApplication Server Process to be added to as
Returns
0 on success; negative in case of error

References osmo_ss7_as::asps, osmo_ss7_as::cfg, osmo_ss7_asp::cfg, osmo_ss7_asp::fi, osmo_ss7_as::inst, LOGPAS, osmo_ss7_asp::name, osmo_ss7_as_has_asp(), osmo_ss7_asp_find_by_name(), ss7_initialized, and XUA_ASP_E_AS_ASSIGNED.

Referenced by DEFUN_ATTR(), handle_rkey_reg(), ipa_asp_fsm_wait_id_resp(), osmo_sccp_simple_client_on_ss7_id(), and osmo_sccp_simple_server_add_clnt().

◆ osmo_ss7_as_del_asp()

int osmo_ss7_as_del_asp ( struct osmo_ss7_as as,
const char *  asp_name 
)

Delete given ASP from given AS.

Parameters
[in]asApplication Server from which asp is deleted
[in]aspApplication Server Process to delete from as
Returns
0 on success; negative in case of error

References osmo_ss7_as::asps, osmo_ss7_as::cfg, osmo_ss7_asp::cfg, osmo_ss7_as::inst, LOGPAS, osmo_ss7_asp::name, osmo_ss7_asp_find_by_name(), and ss7_initialized.

Referenced by DEFUN_ATTR(), and handle_rkey_dereg().

◆ osmo_ss7_as_destroy()

◆ osmo_ss7_as_down()

bool osmo_ss7_as_down ( const struct osmo_ss7_as as)

Determine if given AS is in the down state.

Parameters
[in]asApplication Server.
Returns
true in case as is down; false otherwise.

References osmo_ss7_as::fi, and XUA_AS_S_DOWN.

Referenced by hmrt_message_for_routing().

◆ osmo_ss7_as_find_by_l_rk_id()

struct osmo_ss7_as * osmo_ss7_as_find_by_l_rk_id ( struct osmo_ss7_instance inst,
uint32_t  l_rk_id 
)

Find Application Server by given local routing key ID.

Parameters
[in]instSS7 Instance on which we operate
[in]l_rk_idLocal Routing Key ID
Returns
pointer to Application Server on success; NULL otherwise

References osmo_ss7_instance::as_list, osmo_ss7_as::cfg, osmo_ss7_as::inst, osmo_ss7_routing_key::l_rk_id, osmo_ss7_as::list, osmo_ss7_as::routing_key, and ss7_initialized.

Referenced by handle_reg_conf(), and ss7_find_free_l_rk_id().

◆ osmo_ss7_as_find_by_name()

struct osmo_ss7_as * osmo_ss7_as_find_by_name ( struct osmo_ss7_instance inst,
const char *  name 
)

Find Application Server by given name.

Parameters
[in]instSS7 Instance on which we operate
[in]nameName of AS
Returns
pointer to Application Server on success; NULL otherwise

References osmo_ss7_instance::as_list, osmo_ss7_as::cfg, osmo_ss7_as::inst, osmo_ss7_as::list, osmo_ss7_as::name, and ss7_initialized.

Referenced by DEFUN_ATTR(), ipa_asp_fsm_wait_id_resp(), osmo_ss7_as_find_or_create(), and ss7_route_set_linkset().

◆ osmo_ss7_as_find_by_proto()

struct osmo_ss7_as * osmo_ss7_as_find_by_proto ( struct osmo_ss7_instance inst,
enum osmo_ss7_asp_protocol  proto 
)

Find Application Server (AS) by given protocol.

Parameters
[in]instSS7 Instance on which we operate
[in]protoProtocol identifier that must match
Returns
pointer to AS on success; NULL otherwise If an AS has an ASP also matching the given protocol, that AS is preferred. If there are multiple matches, return the first matching AS.

References osmo_ss7_instance::as_list, osmo_ss7_as::cfg, osmo_ss7_as::inst, osmo_ss7_as::list, osmo_ss7_asp_find_by_proto(), osmo_ss7_as::proto, and ss7_initialized.

Referenced by osmo_sccp_simple_client_on_ss7_id().

◆ osmo_ss7_as_find_by_rctx()

struct osmo_ss7_as * osmo_ss7_as_find_by_rctx ( struct osmo_ss7_instance inst,
uint32_t  rctx 
)

Find Application Server by given routing context.

Parameters
[in]instSS7 Instance on which we operate
[in]rctxRouting Context
Returns
pointer to Application Server on success; NULL otherwise

References osmo_ss7_instance::as_list, osmo_ss7_as::cfg, osmo_ss7_routing_key::context, osmo_ss7_as::inst, osmo_ss7_as::list, osmo_ss7_as::routing_key, and ss7_initialized.

Referenced by handle_rkey_dereg(), handle_rkey_reg(), osmo_ss7_find_free_rctx(), xua_asp_fsm_inactive(), and xua_find_as_for_asp().

◆ osmo_ss7_as_find_or_create()

struct osmo_ss7_as * osmo_ss7_as_find_or_create ( struct osmo_ss7_instance inst,
const char *  name,
enum osmo_ss7_asp_protocol  proto 
)

Find or Create Application Server.

Parameters
[in]instSS7 Instance on which we operate
[in]nameName of Application Server
[in]protoProtocol of Application Server
Returns
pointer to Application Server on success; NULL otherwise

References osmo_ss7_as::cfg, osmo_ss7_as::inst, LOGPAS, osmo_ss7_as::name, osmo_ss7_as_find_by_name(), osmo_ss7_as::proto, ss7_as_alloc(), and ss7_initialized.

Referenced by DEFUN_ATTR(), handle_rkey_reg(), osmo_sccp_simple_client_on_ss7_id(), and osmo_sccp_simple_server_add_clnt().

◆ osmo_ss7_as_get_asp_protocol()

enum osmo_ss7_asp_protocol osmo_ss7_as_get_asp_protocol ( const struct osmo_ss7_as as)

Get asp_protocol configuration of a given AS.

Parameters
[in]asApplication Server in which to look for asp_protocol
Returns
The asp_protocol this AS is configured with

References osmo_ss7_as::cfg, and osmo_ss7_as::proto.

◆ osmo_ss7_as_has_asp()

bool osmo_ss7_as_has_asp ( const struct osmo_ss7_as as,
const struct osmo_ss7_asp asp 
)

Determine if given AS contains ASP.

Parameters
[in]asApplication Server in which to look for asp
[in]aspApplication Server Process to look for in as
Returns
true in case asp is part of as; false otherwise

References osmo_ss7_as::asps, osmo_ss7_as::cfg, and ss7_initialized.

Referenced by as_list_for_asp(), determine_traf_mode(), dispatch_to_all_as(), find_single_as_for_asp(), get_all_rctx_for_asp(), handle_rkey_dereg(), ipa_find_as_for_asp(), osmo_sccp_simple_client_on_ss7_id(), osmo_ss7_as_add_asp(), xua_asp_fsm_inactive(), xua_find_as_for_asp(), xua_msg_add_asp_rctx(), and xua_rkm_cleanup_dyn_as_for_asp().

◆ osmo_ss7_as_select_asp()

struct osmo_ss7_asp * osmo_ss7_as_select_asp ( struct osmo_ss7_as as)

Select an AS to transmit a message, according to AS configuration and ASP availability.

Parameters
[in]asApplication Server.
Returns
asp to send the message to, NULL if no possible asp found

This function returns NULL too if multiple ASPs would be selected, ie. AS is configured in broadcast mode and more than one ASP is configured.

References _NUM_OSMO_SS7_ASP_TMOD, osmo_ss7_as::cfg, osmo_ss7_as::fi, osmo_ss7_as::mode, OSMO_SS7_AS_TMOD_BCAST, OSMO_SS7_AS_TMOD_LOADSHARE, OSMO_SS7_AS_TMOD_OVERRIDE, OSMO_SS7_AS_TMOD_ROUNDROBIN, ss7_as_select_asp_broadcast(), ss7_as_select_asp_override(), and ss7_as_select_asp_roundrobin().

Referenced by xua_as_transmit_msg().

◆ osmo_ss7_as_tmode_compatible_xua()

◆ osmo_ss7_as_traffic_mode_name()

static const char * osmo_ss7_as_traffic_mode_name ( enum osmo_ss7_as_traffic_mode  mode)
inlinestatic

◆ osmo_ss7_asp_active()

◆ osmo_ss7_asp_destroy()

◆ osmo_ss7_asp_disconnect()

◆ osmo_ss7_asp_find()

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_ss7_asp_find2()

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 
)

◆ osmo_ss7_asp_find_by_name()

◆ osmo_ss7_asp_find_by_proto()

struct osmo_ss7_asp * osmo_ss7_asp_find_by_proto ( struct osmo_ss7_as as,
enum osmo_ss7_asp_protocol  proto 
)

Find an ASP that matches the given ASP protocol (xUA variant).

Parameters
[in]asApplication Server in which to look for asp
[in]protoASP protocol (xUA variant) to match
Returns
SS7 ASP in case a matching one is found; NULL otherwise

References osmo_ss7_as::asps, osmo_ss7_as::cfg, osmo_ss7_asp::cfg, and osmo_ss7_asp::proto.

Referenced by osmo_sccp_simple_client_on_ss7_id(), and osmo_ss7_as_find_by_proto().

◆ osmo_ss7_asp_find_or_create()

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_ss7_asp_find_or_create2()

◆ osmo_ss7_asp_get_log_subsys()

int osmo_ss7_asp_get_log_subsys ( const struct osmo_ss7_asp asp)

◆ osmo_ss7_asp_get_name()

const char * osmo_ss7_asp_get_name ( const struct osmo_ss7_asp asp)

Get the name of a given ASP.

Parameters
[in]aspThe ASP for which the name is requested
Returns
The name of the ASP, or NULL if not set

References osmo_ss7_asp::cfg, and osmo_ss7_asp::name.

◆ osmo_ss7_asp_get_proto()

enum osmo_ss7_asp_protocol osmo_ss7_asp_get_proto ( const struct osmo_ss7_asp asp)

Get the proto of a given ASP.

Parameters
[in]aspThe ASP for which the proto is requested
Returns
The proto of the ASP

References osmo_ss7_asp::cfg, and osmo_ss7_asp::proto.

◆ osmo_ss7_asp_get_trans_proto()

int osmo_ss7_asp_get_trans_proto ( const struct osmo_ss7_asp asp)

Get the transport proto of a given ASP.

Parameters
[in]aspThe ASP for which the transport proto is requested
Returns
The transport proto of the ASP (one of IPPROTO_*)

References osmo_ss7_asp::cfg, and osmo_ss7_asp::trans_proto.

◆ osmo_ss7_asp_protocol_name()

static const char * osmo_ss7_asp_protocol_name ( enum osmo_ss7_asp_protocol  mode)
inlinestatic

◆ osmo_ss7_asp_protocol_port()

◆ osmo_ss7_asp_restart()

◆ osmo_ss7_asp_send()

int osmo_ss7_asp_send ( struct osmo_ss7_asp asp,
struct msgb *  msg 
)

◆ osmo_ss7_asp_use_default_lm()

◆ osmo_ss7_ensure_sccp()

struct osmo_sccp_instance * osmo_ss7_ensure_sccp ( struct osmo_ss7_instance inst)

◆ osmo_ss7_find_free_rctx()

int osmo_ss7_find_free_rctx ( struct osmo_ss7_instance inst)

References next_rctx, and osmo_ss7_as_find_by_rctx().

Referenced by handle_rkey_reg().

◆ osmo_ss7_get_sccp()

struct osmo_sccp_instance * osmo_ss7_get_sccp ( const struct osmo_ss7_instance inst)

Get the SCCP instance, if present.

Parameters
[in]instSS7 Instance on which we operate
Returns
inst->sccp, may be NULL if no SCCP instance was created yet (see osmo_ss7_ensure_sccp()).

References osmo_ss7_instance::sccp.

◆ osmo_ss7_init()

int osmo_ss7_init ( void  )

◆ osmo_ss7_instance_destroy()

◆ osmo_ss7_instance_find()

struct osmo_ss7_instance * osmo_ss7_instance_find ( uint32_t  id)

Find a SS7 Instance with given ID.

Parameters
[in]idID for which to search
Returns
osmo_ss7_instance on success; NULL on error

References osmo_ss7_instance::cfg, osmo_ss7_instance::id, osmo_ss7_instance::list, osmo_ss7_instances, and ss7_initialized.

Referenced by DEFUN(), osmo_sccp_simple_client_on_ss7_id(), osmo_ss7_instance_find_or_create(), show_asp(), show_asp_assoc_status(), and show_asp_remaddr().

◆ osmo_ss7_instance_find_or_create()

struct osmo_ss7_instance * osmo_ss7_instance_find_or_create ( void *  ctx,
uint32_t  id 
)

Find or create a SS7 Instance.

Parameters
[in]ctxtalloc allocation context to use for allocations
[in]idID of SS7 Instance
Returns
osmo_ss7_instance on success; NULL on error

References osmo_ss7_instance_find(), ss7_initialized, and ss7_instance_alloc().

Referenced by DEFUN_ATTR(), osmo_sccp_simple_client_on_ss7_id(), and osmo_sccp_simple_server_on_ss7_id().

◆ osmo_ss7_instance_get_id()

uint32_t osmo_ss7_instance_get_id ( const struct osmo_ss7_instance inst)

◆ osmo_ss7_instance_get_name()

const char * osmo_ss7_instance_get_name ( const struct osmo_ss7_instance inst)

◆ osmo_ss7_instance_get_pc_fmt()

const struct osmo_ss7_pc_fmt * osmo_ss7_instance_get_pc_fmt ( const struct osmo_ss7_instance inst)

◆ osmo_ss7_instance_get_primary_pc()

uint32_t osmo_ss7_instance_get_primary_pc ( const struct osmo_ss7_instance inst)

◆ osmo_ss7_instance_set_pc_fmt()

int osmo_ss7_instance_set_pc_fmt ( struct osmo_ss7_instance inst,
uint8_t  c0,
uint8_t  c1,
uint8_t  c2 
)

Set the point code format used in given SS7 instance.

References osmo_ss7_instance::cfg, osmo_ss7_pc_fmt::component_len, osmo_ss7_asp::inst, LOGSS7, and osmo_ss7_instance::pc_fmt.

◆ osmo_ss7_instances_llist_entry()

struct osmo_ss7_instance * osmo_ss7_instances_llist_entry ( struct llist_head *  list)

◆ osmo_ss7_is_config_node()

int osmo_ss7_is_config_node ( struct vty *  vty,
int  node 
)

◆ osmo_ss7_pc_is_local()

◆ osmo_ss7_pc_is_valid()

◆ osmo_ss7_pc_normalize()

uint32_t osmo_ss7_pc_normalize ( const struct osmo_ss7_pc_fmt pc_fmt,
uint32_t  pc 
)

◆ osmo_ss7_pc_width()

◆ osmo_ss7_pointcode_parse()

◆ osmo_ss7_pointcode_parse_mask_or_len()

int osmo_ss7_pointcode_parse_mask_or_len ( const struct osmo_ss7_instance inst,
const char *  in 
)

◆ osmo_ss7_pointcode_print()

◆ osmo_ss7_pointcode_print2()

const char * osmo_ss7_pointcode_print2 ( const struct osmo_ss7_instance inst,
uint32_t  pc 
)

◆ osmo_ss7_pointcode_print_buf()

const char * osmo_ss7_pointcode_print_buf ( char *  buf,
size_t  buf_len,
const struct osmo_ss7_instance inst,
uint32_t  pc 
)

◆ osmo_ss7_register_rx_unknown_cb()

void osmo_ss7_register_rx_unknown_cb ( osmo_ss7_asp_rx_unknown_cb cb)

Register a call-back function for unknown SCTP PPID / IPA Stream ID.

References g_osmo_ss7_asp_rx_unknown_cb.

◆ osmo_ss7_route_get_dest_as()

struct osmo_ss7_as * osmo_ss7_route_get_dest_as ( struct osmo_ss7_route rt)

Get destination AS of route.

Parameters
[in]rtRoute entry holding the AS destination
Returns
pointer to Application Server on success; NULL if rt doesn't route to an AS (i.e. routes to a linkset).

References osmo_ss7_route::as, and osmo_ss7_route::dest.

◆ osmo_ss7_route_lookup()

struct osmo_ss7_route * osmo_ss7_route_lookup ( struct osmo_ss7_instance inst,
uint32_t  dpc 
)

Find a SS7 route for given destination point code in given SS7.

References dpc, osmo_ss7_instance::rtable_system, ss7_initialized, and ss7_route_table_find_route_by_dpc().

Referenced by gen_mtp_transfer_req_xua(), hmrt_message_for_routing(), and xua_snm_rx_daud().

◆ osmo_ss7_route_name()

const char * osmo_ss7_route_name ( struct osmo_ss7_route rt,
bool  list_asps 
)

Return human readable representation of the route, in a static buffer.

This uses both osmo_ss7_pointcode_print() and osmo_ss7_pointcode_print2(), so pairing osmo_ss7_route_name() with osmo_ss7_pointcode_print() in the same printf statement is likely to conflict.

Parameters
[in]rtThe route information to print, or NULL.
[in]list_aspsIf true, append info for all ASPs for the route's AS.
Returns
A string constant or static buffer.

References APPEND, osmo_ss7_route::as, osmo_ss7_as::asps, osmo_ss7_as::cfg, osmo_ss7_asp::cfg, osmo_ss7_linkset::cfg, osmo_ss7_route::cfg, osmo_ss7_route::dest, osmo_ss7_route_table::inst, osmo_ss7_route::linkset, osmo_ss7_route::mask, osmo_ss7_as::name, osmo_ss7_asp::name, osmo_ss7_linkset::name, osmo_ss7_asp_protocol_name(), osmo_ss7_pointcode_print(), osmo_ss7_pointcode_print2(), osmo_ss7_route::pc, osmo_ss7_as::proto, osmo_ss7_route::rtable, and osmo_ss7_asp::sock_name.

Referenced by hmrt_message_for_routing().

◆ osmo_ss7_route_print()

◆ osmo_ss7_tmode_from_xua()

◆ osmo_ss7_tmode_to_xua()

◆ osmo_ss7_user_create()

struct osmo_ss7_user * osmo_ss7_user_create ( struct osmo_ss7_instance inst,
const char *  name 
)

◆ osmo_ss7_user_destroy()

void osmo_ss7_user_destroy ( struct osmo_ss7_user user)

◆ osmo_ss7_user_get_instance()

struct osmo_ss7_instance * osmo_ss7_user_get_instance ( const struct osmo_ss7_user user)

◆ osmo_ss7_user_get_priv()

void * osmo_ss7_user_get_priv ( const struct osmo_ss7_user user)

◆ osmo_ss7_user_mtp_xfer_req()

◆ osmo_ss7_user_register()

int osmo_ss7_user_register ( struct osmo_ss7_instance inst,
uint8_t  service_ind,
struct osmo_ss7_user user 
)

Register a MTP user for a given service indicator.

Parameters
[in]instSS7 instance for which we register the user
[in]service_indService (ISUP, SCCP, ...)
[in]userSS7 user (including primitive call-back)
Returns
0 on success; negative on error

References osmo_ss7_user::inst, osmo_ss7_user::name, osmo_ss7_user::priv, and osmo_ss7_instance::user.

Referenced by osmo_sccp_instance_create().

◆ osmo_ss7_user_set_prim_cb()

void osmo_ss7_user_set_prim_cb ( struct osmo_ss7_user user,
osmo_prim_cb  prim_cb 
)

◆ osmo_ss7_user_set_priv()

void osmo_ss7_user_set_priv ( struct osmo_ss7_user user,
void *  priv 
)

◆ osmo_ss7_user_unregister()

int osmo_ss7_user_unregister ( struct osmo_ss7_instance inst,
uint8_t  service_ind,
struct osmo_ss7_user user 
)

Unregister a MTP user for a given service indicator.

Parameters
[in]instSS7 instance for which we register the user
[in]service_indService (ISUP, SCCP, ...)
[in]user(optional) SS7 user. If present, we will not unregister other users
Returns
0 on success; negative on error

References osmo_ss7_user::inst, and osmo_ss7_instance::user.

Referenced by osmo_sccp_instance_destroy().

◆ osmo_ss7_vty_go_parent()

◆ osmo_ss7_vty_init_asp()

void osmo_ss7_vty_init_asp ( void *  ctx)

◆ osmo_ss7_vty_init_sg()

void osmo_ss7_vty_init_sg ( void *  ctx)

Variable Documentation

◆ osmo_ss7_as_traffic_mode_vals

struct value_string osmo_ss7_as_traffic_mode_vals[]
extern

◆ osmo_ss7_asp_protocol_vals

◆ osmo_ss7_asp_role_names

const struct value_string osmo_ss7_asp_role_names[]
extern

Referenced by show_one_asp(), and write_one_asp().

◆ osmo_ss7_instances

struct llist_head osmo_ss7_instances
extern