sphsinglepcqueue.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2015 IBM Corporation.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation, Steven Munroe - initial API and implementation
 */

#ifndef __SPH_SINGLE_PC_QUEUE_H
#define __SPH_SINGLE_PC_QUEUE_H

#include "sastype.h"
#include "sphlfentry.h"


typedef void *SPHSinglePCQueue_t;

#ifdef __cplusplus
#define __C__ "C"
#else
#define __C__
#endif
#if 0

typedef unsigned long longPtr_t;
#endif

#define SPHSPCQUEUE_CIRCULAR (1)

#define SPHSPCQUEUE_CIRCULAR_WRAPED (1<<1)

#define SPHSPCQUEUE_CIRCULAR_NOTFIRST (1<<2)

#define SPHSPCQUEUE_CACHE_PREFETCH0 (1<<3)

#define SPHSPCQUEUE_CACHE_PREFETCH1 (1<<4)

#define SPHSPCQUEUE_CIRCULAR_RESETMASK (SPHSPCQUEUE_CIRCULAR | \
                SPHSPCQUEUE_CACHE_PREFETCH0 | \
                SPHSPCQUEUE_CACHE_PREFETCH1)

extern __C__ SPHSinglePCQueue_t
SPHSinglePCQueueInit (void *buf_seg , block_size_t buf_size);

extern __C__ SPHSinglePCQueue_t
SPHSinglePCQueueInitWithStride (void* buf_seg,  block_size_t buf_size,
                           unsigned short entry_stride,
                           unsigned int options);

extern __C__ SPHSinglePCQueue_t
SPHSinglePCQueueCreate (block_size_t buf_size);

extern __C__ SPHSinglePCQueue_t
SPHSinglePCQueueCreateWithStride (block_size_t buf_size,
                           unsigned short stride);

extern __C__ int
SPHSinglePCQueueGetStride (SPHSinglePCQueue_t queue);

extern __C__ void *
SPHSinglePCQueueAllocRaw (SPHSinglePCQueue_t queue);

extern __C__ SPHLFEntryHandle_t *
SPHSinglePCQueueAllocStrideEntry (SPHSinglePCQueue_t queue,
                                  int catcode, int subcode,
                                  SPHLFEntryHandle_t *handlespace);

extern __C__ SPHLFEntryHandle_t *
SPHSinglePCQueueAllocStrideTimeStamped (SPHSinglePCQueue_t queue,
                                   int catcode, int subcode,
                                   SPHLFEntryHandle_t *handlespace);

extern __C__ int
SPHSinglePCQueueEntryComplete (SPHLFEntryHandle_t *entryhandle);

extern __C__ int
SPHSinglePCQueueEntryIsComplete (SPHLFEntryHandle_t *entryhandle);

extern __C__ SPHLFEntryHandle_t*
SPHSinglePCQueueGetNextComplete (SPHSinglePCQueue_t queue,
                                 SPHLFEntryHandle_t *handlespace);

extern __C__ int
SPHSinglePCQueueFreeNextEntry (SPHSinglePCQueue_t queue);

extern __C__ int
SPHSinglePCQueueEmpty (SPHSinglePCQueue_t queue);

extern __C__ block_size_t
SPHSinglePCQueueFreeSpace (SPHSinglePCQueue_t queue);

extern __C__ int
SPHSinglePCQueueFull (SPHSinglePCQueue_t queue);


extern __C__ int
SPHSinglePCQueueResetAsync (SPHSinglePCQueue_t queue);

extern __C__ int
SPHSinglePCQueuePrefetch (SPHSinglePCQueue_t queue);

extern __C__ int
SPHSinglePCQueueSetCachePrefetch (SPHSinglePCQueue_t queue, int prefetch);

extern __C__ int 
SPHSinglePCQueueDestroy (SPHSinglePCQueue_t queue);

#endif /* __SPH_SINGLE_PC_QUEUE_H */