libosmocore 1.9.0.196-9975
Osmocom core library
use_count.h
Go to the documentation of this file.
1
4/*
5 * (C) 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
6 *
7 * All Rights Reserved
8 *
9 * Author: Neels Hofmeyr <neels@hofmeyr.de>
10 *
11 * SPDX-License-Identifier: GPL-2.0+
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 */
23
24#pragma once
25
26#include <stdint.h>
27#include <stdlib.h>
28
30
37
62typedef int (* osmo_use_count_cb_t )(struct osmo_use_count_entry *use_count_entry, int32_t old_use_count,
63 const char *file, int line);
64
176};
177
196 const char *use;
199 int32_t count;
200};
201
208#define osmo_use_count_get_put(USE_LIST, USE, CHANGE) \
209 _osmo_use_count_get_put(USE_LIST, USE, CHANGE, __FILE__, __LINE__)
210
211int _osmo_use_count_get_put(struct osmo_use_count *uc, const char *use, int32_t change,
212 const char *file, int line);
213
214const char *osmo_use_count_name_buf(char *buf, size_t buf_len, const struct osmo_use_count *uc);
215int osmo_use_count_to_str_buf(char *buf, size_t buf_len, const struct osmo_use_count *uc);
216char *osmo_use_count_to_str_c(void *ctx, const struct osmo_use_count *uc);
217
218int32_t osmo_use_count_total(const struct osmo_use_count *uc);
219int32_t osmo_use_count_by(const struct osmo_use_count *uc, const char *use);
220
221struct osmo_use_count_entry *osmo_use_count_find(const struct osmo_use_count *uc, const char *use);
222void osmo_use_count_free(struct osmo_use_count_entry *use_count_entry);
223
225 size_t buf_n_entries);
226
write Write running configuration to or terminal n Write configuration to the file(same as write file)\n") ALIAS(config_write_file
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:117
struct osmo_use_count_entry * osmo_use_count_find(const struct osmo_use_count *uc, const char *use)
Definition: use_count.c:164
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:291
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:67
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:62
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:104
void osmo_use_count_free(struct osmo_use_count_entry *use_count_entry)
Deallocate a use count entry.
Definition: use_count.c:220
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:154
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:233
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:86
Simple doubly linked list implementation.
(double) linked list header structure
Definition: linuxlist.h:46
One named counter in the list managed by osmo_use_count.
Definition: use_count.h:190
struct osmo_use_count * use_count
Parent use count and backpointer to the talloc_object.
Definition: use_count.h:194
struct llist_head entry
Entry in osmo_use_count->use_counts.
Definition: use_count.h:192
const char * use
Use token string that was passed to osmo_use_count_get_put().
Definition: use_count.h:196
int32_t count
Current use count amount for only this use token string.
Definition: use_count.h:199
Use counter state for one used object, managing N distinct named counters.
Definition: use_count.h:168
struct llist_head use_counts
List of use tokens.
Definition: use_count.h:175
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:171
osmo_use_count_cb_t use_cb
If not NULL, this is invoked for each use count change.
Definition: use_count.h:173