rte_timer.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _RTE_TIMER_H_
#define _RTE_TIMER_H_

#include <stdio.h>
#include <stdint.h>
#include <stddef.h>
#include <rte_common.h>
#include <rte_config.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_TIMER_STOP    0 
#define RTE_TIMER_PENDING 1 
#define RTE_TIMER_RUNNING 2 
#define RTE_TIMER_CONFIG  3 
#define RTE_TIMER_NO_OWNER -2 
enum rte_timer_type {
    SINGLE,
    PERIODICAL
};

union rte_timer_status {
    RTE_STD_C11
    struct {
        uint16_t state;  
        int16_t owner;   
    };
    uint32_t u32;            
};

#ifdef RTE_LIBRTE_TIMER_DEBUG

struct rte_timer_debug_stats {
    uint64_t reset;   
    uint64_t stop;    
    uint64_t manage;  
    uint64_t pending; 
};
#endif

struct rte_timer;

typedef void (*rte_timer_cb_t)(struct rte_timer *, void *);

#define MAX_SKIPLIST_DEPTH 10

struct rte_timer
{
    uint64_t expire;       
    struct rte_timer *sl_next[MAX_SKIPLIST_DEPTH];
    volatile union rte_timer_status status; 
    uint64_t period;       
    rte_timer_cb_t f;      
    void *arg;             
};


#ifdef __cplusplus

#define RTE_TIMER_INITIALIZER {             \
    0,                                      \
    {NULL},                                 \
    {{RTE_TIMER_STOP, RTE_TIMER_NO_OWNER}}, \
    0,                                      \
    NULL,                                   \
    NULL,                                   \
    }
#else

#define RTE_TIMER_INITIALIZER {                      \
        .status = {{                         \
            .state = RTE_TIMER_STOP,     \
            .owner = RTE_TIMER_NO_OWNER, \
        }},                                  \
    }
#endif

void rte_timer_subsystem_init(void);

void rte_timer_init(struct rte_timer *tim);

int rte_timer_reset(struct rte_timer *tim, uint64_t ticks,
            enum rte_timer_type type, unsigned tim_lcore,
            rte_timer_cb_t fct, void *arg);


void
rte_timer_reset_sync(struct rte_timer *tim, uint64_t ticks,
             enum rte_timer_type type, unsigned tim_lcore,
             rte_timer_cb_t fct, void *arg);

int rte_timer_stop(struct rte_timer *tim);


void rte_timer_stop_sync(struct rte_timer *tim);

int rte_timer_pending(struct rte_timer *tim);

void rte_timer_manage(void);

void rte_timer_dump_stats(FILE *f);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_TIMER_H_ */