sim.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2020 Seagate Technology LLC and/or its Affiliates
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_DESIM_SIM_H__
#define __MOTR_DESIM_SIM_H__

#include <stdarg.h>

#if defined(__APPLE__)
/* for ucontext:
   http://lists.apple.com/archives/darwin-dev/2008/Jan/msg00229.html */
#define _XOPEN_SOURCE
#endif

#include <stdlib.h>
#include <ucontext.h>

#include "lib/tlist.h"
#include "desim/cnt.h"

struct sim;
struct sim_callout;
struct sim_thread;

typedef unsigned long long sim_time_t;
typedef int sim_call_t(struct sim_callout *);
typedef void sim_func_t(struct sim *, struct sim_thread *, void *);

struct sim_callout {
        sim_time_t         sc_time;
        sim_call_t         *sc_call;
        void               *sc_datum;
        struct m0_tlink     sc_linkage;
        struct sim         *sc_sim;
        uint64_t            sc_magic;
};

struct sim {
        sim_time_t          ss_bolt;
        struct m0_tl       ss_future;
};

struct sim_thread {
        struct sim         *st_sim;
        void               *st_stack;
        unsigned            st_size;
        ucontext_t          st_ctx;
        /* channel waiting */
        struct m0_tlink     st_block;
        sim_time_t          st_blocked;
        struct sim_callout  st_wake;
        uint64_t            st_magic;
};

struct sim_chan {
        struct m0_tl        ch_threads;
        struct cnt          ch_cnt_sleep;
};

M0_INTERNAL void sim_init(struct sim *state);
M0_INTERNAL void sim_fini(struct sim *state);
M0_INTERNAL void sim_run(struct sim *state);

M0_INTERNAL void sim_timer_add(struct sim *state, sim_time_t delta,
                               sim_call_t * cfunc, void *datum);
M0_INTERNAL void sim_timer_rearm(struct sim_callout *call, sim_time_t delta,
                                 sim_call_t * cfunc, void *datum);
M0_INTERNAL void *sim_alloc(size_t size);
M0_INTERNAL void sim_free(void *ptr);

M0_INTERNAL void sim_chan_init(struct sim_chan *chan, char *format, ...)
        __attribute__((format(printf, 2, 3)));
M0_INTERNAL void sim_chan_fini(struct sim_chan *chan);
M0_INTERNAL void sim_chan_wait(struct sim_chan *chan,
                               struct sim_thread *thread);
M0_INTERNAL void sim_chan_signal(struct sim_chan *chan);
M0_INTERNAL void sim_chan_broadcast(struct sim_chan *chan);

M0_INTERNAL void sim_thread_init(struct sim *state, struct sim_thread *thread,
                                 unsigned stacksize, sim_func_t func,
                                 void *arg);
M0_INTERNAL void sim_thread_fini(struct sim_thread *thread);
M0_INTERNAL void sim_thread_exit(struct sim_thread *thread);

M0_INTERNAL void sim_sleep(struct sim_thread *thread, sim_time_t nap);
M0_INTERNAL struct sim_thread *sim_thread_current(void);

/* get a pseudo-random number in the interval [a, b] */
M0_INTERNAL unsigned long long sim_rnd(unsigned long long a,
                                       unsigned long long b);

M0_INTERNAL void sim_name_set(char **name, const char *format, ...)
        __attribute__((format(printf, 2, 3)));

M0_INTERNAL void sim_name_vaset(char **name, const char *format,
                                va_list valist);

enum sim_log_level {
        SLL_WARN,
        SLL_INFO,
        SLL_TRACE,
        SLL_DEBUG
};

extern enum sim_log_level sim_log_level;

M0_INTERNAL void
sim_log(struct sim *s, enum sim_log_level level, const char *format, ...)
        __attribute__((format(printf, 3, 4)));

M0_INTERNAL int sim_global_init(void);
M0_INTERNAL void sim_global_fini(void);

#endif /* __MOTR_DESIM_SIM_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */