dlq.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2018
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_dlq
#define _H_dlq
/*  FILE: dlq.h
*********************************************************************
*                                    *
*             P U R P O S E                    *
*                                    *
*********************************************************************/
 
/*********************************************************************
*                                    *
*           C H A N G E     H I S T O R Y                *
*                                    *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
06-jan-89    abb      Begun.
18-jan-91    abb      adapted for depend project
12-mar-91    abb      adapted for DAVID sbee project
14-jun-91    abb      changed que.h to dlq.h
27-apr-05    abb      update docs and use for netconf project
15-feb-06    abb      make DLQ module const compatible
                      get rid of dlq_hdrPT, as this doesn't work
                      for const pointers.
15-sep-06    abb      added dlq_swap function
26-jan-07    abb      added dlq_hdr_t alias for NCX naming conventions
12-oct-07    abb      add dlq_count
*/
 
#include "procdefs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*
*                             C O N S T A N T S
*
*********************************************************************/
 
/* que header types */
#define        DLQ_NULL_NODE    1313
#define        DLQ_SHDR_NODE    2727
#define        DLQ_DHDR_NODE    3434
#define        DLQ_DATA_NODE    5757
#define        DLQ_DEL_NODE     8686
#define        DLQ_DEL_DHDR     9696
 
#define dlq_hdr_t  dlq_hdrT
 
 
/********************************************************************
*
*                           T Y P E S
*
*********************************************************************/
 
typedef struct TAGdlq_hdrT
{
    unsigned short        hdr_typ;   
    struct TAGdlq_hdrT    *prev;     
    struct TAGdlq_hdrT    *next;     
} YPACK dlq_hdrT;
 
 
/* shorthand macros */
#define _hdr_node(P) (((const dlq_hdrT *)(P))->hdr_typ==DLQ_SHDR_NODE \
    || ((const dlq_hdrT *)(P))->hdr_typ==DLQ_DHDR_NODE)
 
#define _data_node(P) (((const dlq_hdrT *)(P))->hdr_typ==DLQ_DATA_NODE)
 
#define _del_node(P) (((const dlq_hdrT *)(P))->hdr_typ==DLQ_DEL_NODE)
 
 
#define dlq_hdr_node(P) _hdr_node(P)
 
#define dlq_data_node(P) _data_node(P)
 
 
#ifdef PTHREADS
#define DLQ_HAS_NEXT_NODE(P) (((const dlq_hdrT *)(P))->next)
#endif
 
/*
 * Define enter and exit critical section hooks here:
 * This was ENTER_FAST_CS but causing crashes with lots of threads
 */
 
//#define ENTER_CRIT ENTER_FAST_CS
//#define EXIT_CRIT EXIT_FAST_CS
 
#define ENTER_CRIT ENTER_CS
#define EXIT_CRIT EXIT_CS
 
 
/********************************************************************
*
*                          F U N C T I O N S
*
*********************************************************************/
 
#ifdef CPP_DEBUG
extern void dlq_dumpHdr (const void *nodeP);
#endif
 
 
extern dlq_hdrT * dlq_createQue (void);
 
 
extern void dlq_createSQue (dlq_hdrT * queAddr);
 
 
extern void dlq_destroyQue (dlq_hdrT * listP);
 
 
extern void dlq_enque (REG void *newP, REG dlq_hdrT * listP);
 
 
extern void *dlq_deque (dlq_hdrT * listP);
 
 
#if defined(CPP_NO_MACROS)
extern void *dlq_nextEntry (const void *nodeP);
#else
#define dlq_nextEntry(nodeP)  (_data_node(((const dlq_hdrT *) (nodeP))->next) ? \
      ((const dlq_hdrT *) (nodeP))->next : NULL)
#endif        /* END CPP_NO_MACROS */
 
 
#if defined(CPP_NO_MACROS)
extern void *dlq_prevEntry (const void *nodeP);
#else
#define dlq_prevEntry(nodeP) (_data_node(((const dlq_hdrT *) (nodeP))->prev ) ? \
      ((const dlq_hdrT *) (nodeP))->prev : NULL)
#endif    /* CPP_NO_MACROS */
 
 
extern void dlq_insertAhead (void *newP, void *nodeP);
 
 
extern void dlq_insertAfter (void *newP, void *nodeP);
 
 
extern void dlq_remove (void *nodeP);
 
 
extern void dlq_swap (void *new_node, void *cur_node);
 
 
#if defined(CPP_NO_MACROS)
extern void *dlq_firstEntry (const dlq_hdrT * listP);
#else
#define dlq_firstEntry(listP) ((listP) != ((const dlq_hdrT *)(listP))->next ? \
        ((const dlq_hdrT *)(listP))->next : NULL)
#endif        /* CPP_NO_MACROS */
 
 
#if defined(CPP_NO_MACROS)
extern void *dlq_lastEntry (const dlq_hdrT * listP);
#else
#define dlq_lastEntry(listP) ((listP) != ((const dlq_hdrT *)(listP))->next ? \
        ((const dlq_hdrT *)(listP))->prev : NULL)
#endif        /* CPP_NO_MACROS */
 
 
#if defined(CPP_NO_MACROS)
extern boolean dlq_empty (const dlq_hdrT * listP);
#else
#define dlq_empty(listP) (boolean)((listP)==((const dlq_hdrT *)(listP))->next)
#endif        /* CPP_NO_MACROS */
 
 
extern void dlq_block_enque (dlq_hdrT * srcP, dlq_hdrT * dstP);
 
 
extern void dlq_block_insertAhead (dlq_hdrT *srcP, void *dstP);
 
 
extern void dlq_block_insertAfter (dlq_hdrT *srcP, void *dstP);
 
 
extern unsigned int dlq_count (const dlq_hdrT *listP);
 
 
extern boolean dlq_onQueue (const dlq_hdrT *nodeP);
 
 
extern void dlq_reverse_que (dlq_hdr_t *que);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif    /* _H_dlq */