rte_keepalive.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright 2015-2016 Intel Shannon Ltd. 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 _KEEPALIVE_H_
#define _KEEPALIVE_H_

#include <rte_memory.h>

#ifndef RTE_KEEPALIVE_MAXCORES

#define RTE_KEEPALIVE_MAXCORES RTE_MAX_LCORE
#endif

enum rte_keepalive_state {
    RTE_KA_STATE_UNUSED = 0,
    RTE_KA_STATE_ALIVE = 1,
    RTE_KA_STATE_MISSING = 4,
    RTE_KA_STATE_DEAD = 2,
    RTE_KA_STATE_GONE = 3,
    RTE_KA_STATE_DOZING = 5,
    RTE_KA_STATE_SLEEP = 6
};

typedef void (*rte_keepalive_failure_callback_t)(
    void *data,
    const int id_core);

typedef void (*rte_keepalive_relay_callback_t)(
    void *data,
    const int id_core,
    enum rte_keepalive_state core_state,
    uint64_t last_seen
    );

struct rte_keepalive;

struct rte_keepalive *rte_keepalive_create(
    rte_keepalive_failure_callback_t callback,
    void *data);

void rte_keepalive_dispatch_pings(void *ptr_timer, void *ptr_data);

void rte_keepalive_register_core(struct rte_keepalive *keepcfg,
    const int id_core);

void
rte_keepalive_mark_alive(struct rte_keepalive *keepcfg);

void
rte_keepalive_mark_sleep(struct rte_keepalive *keepcfg);

void
rte_keepalive_register_relay_callback(struct rte_keepalive *keepcfg,
    rte_keepalive_relay_callback_t callback,
    void *data);

#endif /* _KEEPALIVE_H_ */