use_count.h
Go to the documentation of this file.
/*
* (C) 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
*
* All Rights Reserved
*
* Author: Neels Hofmeyr <neels@hofmeyr.de>
*
* SPDX-License-Identifier: GPL-2.0+
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#pragma once
#include <stdint.h>
#include <stdlib.h>
#include <osmocom/core/linuxlist.h>
struct osmo_use_count_entry;
typedef int (* osmo_use_count_cb_t )(struct osmo_use_count_entry *use_count_entry, int32_t old_use_count,
const char *file, int line);
struct osmo_use_count {
void *talloc_object;
osmo_use_count_cb_t use_cb;
struct llist_head use_counts;
};
struct osmo_use_count_entry {
struct llist_head entry;
struct osmo_use_count *use_count;
const char *use;
int32_t count;
};
#define osmo_use_count_get_put(USE_LIST, USE, CHANGE) \
_osmo_use_count_get_put(USE_LIST, USE, CHANGE, __FILE__, __LINE__)
int _osmo_use_count_get_put(struct osmo_use_count *uc, const char *use, int32_t change,
const char *file, int line);
const char *osmo_use_count_name_buf(char *buf, size_t buf_len, const struct osmo_use_count *uc);
int osmo_use_count_to_str_buf(char *buf, size_t buf_len, const struct osmo_use_count *uc);
char *osmo_use_count_to_str_c(void *ctx, const struct osmo_use_count *uc);
int32_t osmo_use_count_total(const struct osmo_use_count *uc);
int32_t osmo_use_count_by(const struct osmo_use_count *uc, const char *use);
struct osmo_use_count_entry *osmo_use_count_find(const struct osmo_use_count *uc, const char *use);
void osmo_use_count_free(struct osmo_use_count_entry *use_count_entry);
void osmo_use_count_make_static_entries(struct osmo_use_count *uc, struct osmo_use_count_entry *buf,
size_t buf_n_entries);
file
write Write running configuration to or terminal n Write configuration to the file(same as write file)\n") ALIAS(config_write_file
osmo_use_count_to_str_buf
int osmo_use_count_to_str_buf(char *buf, size_t buf_len, const struct osmo_use_count *uc)
Write a comprehensive listing of use counts to a string buffer.
Definition: use_count.c:121
osmo_use_count_find
struct osmo_use_count_entry * osmo_use_count_find(const struct osmo_use_count *uc, const char *use)
Definition: use_count.c:168
osmo_use_count_make_static_entries
void osmo_use_count_make_static_entries(struct osmo_use_count *uc, struct osmo_use_count_entry *buf, size_t buf_n_entries)
Add N static use token entries to avoid dynamic allocation of use count tokens.
Definition: use_count.c:293
osmo_use_count_total
int32_t osmo_use_count_total(const struct osmo_use_count *uc)
Return the sum of all use counts, min- and max-clamped at INT32_MIN and INT32_MAX.
Definition: use_count.c:71
osmo_use_count_cb_t
int(* osmo_use_count_cb_t)(struct osmo_use_count_entry *use_count_entry, int32_t old_use_count, const char *file, int line)
Invoked when a use count changes.
Definition: use_count.h:66
osmo_use_count_name_buf
const char * osmo_use_count_name_buf(char *buf, size_t buf_len, const struct osmo_use_count *uc)
Write a comprehensive listing of use counts to a string buffer.
Definition: use_count.c:108
osmo_use_count_free
void osmo_use_count_free(struct osmo_use_count_entry *use_count_entry)
Deallocate a use count entry.
Definition: use_count.c:224
osmo_use_count_to_str_c
char * osmo_use_count_to_str_c(void *ctx, const struct osmo_use_count *uc)
Write a comprehensive listing of use counts to a talloc allocated string buffer.
Definition: use_count.c:158
_osmo_use_count_get_put
int _osmo_use_count_get_put(struct osmo_use_count *uc, const char *use, int32_t change, const char *file, int line)
Implementation for osmo_use_count_get_put(), which can also be directly invoked to pass source file i...
Definition: use_count.c:237
osmo_use_count_by
int32_t osmo_use_count_by(const struct osmo_use_count *uc, const char *use)
Return use count by a single use token.
Definition: use_count.c:90
linuxlist.h
Simple doubly linked list implementation.
llist_head
(double) linked list header structure
Definition: linuxlist.h:46
osmo_use_count_entry
One named counter in the list managed by osmo_use_count.
Definition: use_count.h:194
osmo_use_count_entry::use_count
struct osmo_use_count * use_count
Parent use count and backpointer to the talloc_object.
Definition: use_count.h:198
osmo_use_count_entry::entry
struct llist_head entry
Entry in osmo_use_count->use_counts.
Definition: use_count.h:196
osmo_use_count_entry::use
const char * use
Use token string that was passed to osmo_use_count_get_put().
Definition: use_count.h:200
osmo_use_count_entry::count
int32_t count
Current use count amount for only this use token string.
Definition: use_count.h:203
osmo_use_count
Use counter state for one used object, managing N distinct named counters.
Definition: use_count.h:172
osmo_use_count::use_counts
struct llist_head use_counts
List of use tokens.
Definition: use_count.h:179
osmo_use_count::talloc_object
void * talloc_object
Context to talloc-allocate use count entries from (if at all necessary); back-pointer to the owning o...
Definition: use_count.h:175
osmo_use_count::use_cb
osmo_use_count_cb_t use_cb
If not NULL, this is invoked for each use count change.
Definition: use_count.h:177