ring_private.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2020-2022 Intel Corporation
 */
 
#ifndef _RING_PRIVATE_H_
#define _RING_PRIVATE_H_
 
#include <cne_atomic.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* @internal defines for passing to the enqueue dequeue worker functions */
#define __IS_SP 1
#define __IS_MP 0
#define __IS_SC 1
#define __IS_MC 0
 
enum cne_ring_queue_behavior {
    CNE_RING_QUEUE_FIXED_ITEMS = 0, /* Enq/Deq a fixed number of items from a ring */
    CNE_RING_QUEUE_VARIABLE_ITEMS   /* Enq/Deq as many items as possible from ring */
};
 
/*  @internal structure to hold a pair of head/tail values and other metadata */
struct cne_ring_headtail {
    CNE_ATOMIC(uint_least32_t) head; 
    CNE_ATOMIC(uint_least32_t) tail; 
    uint32_t single;                 
};
 
struct cne_ring {
    char name[CNE_RING_NAMESIZE] __cne_cache_aligned;
    void *ring_mem;    
    int flags;         
    uint32_t size;     
    uint32_t mask;     
    uint32_t capacity; 
    char pad0 __cne_cache_aligned; 
    struct cne_ring_headtail prod __cne_cache_aligned;
    char pad1 __cne_cache_aligned; 
    struct cne_ring_headtail cons __cne_cache_aligned;
    char pad2 __cne_cache_aligned; 
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* _RING_PRIVATE_H_ */