/* * (C) 2012-2013 by Pablo Neira Ayuso * (C) 2012-2013 by On Waves ehf * All rights not specifically granted under this license are reserved. * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU Affero General Public License as published by the * Free Software Foundation; either version 3 of the License, or (at your * option) any later version. */ #include /* for printf */ #include /* for memcpy */ #include /* for abs */ #include /* for PRIu64 */ #include #include #include #include #include #include #include #include #include #include #include #include #include static struct osmo_fd osmux_fd; static LLIST_HEAD(osmux_handle_list); struct osmux_handle { struct llist_head head; struct osmux_in_handle *in; struct in_addr rem_addr; int rem_port; /* network byte order */ int refcnt; }; static void *osmux; /* Deliver OSMUX batch to the remote end */ static void osmux_deliver_cb(struct msgb *batch_msg, void *data) { struct osmux_handle *handle = data; struct sockaddr_in out = { .sin_family = AF_INET, .sin_port = handle->rem_port, }; memcpy(&out.sin_addr, &handle->rem_addr, sizeof(handle->rem_addr)); sendto(osmux_fd.fd, batch_msg->data, batch_msg->len, 0, (struct sockaddr *)&out, sizeof(out)); msgb_free(batch_msg); } /* Lookup existing OSMUX handle for specified destination address. */ static struct osmux_handle * osmux_handle_find_get(struct in_addr *addr, int rem_port) { struct osmux_handle *h; llist_for_each_entry(h, &osmux_handle_list, head) { if (memcmp(&h->rem_addr, addr, sizeof(struct in_addr)) == 0 && h->rem_port == rem_port) { LOGP(DLMGCP, LOGL_DEBUG, "using existing OSMUX handle " "for addr=%s:%d\n", inet_ntoa(*addr), ntohs(rem_port)); h->refcnt++; return h; } } return NULL; } /* Put down no longer needed OSMUX handle */ static void osmux_handle_put(struct osmux_in_handle *in) { struct osmux_handle *h; llist_for_each_entry(h, &osmux_handle_list, head) { if (h->in == in) { if (--h->refcnt == 0) { LOGP(DLMGCP, LOGL_INFO, "Releasing unused osmux handle for %s:%d\n", inet_ntoa(h->rem_addr), ntohs(h->rem_port)); LOGP(DLMGCP, LOGL_INFO, "Stats: " "input RTP msgs: %u bytes: %"PRIu64" " "output osmux msgs: %u bytes: %"PRIu64"\n", in->stats.input_rtp_msgs, in->stats.input_rtp_bytes, in->stats.output_osmux_msgs, in->stats.output_osmux_bytes); llist_del(&h->head); osmux_xfrm_input_fini(h->in); talloc_free(h); } return; } } LOGP(DLMGCP, LOGL_ERROR, "cannot find Osmux input handle %p\n", in); } /* Allocate free OSMUX handle */ static struct osmux_handle * osmux_handle_alloc(struct mgcp_config *cfg, struct in_addr *addr, int rem_port) { struct osmux_handle *h; h = talloc_zero(osmux, struct osmux_handle); if (!h) return NULL; h->rem_addr = *addr; h->rem_port = rem_port; h->refcnt++; h->in = talloc_zero(h, struct osmux_in_handle); if (!h->in) { talloc_free(h); return NULL; } /* sequence number to start OSMUX message from */ h->in->osmux_seq = 0; h->in->batch_factor = cfg->osmux_batch; /* If batch size is zero, the library defaults to 1470 bytes. */ h->in->batch_size = cfg->osmux_batch_size; h->in->deliver = osmux_deliver_cb; osmux_xfrm_input_init(h->in); h->in->data = h; llist_add(&h->head, &osmux_handle_list); LOGP(DLMGCP, LOGL_DEBUG, "created new OSMUX handle for addr=%s:%d\n", inet_ntoa(*addr), ntohs(rem_port)); return h; } /* Lookup existing handle for a specified address, if the handle can not be * found, the function will automatically allocate one */ static struct osmux_in_handle * osmux_handle_lookup(struct mgcp_config *cfg, struct osmo_sockaddr *addr, int rem_port) { struct osmux_handle *h; if (addr->u.sa.sa_family != AF_INET) { LOGP(DLMGCP, LOGL_DEBUG, "IPv6 not supported in osmux yet!\n"); return NULL; } h = osmux_handle_find_get(&addr->u.sin.sin_addr, rem_port); if (h != NULL) return h->in; h = osmux_handle_alloc(cfg, &addr->u.sin.sin_addr, rem_port); if (h == NULL) return NULL; return h->in; } /*! send RTP packet through OSMUX connection. * \param[in] buf rtp data * \param[in] buf_len length of rtp data * \param[in] conn associated RTP connection * \returns 0 on success, -1 on ERROR */ int osmux_xfrm_to_osmux(char *buf, int buf_len, struct mgcp_conn_rtp *conn) { int ret; struct msgb *msg; msg = msgb_alloc(4096, "RTP"); if (!msg) return -1; memcpy(msg->data, buf, buf_len); msgb_put(msg, buf_len); if (conn->osmux.state != OSMUX_STATE_ENABLED) { LOGPCONN(conn->conn, DLMGCP, LOGL_INFO, "forwarding RTP to Osmux conn not yet enabled, dropping (cid=%d)\n", conn->osmux.cid); return -1; } while ((ret = osmux_xfrm_input(conn->osmux.in, msg, conn->osmux.cid)) > 0) { /* batch full, build and deliver it */ osmux_xfrm_input_deliver(conn->osmux.in); } return 0; } /* Lookup the endpoint that corresponds to the specified address (port) */ static struct mgcp_conn_rtp* osmux_conn_lookup(struct mgcp_config *cfg, uint8_t cid, struct in_addr *from_addr) { struct mgcp_trunk *trunk = mgcp_trunk_by_num(cfg, MGCP_TRUNK_VIRTUAL, MGCP_VIRT_TRUNK_ID); struct mgcp_endpoint *endp; struct mgcp_conn *conn = NULL; struct mgcp_conn_rtp * conn_rtp; int i; for (i = 0; i < trunk->number_endpoints; i++) { endp = trunk->endpoints[i]; llist_for_each_entry(conn, &endp->conns, entry) { if (conn->type != MGCP_CONN_TYPE_RTP) continue; conn_rtp = &conn->u.rtp; if (!mgcp_conn_rtp_is_osmux(conn_rtp)) continue; if (conn_rtp->osmux.cid == cid) return conn_rtp; } } LOGP(DLMGCP, LOGL_ERROR, "Cannot find osmux conn with cid=%d\n", cid); return NULL; } /* FIXME: this is declared and used in mgcp_network.c, but documentation of mgcp_dispatch_rtp_bridge_cb() states another enum is to be used */ enum { MGCP_PROTO_RTP, MGCP_PROTO_RTCP, }; static void scheduled_from_osmux_tx_rtp_cb(struct msgb *msg, void *data) { struct mgcp_conn_rtp *conn = data; struct mgcp_endpoint *endp = conn->conn->endp; struct osmo_sockaddr addr = { /* FIXME: do we know the source address?? */ }; struct osmo_rtp_msg_ctx *mc = OSMO_RTP_MSG_CTX(msg); *mc = (struct osmo_rtp_msg_ctx){ .proto = MGCP_PROTO_RTP, .conn_src = conn, .from_addr = &addr, }; endp->type->dispatch_rtp_cb(msg); msgb_free(msg); } static struct msgb *osmux_recv(struct osmo_fd *ofd, struct sockaddr_in *addr) { struct msgb *msg; socklen_t slen = sizeof(*addr); int ret; msg = msgb_alloc(4096, "OSMUX"); if (!msg) { LOGP(DLMGCP, LOGL_ERROR, "cannot allocate message\n"); return NULL; } ret = recvfrom(ofd->fd, msg->data, msg->data_len, 0, (struct sockaddr *)addr, &slen); if (ret <= 0) { msgb_free(msg); LOGP(DLMGCP, LOGL_ERROR, "cannot receive message\n"); return NULL; } msgb_put(msg, ret); return msg; } /* Updates endp osmux state and returns 0 if it can process messages, -1 otherwise */ static int endp_osmux_state_check(struct mgcp_endpoint *endp, struct mgcp_conn_rtp *conn, bool sending) { char ipbuf[INET6_ADDRSTRLEN]; switch(conn->osmux.state) { case OSMUX_STATE_ACTIVATING: if (osmux_enable_conn(endp, conn, &conn->end.addr, conn->end.rtp_port) < 0) { LOGPCONN(conn->conn, DLMGCP, LOGL_ERROR, "Could not enable osmux for conn on %s: %s\n", sending ? "sent" : "received", mgcp_conn_dump(conn->conn)); return -1; } LOGPCONN(conn->conn, DLMGCP, LOGL_ERROR, "Osmux %s CID %u towards %s:%u is now enabled\n", sending ? "sent" : "received", conn->osmux.cid, osmo_sockaddr_ntop(&conn->end.addr.u.sa, ipbuf), ntohs(conn->end.rtp_port)); return 0; case OSMUX_STATE_ENABLED: return 0; default: LOGPCONN(conn->conn, DLMGCP, LOGL_ERROR, "Osmux %s in conn %s without full negotiation, state %d\n", sending ? "sent" : "received", mgcp_conn_dump(conn->conn), conn->osmux.state); return -1; } } static int osmux_legacy_dummy_parse_cid(struct sockaddr_in *addr, struct msgb *msg, uint8_t *osmux_cid) { if (msg->len < 1 + sizeof(*osmux_cid)) { LOGP(DLMGCP, LOGL_ERROR, "Discarding truncated Osmux dummy load: %s\n", osmo_hexdump(msg->data, msg->len)); return -1; } /* extract the osmux CID from the dummy message */ memcpy(osmux_cid, &msg->data[1], sizeof(*osmux_cid)); return 0; } /* This is called from the bsc-nat */ static int osmux_handle_dummy(struct mgcp_config *cfg, struct sockaddr_in *addr, struct msgb *msg) { uint8_t osmux_cid; struct mgcp_conn_rtp *conn; if (osmux_legacy_dummy_parse_cid(addr, msg, &osmux_cid) < 0) goto out; conn = osmux_conn_lookup(cfg, osmux_cid, &addr->sin_addr); if (!conn) { LOGP(DLMGCP, LOGL_ERROR, "Cannot find conn for Osmux CID %d\n", osmux_cid); goto out; } endp_osmux_state_check(conn->conn->endp, conn, false); /* Only needed to punch hole in firewall, it can be dropped */ out: msgb_free(msg); return 0; } #define osmux_chunk_length(msg, rem) (rem - msg->len); static int osmux_read_fd_cb(struct osmo_fd *ofd, unsigned int what) { struct msgb *msg; struct osmux_hdr *osmuxh; struct sockaddr_in addr; struct mgcp_config *cfg = ofd->data; uint32_t rem; struct mgcp_conn_rtp *conn_src; msg = osmux_recv(ofd, &addr); if (!msg) return -1; if (!cfg->osmux) { LOGP(DLMGCP, LOGL_ERROR, "bsc-nat wants to use Osmux but bsc did not request it\n"); goto out; } /* not any further processing dummy messages */ if (msg->data[0] == MGCP_DUMMY_LOAD) return osmux_handle_dummy(cfg, &addr, msg); rem = msg->len; while((osmuxh = osmux_xfrm_output_pull(msg)) != NULL) { conn_src = osmux_conn_lookup(cfg, osmuxh->circuit_id, &addr.sin_addr); if (!conn_src) { LOGP(DLMGCP, LOGL_ERROR, "Cannot find a src conn for circuit_id=%d\n", osmuxh->circuit_id); goto out; } /*conn_dst = mgcp_find_dst_conn(conn_src->conn); if (!conn_dst) { LOGP(DLMGCP, LOGL_ERROR, "Cannot find a dst conn for circuit_id=%d\n", osmuxh->circuit_id); goto out; }*/ if (endp_osmux_state_check(conn_src->conn->endp, conn_src, false) == 0) { conn_src->osmux.stats.octets += osmux_chunk_length(msg, rem); conn_src->osmux.stats.chunks++; osmux_xfrm_output_sched(&conn_src->osmux.out, osmuxh); } rem = msg->len; } out: msgb_free(msg); return 0; } int osmux_init(int role, struct mgcp_config *cfg) { int ret; osmux_fd.cb = osmux_read_fd_cb; osmux_fd.data = cfg; ret = mgcp_create_bind(cfg->osmux_addr, &osmux_fd, cfg->osmux_port); if (ret < 0) { LOGP(DLMGCP, LOGL_ERROR, "cannot bind OSMUX socket to %s:%u\n", cfg->osmux_addr, cfg->osmux_port); return ret; } mgcp_set_ip_tos(osmux_fd.fd, cfg->endp_dscp); osmux_fd.when |= OSMO_FD_READ; ret = osmo_fd_register(&osmux_fd); if (ret < 0) { LOGP(DLMGCP, LOGL_ERROR, "cannot register OSMUX socket %s\n", osmo_sock_get_name2(osmux_fd.fd)); return ret; } cfg->osmux_init = 1; LOGP(DLMGCP, LOGL_INFO, "OSMUX socket listening on %s\n", osmo_sock_get_name2(osmux_fd.fd)); return 0; } /*! enable OSXMUX circuit for a specified connection. * \param[in] endp mgcp endpoint (configuration) * \param[in] conn connection to disable * \param[in] addr IP address of remote OSMUX endpoint * \param[in] port portnumber of the remote OSMUX endpoint (in network byte order) * \returns 0 on success, -1 on ERROR */ int osmux_enable_conn(struct mgcp_endpoint *endp, struct mgcp_conn_rtp *conn, struct osmo_sockaddr *addr, uint16_t port) { /*! If osmux is enabled, initialize the output handler. This handler is * used to reconstruct the RTP flow from osmux. The RTP SSRC is * allocated based on the circuit ID (conn_net->osmux.cid), which is unique * in the local scope to the BSC/BSC-NAT. We use it to divide the RTP * SSRC space (2^32) by the OSMUX_CID_MAX + 1 possible circuit IDs, then randomly * select one value from that window. Thus, we have no chance to have * overlapping RTP SSRC traveling to the BTSes behind the BSC, * similarly, for flows traveling to the MSC. */ struct in6_addr addr_unset = {}; static const uint32_t rtp_ssrc_winlen = UINT32_MAX / (OSMUX_CID_MAX + 1); uint16_t osmux_dummy = endp->cfg->osmux_dummy; /* Check if osmux is enabled for the specified connection */ if (conn->osmux.state != OSMUX_STATE_ACTIVATING) { LOGPCONN(conn->conn, DLMGCP, LOGL_ERROR, "conn:%s didn't negotiate Osmux, state %d\n", mgcp_conn_dump(conn->conn), conn->osmux.state); return -1; } /* Wait until we have the connection information from MDCX */ if (memcmp(&conn->end.addr, &addr_unset, conn->end.addr.u.sa.sa_family == AF_INET6 ? sizeof(struct in6_addr) : sizeof(struct in_addr)) == 0) { LOGPCONN(conn->conn, DLMGCP, LOGL_INFO, "Osmux remote address/port still unknown\n"); return -1; } conn->osmux.in = osmux_handle_lookup(endp->cfg, addr, port); if (!conn->osmux.in) { LOGPCONN(conn->conn, DLMGCP, LOGL_ERROR, "Cannot allocate input osmux handle for conn:%s\n", mgcp_conn_dump(conn->conn)); return -1; } if (osmux_xfrm_input_open_circuit(conn->osmux.in, conn->osmux.cid, osmux_dummy) < 0) { LOGPCONN(conn->conn, DLMGCP, LOGL_ERROR, "Cannot open osmux circuit %u for conn:%s\n", conn->osmux.cid, mgcp_conn_dump(conn->conn)); return -1; } osmux_xfrm_output_init2(&conn->osmux.out, (conn->osmux.cid * rtp_ssrc_winlen) + (random() % rtp_ssrc_winlen), conn->end.codec->payload_type); osmux_xfrm_output_set_tx_cb(&conn->osmux.out, scheduled_from_osmux_tx_rtp_cb, conn); conn->osmux.state = OSMUX_STATE_ENABLED; return 0; } /*! disable OSXMUX circuit for a specified connection. * \param[in] conn connection to disable */ void conn_osmux_disable(struct mgcp_conn_rtp *conn) { OSMO_ASSERT(conn->osmux.state != OSMUX_STATE_DISABLED); LOGPCONN(conn->conn, DLMGCP, LOGL_INFO, "Releasing connection using Osmux CID %u\n", conn->osmux.cid); if (conn->osmux.state == OSMUX_STATE_ENABLED) { /* We are closing, we don't need pending RTP packets to be transmitted */ osmux_xfrm_output_set_tx_cb(&conn->osmux.out, NULL, NULL); osmux_xfrm_output_flush(&conn->osmux.out); osmux_xfrm_input_close_circuit(conn->osmux.in, conn->osmux.cid); conn->osmux.state = OSMUX_STATE_DISABLED; conn_osmux_release_cid(conn); osmux_handle_put(conn->osmux.in); } conn_osmux_release_cid(conn); } /*! relase OSXMUX cid, that had been allocated to this connection. * \param[in] conn connection with OSMUX cid to release */ void conn_osmux_release_cid(struct mgcp_conn_rtp *conn) { if (conn->osmux.cid_allocated) osmux_cid_pool_put(conn->osmux.cid); conn->osmux.cid = 0; conn->osmux.cid_allocated = false; } /*! allocate OSXMUX cid to connection. * \param[in] conn connection for which we allocate the OSMUX cid * \param[in] osmux_cid OSMUX cid to allocate. -1 Means take next available one. * \returns Allocated OSMUX cid, -1 on error (no free cids avail, or selected one is already taken). */ int conn_osmux_allocate_cid(struct mgcp_conn_rtp *conn, int osmux_cid) { if (osmux_cid != -1 && osmux_cid_pool_allocated((uint8_t) osmux_cid)) { LOGPCONN(conn->conn, DLMGCP, LOGL_INFO, "Osmux CID %d already allocated!\n", osmux_cid); return -1; } if (osmux_cid == -1) { osmux_cid = osmux_cid_pool_get_next(); if (osmux_cid == -1) { LOGPCONN(conn->conn, DLMGCP, LOGL_INFO, "no available Osmux CID to allocate!\n"); return -1; } } else osmux_cid_pool_get(osmux_cid); conn->osmux.cid = (uint8_t) osmux_cid; conn->osmux.cid_allocated = true; conn->type = MGCP_OSMUX_BSC; return osmux_cid; } /*! send RTP dummy packet to OSMUX connection port. * \param[in] endp mcgp endpoint that holds the RTP connection * \param[in] conn associated RTP connection * \returns bytes sent, -1 on error */ int osmux_send_dummy(struct mgcp_endpoint *endp, struct mgcp_conn_rtp *conn) { char ipbuf[INET6_ADDRSTRLEN]; struct osmux_hdr *osmuxh; int buf_len; struct in_addr addr_unset = {}; /*! The dummy packet will not be sent via the actual OSMUX connection, * instead it is sent out of band to port where the remote OSMUX * multplexer is listening. The goal is to ensure that the connection * is kept open */ /*! We don't need to send the dummy load for osmux so often as another * endpoint may have already punched the hole in the firewall. This * approach is simple though. */ /* Wait until we have the connection information from MDCX */ if (memcmp(&conn->end.addr, &addr_unset, sizeof(addr_unset)) == 0) return 0; if (endp_osmux_state_check(endp, conn, true) < 0) return 0; buf_len = sizeof(struct osmux_hdr) + osmo_amr_bytes(AMR_FT_0); osmuxh = (struct osmux_hdr *) alloca(buf_len); memset(osmuxh, 0, buf_len); osmuxh->ft = OSMUX_FT_DUMMY; osmuxh->amr_ft = AMR_FT_0; osmuxh->circuit_id = conn->osmux.cid; LOGPCONN(conn->conn, DLMGCP, LOGL_DEBUG, "sending OSMUX dummy load to %s:%u CID %u\n", osmo_sockaddr_ntop(&conn->end.addr.u.sa, ipbuf), ntohs(conn->end.rtp_port), conn->osmux.cid); return mgcp_udp_send(osmux_fd.fd, &conn->end.addr, conn->end.rtp_port, (char*)osmuxh, buf_len); } /* bsc-nat allocates/releases the Osmux circuit ID. +7 to round up to 8 bit boundary. */ static uint8_t osmux_cid_bitmap[(OSMUX_CID_MAX + 1 + 7) / 8]; /*! count the number of taken OSMUX cids. * \returns number of OSMUX cids in use */ int osmux_cid_pool_count_used(void) { int i, j, used = 0; for (i = 0; i < sizeof(osmux_cid_bitmap); i++) { for (j = 0; j < 8; j++) { if (osmux_cid_bitmap[i] & (1 << j)) used += 1; } } return used; } /*! take a free OSMUX cid. * \returns OSMUX cid */ int osmux_cid_pool_get_next(void) { int i, j; for (i = 0; i < sizeof(osmux_cid_bitmap); i++) { for (j = 0; j < 8; j++) { if (osmux_cid_bitmap[i] & (1 << j)) continue; osmux_cid_bitmap[i] |= (1 << j); LOGP(DLMGCP, LOGL_DEBUG, "Allocating Osmux CID %u from pool\n", (i * 8) + j); return (i * 8) + j; } } LOGP(DLMGCP, LOGL_ERROR, "All Osmux circuits are in use!\n"); return -1; } /*! take a specific OSMUX cid. * \param[in] osmux_cid OSMUX cid */ void osmux_cid_pool_get(uint8_t osmux_cid) { LOGP(DLMGCP, LOGL_DEBUG, "Allocating Osmux CID %u from pool\n", osmux_cid); osmux_cid_bitmap[osmux_cid / 8] |= (1 << (osmux_cid % 8)); } /*! put back a no longer used OSMUX cid. * \param[in] osmux_cid OSMUX cid */ void osmux_cid_pool_put(uint8_t osmux_cid) { LOGP(DLMGCP, LOGL_DEBUG, "Osmux CID %u is back to the pool\n", osmux_cid); osmux_cid_bitmap[osmux_cid / 8] &= ~(1 << (osmux_cid % 8)); } /*! check if OSMUX cid is already taken */ bool osmux_cid_pool_allocated(uint8_t osmux_cid) { return !!(osmux_cid_bitmap[osmux_cid / 8] & (1 << (osmux_cid % 8))); }