osmo-bsc/src/osmo-bsc/bsc_subscriber.c

/* GSM subscriber details for use in BSC land */

/*
 * (C) 2016 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
 *
 * Author: Neels Hofmeyr <nhofmeyr@sysmocom.de>
 *
 * All Rights 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#include <talloc.h>
#include <string.h>
#include <limits.h>

#include <osmocom/gsm/gsm48.h>
#include <osmocom/core/logging.h>

#include <osmocom/bsc/bsc_subscriber.h>
#include <osmocom/bsc/paging.h>
#include <osmocom/bsc/debug.h>

static void bsc_subscr_free(struct bsc_subscr *bsub);

static int bsub_use_cb(struct osmo_use_count_entry *e, int32_t old_use_count, const char *file, int line)
{
	struct bsc_subscr *bsub = e->use_count->talloc_object;
	int32_t total;
	int level;

	if (!e->use)
		return -EINVAL;

	total = osmo_use_count_total(&bsub->use_count);

	if (total == 0
	    || (total == 1 && old_use_count == 0 && e->count == 1))
		level = LOGL_INFO;
	else
		level = LOGL_DEBUG;

	LOGPSRC(DREF, level, file, line, "%s: %s %s: now used by %s\n",
		bsc_subscr_name(bsub),
		(e->count - old_use_count) > 0? "+" : "-", e->use,
		osmo_use_count_to_str_c(OTC_SELECT, &bsub->use_count));

	if (e->count < 0)
		return -ERANGE;

	if (total == 0)
		bsc_subscr_free(bsub);
	return 0;
}

struct bsc_subscr_store *bsc_subscr_store_alloc(void *ctx)
{
	struct bsc_subscr_store *bsubst;

	bsubst = talloc_zero(ctx, struct bsc_subscr_store);
	if (!bsubst)
		return NULL;

	INIT_LLIST_HEAD(&bsubst->bsub_list);
	return bsubst;
}

static struct bsc_subscr *bsc_subscr_alloc(struct bsc_subscr_store *bsubst)
{
	struct bsc_subscr *bsub;

	bsub = talloc_zero(bsubst, struct bsc_subscr);
	if (!bsub)
		return NULL;

	bsub->store = bsubst;
	bsub->tmsi = GSM_RESERVED_TMSI;
	bsub->use_count = (struct osmo_use_count){
		.talloc_object = bsub,
		.use_cb = bsub_use_cb,
	};
	INIT_LLIST_HEAD(&bsub->active_paging_requests);

	llist_add_tail(&bsub->entry, &bsubst->bsub_list);

	return bsub;
}

struct bsc_subscr *bsc_subscr_find_by_imsi(struct bsc_subscr_store *bsubst,
					   const char *imsi,
					   const char *use_token)
{
	struct bsc_subscr *bsub;

	if (!imsi || !*imsi)
		return NULL;

	llist_for_each_entry(bsub, &bsubst->bsub_list, entry) {
		if (!strcmp(bsub->imsi, imsi)) {
			bsc_subscr_get(bsub, use_token);
			return bsub;
		}
	}
	return NULL;
}

static struct bsc_subscr *bsc_subscr_find_by_imei(struct bsc_subscr_store *bsubst,
						  const char *imei,
						  const char *use_token)
{
	struct bsc_subscr *bsub;

	if (!imei || !*imei)
		return NULL;

	llist_for_each_entry(bsub, &bsubst->bsub_list, entry) {
		if (!strcmp(bsub->imei, imei)) {
			bsc_subscr_get(bsub, use_token);
			return bsub;
		}
	}
	return NULL;
}

static struct bsc_subscr *bsc_subscr_find_by_tmsi(struct bsc_subscr_store *bsubst,
						  uint32_t tmsi,
						  const char *use_token)
{
	const struct rb_node *node = bsubst->bsub_tree_tmsi.rb_node;
	struct bsc_subscr *bsub;

	if (tmsi == GSM_RESERVED_TMSI)
		return NULL;

	while (node) {
		bsub = container_of(node, struct bsc_subscr, node_tmsi);
		if (tmsi < bsub->tmsi)
			node = node->rb_left;
		else if (tmsi > bsub->tmsi)
			node = node->rb_right;
		else {
			bsc_subscr_get(bsub, use_token);
			return bsub;
		}
	}

	return NULL;
}

static int bsc_subscr_store_insert_bsub_tmsi(struct bsc_subscr *bsub)
{
	struct bsc_subscr_store *bsubst = bsub->store;
	struct rb_node **n = &(bsubst->bsub_tree_tmsi.rb_node);
	struct rb_node *parent = NULL;

	OSMO_ASSERT(bsub->tmsi != GSM_RESERVED_TMSI);

	while (*n) {
		struct bsc_subscr *it;

		it = container_of(*n, struct bsc_subscr, node_tmsi);

		parent = *n;
		if (bsub->tmsi < it->tmsi) {
			n = &((*n)->rb_left);
		} else if (bsub->tmsi > it->tmsi) {
			n = &((*n)->rb_right);
		} else {
			LOGP(DMSC, LOGL_ERROR, "Trying to reserve already reserved tmsi %u\n", bsub->tmsi);
			return -EEXIST;
		}
	}

	rb_link_node(&bsub->node_tmsi, parent, n);
	rb_insert_color(&bsub->node_tmsi, &bsubst->bsub_tree_tmsi);
	return 0;
}

int bsc_subscr_set_tmsi(struct bsc_subscr *bsub, uint32_t tmsi)
{
	int rc = 0;

	if (!bsub)
		return -EINVAL;

	if (bsub->tmsi == tmsi)
		return 0;

	/* bsub was already inserted, remove and re-insert with new tmsi */
	if (bsub->tmsi != GSM_RESERVED_TMSI)
		rb_erase(&bsub->node_tmsi, &bsub->store->bsub_tree_tmsi);

	bsub->tmsi = tmsi;

	/* If new tmsi is set, insert bsub into rbtree: */
	if (bsub->tmsi != GSM_RESERVED_TMSI) {
		if ((rc = bsc_subscr_store_insert_bsub_tmsi(bsub)) < 0)
			bsub->tmsi = GSM_RESERVED_TMSI;
	}

	return rc;
}

void bsc_subscr_set_imsi(struct bsc_subscr *bsub, const char *imsi)
{
	if (!bsub)
		return;
	osmo_strlcpy(bsub->imsi, imsi, sizeof(bsub->imsi));
}

void bsc_subscr_set_imei(struct bsc_subscr *bsub, const char *imei)
{
	if (!bsub)
		return;
	osmo_strlcpy(bsub->imei, imei, sizeof(bsub->imei));
}

struct bsc_subscr *bsc_subscr_find_or_create_by_imsi(struct bsc_subscr_store *bsubst,
						     const char *imsi,
						     const char *use_token)
{
	struct bsc_subscr *bsub;
	bsub = bsc_subscr_find_by_imsi(bsubst, imsi, use_token);
	if (bsub)
		return bsub;
	bsub = bsc_subscr_alloc(bsubst);
	if (!bsub)
		return NULL;
	bsc_subscr_set_imsi(bsub, imsi);
	bsc_subscr_get(bsub, use_token);
	return bsub;
}

static struct bsc_subscr *bsc_subscr_find_or_create_by_imei(struct bsc_subscr_store *bsubst,
							    const char *imei,
							    const char *use_token)
{
	struct bsc_subscr *bsub;
	bsub = bsc_subscr_find_by_imei(bsubst, imei, use_token);
	if (bsub)
		return bsub;
	bsub = bsc_subscr_alloc(bsubst);
	if (!bsub)
		return NULL;
	bsc_subscr_set_imei(bsub, imei);
	bsc_subscr_get(bsub, use_token);
	return bsub;
}

struct bsc_subscr *bsc_subscr_find_or_create_by_tmsi(struct bsc_subscr_store *bsubst,
						     uint32_t tmsi,
						     const char *use_token)
{
	struct bsc_subscr *bsub;
	bsub = bsc_subscr_find_by_tmsi(bsubst, tmsi, use_token);
	if (bsub)
		return bsub;
	bsub = bsc_subscr_alloc(bsubst);
	if (!bsub)
		return NULL;
	if (bsc_subscr_set_tmsi(bsub, tmsi) < 0) {
		bsc_subscr_free(bsub);
		return NULL;
	}
	bsc_subscr_get(bsub, use_token);
	return bsub;
}

struct bsc_subscr *bsc_subscr_find_or_create_by_mi(struct bsc_subscr_store *bsubst, const struct osmo_mobile_identity *mi,
						   const char *use_token)
{
	if (!mi)
		return NULL;
	switch (mi->type) {
	case GSM_MI_TYPE_IMSI:
		return bsc_subscr_find_or_create_by_imsi(bsubst, mi->imsi, use_token);
	case GSM_MI_TYPE_IMEI:
		return bsc_subscr_find_or_create_by_imei(bsubst, mi->imei, use_token);
	case GSM_MI_TYPE_TMSI:
		return bsc_subscr_find_or_create_by_tmsi(bsubst, mi->tmsi, use_token);
	default:
		return NULL;
	}
}

static int bsc_subscr_name_buf(char *buf, size_t buflen, struct bsc_subscr *bsub)
{
	struct osmo_strbuf sb = { .buf = buf, .len = buflen };
	OSMO_STRBUF_PRINTF(sb, "subscr");
	if (!bsub) {
		OSMO_STRBUF_PRINTF(sb, "-null");
		return sb.chars_needed;
	}
	if (bsub->imsi[0])
		OSMO_STRBUF_PRINTF(sb, "-IMSI-%s", bsub->imsi);
	else if (bsub->imei[0])
		OSMO_STRBUF_PRINTF(sb, "-IMEI-%s", bsub->imei);
	if (bsub->tmsi != GSM_RESERVED_TMSI)
		OSMO_STRBUF_PRINTF(sb, "-TMSI-0x%08x", bsub->tmsi);
	return sb.chars_needed;
}

static char *bsc_subscr_name_c(void *ctx, struct bsc_subscr *bsub)
{
	OSMO_NAME_C_IMPL(ctx, 64, "ERROR", bsc_subscr_name_buf, bsub)
}

const char *bsc_subscr_name(struct bsc_subscr *bsub)
{
	return bsc_subscr_name_c(OTC_SELECT, bsub);
}

/* Like bsc_subscr_name() but returns only characters approved by osmo_identifier_valid(), useful for
 * osmo_fsm_inst IDs. */
const char *bsc_subscr_id(struct bsc_subscr *bsub)
{
	return bsc_subscr_name(bsub);
}

static void bsc_subscr_free(struct bsc_subscr *bsub)
{
	OSMO_ASSERT(llist_empty(&bsub->active_paging_requests));

	if (bsub->tmsi != GSM_RESERVED_TMSI)
		rb_erase(&bsub->node_tmsi, &bsub->store->bsub_tree_tmsi);

	llist_del(&bsub->entry);
	talloc_free(bsub);
}

#define BSUB_USE_LOG_FILTER "log_filter"

void log_set_filter_bsc_subscr(struct log_target *target,
			       struct bsc_subscr *bsc_subscr)
{
	struct bsc_subscr **fsub = (void*)&target->filter_data[LOG_FLT_BSC_SUBSCR];

	/* free the old data */
	if (*fsub) {
		bsc_subscr_put(*fsub, BSUB_USE_LOG_FILTER);
		*fsub = NULL;
	}

	if (bsc_subscr) {
		target->filter_map |= (1 << LOG_FLT_BSC_SUBSCR);
		*fsub = bsc_subscr;
		bsc_subscr_get(*fsub, BSUB_USE_LOG_FILTER);
	} else
		target->filter_map &= ~(1 << LOG_FLT_BSC_SUBSCR);
}

void bsc_subscr_add_active_paging_request(struct bsc_subscr *bsub, struct gsm_paging_request *req)
{
	bsub->active_paging_requests_len++;
	bsc_subscr_get(bsub, BSUB_USE_PAGING_REQUEST);
	llist_add_tail(&req->bsub_entry, &bsub->active_paging_requests);
}

void bsc_subscr_remove_active_paging_request(struct bsc_subscr *bsub, struct gsm_paging_request *req)
{
	llist_del(&req->bsub_entry);
	bsub->active_paging_requests_len--;
	bsc_subscr_put(bsub, BSUB_USE_PAGING_REQUEST);
}

void bsc_subscr_remove_active_paging_request_all(struct bsc_subscr *bsub)
{
	/* Avoid accessing bsub after reaching 0 active_paging_request_len,
	 * since it could be freed during put(): */
	unsigned remaining = bsub->active_paging_requests_len;
	while (remaining > 0) {
		struct gsm_paging_request *req;
		req = llist_first_entry(&bsub->active_paging_requests,
					 struct gsm_paging_request, bsub_entry);
		bsc_subscr_remove_active_paging_request(bsub, req);
		remaining--;
	}
}

struct gsm_paging_request *bsc_subscr_find_req_by_bts(const struct bsc_subscr *bsub, const struct gsm_bts *bts)
{
	struct gsm_paging_request *req;
	llist_for_each_entry(req, &bsub->active_paging_requests, bsub_entry) {
		if (req->bts == bts)
			return req;
	}
	return NULL;
}