timer.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2013-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_LIB_TIMER_H__
#define __MOTR_LIB_TIMER_H__

#include "lib/types.h"
#include "lib/tlist.h"     /* m0_tl */
#include "lib/mutex.h"     /* m0_mutex */

typedef unsigned long (*m0_timer_callback_t)(unsigned long data);
struct m0_timer;
struct m0_timer_locality;

enum m0_timer_type {
        M0_TIMER_SOFT,
        M0_TIMER_HARD,
        M0_TIMER_TYPE_NR,
};

enum m0_timer_state {
        M0_TIMER_UNINIT = 0,
        M0_TIMER_INITED,
        M0_TIMER_RUNNING,
        M0_TIMER_STOPPED,
        M0_TIMER_STATE_NR,
};

struct m0_timer_operations {
        int (*tmr_init)(struct m0_timer *timer, struct m0_timer_locality *loc);
        void (*tmr_fini)(struct m0_timer *timer);
        void (*tmr_start)(struct m0_timer *timer);
        void (*tmr_stop)(struct m0_timer *timer);
};

#ifndef __KERNEL__
#include "lib/user_space/timer.h"
#else
#include "lib/linux_kernel/timer.h"
#endif

M0_INTERNAL int m0_timer_init(struct m0_timer          *timer,
                              enum m0_timer_type        type,
                              struct m0_timer_locality *loc,
                              m0_timer_callback_t       callback,
                              unsigned long             data);

M0_INTERNAL void m0_timer_start(struct m0_timer *timer,
                                m0_time_t        expire);

M0_INTERNAL void m0_timer_stop(struct m0_timer *timer);

M0_INTERNAL bool m0_timer_is_started(const struct m0_timer *timer);

M0_INTERNAL void m0_timer_fini(struct m0_timer *timer);

M0_INTERNAL void m0_timer_callback_execute(struct m0_timer *timer);

M0_INTERNAL void m0_timer_locality_init(struct m0_timer_locality *loc);

M0_INTERNAL void m0_timer_locality_fini(struct m0_timer_locality *loc);

M0_INTERNAL int m0_timer_thread_attach(struct m0_timer_locality *loc);

M0_INTERNAL void m0_timer_thread_detach(struct m0_timer_locality *loc);

/* __MOTR_LIB_TIMER_H__ */
#endif

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