cne_timer.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2010-2022 Intel Corporation
 */
 
#ifndef _CNE_TIMER_H_
#define _CNE_TIMER_H_
 
#include <stdio.h>         // for FILE
#include <stdint.h>        // for uint64_t, int16_t, uint16_t
#include <stddef.h>
#include <cne_common.h>        // for CNE_STD_C11
#include <cne_atomic.h>        // for atomic_uint_least32_t
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CNE_TIMER_STOP     0  
#define CNE_TIMER_PENDING  1  
#define CNE_TIMER_RUNNING  2  
#define CNE_TIMER_CONFIG   3  
#define CNE_TIMER_NO_OWNER -2 
enum cne_timer_type { SINGLE, PERIODICAL };
 
union cne_timer_status {
    CNE_STD_C11
    struct {
        uint16_t state; 
        int16_t owner;  
    };
    CNE_ATOMIC(uint_least32_t) u32; 
};
 
struct cne_timer_debug_stats {
    uint64_t reset;   
    uint64_t stop;    
    uint64_t manage;  
    uint64_t pending; 
};
 
struct cne_timer;
 
typedef void (*cne_timer_cb_t)(struct cne_timer *, void *);
 
#define MAX_SKIPLIST_DEPTH 10
 
struct cne_timer {
    uint64_t expire;                               
    struct cne_timer *sl_next[MAX_SKIPLIST_DEPTH]; 
    volatile union cne_timer_status status;        
    uint64_t period;                               
    cne_timer_cb_t f;                              
    void *arg;                                     
};
 
#ifdef __cplusplus
#define CNE_TIMER_INITIALIZER                                             \
    {                                                                     \
        0, {NULL}, {{CNE_TIMER_STOP, CNE_TIMER_NO_OWNER}}, 0, NULL, NULL, \
    }
#else
#define CNE_TIMER_INITIALIZER            \
    {                                    \
        .status = {{                     \
            .state = CNE_TIMER_STOP,     \
            .owner = CNE_TIMER_NO_OWNER, \
        }},                              \
    }
#endif
 
void cne_timer_subsystem_init(void);
 
void cne_timer_init(struct cne_timer *tim);
 
int cne_timer_reset(struct cne_timer *tim, uint64_t ticks, enum cne_timer_type type,
                    unsigned tim_thread, cne_timer_cb_t fct, void *arg);
 
void cne_timer_reset_sync(struct cne_timer *tim, uint64_t ticks, enum cne_timer_type type,
                          unsigned tim_thread, cne_timer_cb_t fct, void *arg);
 
int cne_timer_stop(struct cne_timer *tim);
 
void cne_timer_stop_sync(struct cne_timer *tim);
 
int cne_timer_pending(struct cne_timer *tim);
 
void cne_timer_manage(void);
 
void cne_timer_dump_stats(FILE *f);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CNE_TIMER_H_ */