tdef.h

Go to the documentation of this file.

 
/*
 * (C) 2018-2019 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
 *
 * All Rights Reserved
 *
 * SPDX-License-Identifier: GPL-2.0+
 *
 * Author: Neels Hofmeyr <neels@hofmeyr.de>
 *
 * 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/>.
 */
#pragma once
 
#include <stdint.h>
#include <osmocom/core/utils.h>
 
struct osmo_fsm_inst;
 
enum osmo_tdef_unit {
        OSMO_TDEF_S = 0,        
        OSMO_TDEF_MS,           
        OSMO_TDEF_M,            
        OSMO_TDEF_CUSTOM,       
        OSMO_TDEF_US,           
};
 
extern const struct value_string osmo_tdef_unit_names[];
static inline const char *osmo_tdef_unit_name(enum osmo_tdef_unit val)
{ return get_value_string(osmo_tdef_unit_names, val); }
 
struct osmo_tdef {
        const int T;
        const unsigned long default_val;
        const enum osmo_tdef_unit unit;
        const char *desc;
        unsigned long val;
        unsigned long min_val;
        unsigned long max_val;
};
 
#define osmo_tdef_for_each(t, tdefs) \
        for (t = tdefs; t && (t->T || t->default_val || t->desc); t++)
 
void osmo_tdefs_reset(struct osmo_tdef *tdefs);
unsigned long osmo_tdef_get(const struct osmo_tdef *tdefs, int T, enum osmo_tdef_unit as_unit,
                            long val_if_not_present);
struct osmo_tdef *osmo_tdef_get_entry(struct osmo_tdef *tdefs, int T);
int osmo_tdef_set(struct osmo_tdef *tdefs, int T, unsigned long val, enum osmo_tdef_unit val_unit);
bool osmo_tdef_val_in_range(struct osmo_tdef *tdef, unsigned long new_val);
int osmo_tdef_range_str_buf(char *buf, size_t buf_len, struct osmo_tdef *t);
 
struct osmo_tdef_state_timeout {
        int T;
        bool keep_timer;
};
 
const struct osmo_tdef_state_timeout *osmo_tdef_get_state_timeout(uint32_t state,
                                                                  const struct osmo_tdef_state_timeout *timeouts_array);
 
#define osmo_tdef_fsm_inst_state_chg(fi, state, timeouts_array, tdefs, default_timeout) \
        _osmo_tdef_fsm_inst_state_chg(fi, state, timeouts_array, tdefs, default_timeout, \
                                      __FILE__, __LINE__)
int _osmo_tdef_fsm_inst_state_chg(struct osmo_fsm_inst *fi, uint32_t state,
                                  const struct osmo_tdef_state_timeout *timeouts_array,
                                  const struct osmo_tdef *tdefs, signed long default_timeout,
                                  const char *file, int line);
 
struct osmo_tdef_group {
        const char *name;
        const char *desc;
        struct osmo_tdef *tdefs;
};
 
#define osmo_tdef_groups_for_each(g, tdef_groups) \
        for (g = tdef_groups; g && g->tdefs; g++)