rte_mutex.h

Go to the documentation of this file.

#ifndef RTE_OS_MUTEX_H
#define RTE_OS_MUTEX_H
 
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

RTE_DECLARE_STORAGE(rte_mutex_storage_t, 128U);

typedef struct rte_mutex_impl_s *rte_mutex_handle_t;

rte_status_t rte_mutex_create(rte_mutex_storage_t *storage, rte_mutex_handle_t *out_handle);

rte_status_t rte_mutex_lock(rte_mutex_handle_t handle);

rte_status_t rte_mutex_lock_timed(rte_mutex_handle_t handle, rte_duration_ms_t timeout_ms);

rte_status_t rte_mutex_unlock(rte_mutex_handle_t handle);

rte_status_t rte_mutex_destroy(rte_mutex_handle_t handle);
 
/*
 * The OSAdapter vtable (rte_osadapter_mutex_t) and rte_osadapter_mutex_register()
 * live in rte_osadapter/mutex/rte_osadapter_mutex.h, not here (ADR-021
 * consumer/osadapter split). This header is the consumer-facing surface
 * only - a real application never needs to see the OSAdapter vtable shape;
 * only the platform integrator wiring a concrete OSAdapter does.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_OS_MUTEX_H */
 /* MUTEX */