git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@5435 d0543943-73ff-0310-b7d9-9358b9ac24b2
This commit is contained in:
Anthony Minessale 2007-06-21 22:48:58 +00:00
parent 4e50738c22
commit 36ccf76a99
2 changed files with 146 additions and 156 deletions

View File

@ -71,16 +71,27 @@
* *
****************/ ****************/
#if defined(HAVE_LIBKERN_OSATOMIC_H) && (defined(__APPLE__) || defined(__FreeBSD__)) #if defined(__VIA_HACK__)
#define NO_BARRIER
#endif
#if defined(NO_BARRIER)
# define PaUtil_FullMemoryBarrier()
# define PaUtil_ReadMemoryBarrier()
# define PaUtil_WriteMemoryBarrier()
#else
#if defined(__APPLE__) //|| defined(__FreeBSD__)
# include <libkern/OSAtomic.h> # include <libkern/OSAtomic.h>
/* Here are the memory barrier functions. Mac OS X and FreeBSD only provide /* Here are the memory barrier functions. Mac OS X and FreeBSD only provide
full memory barriers, so the three types of barriers are the same. */ full memory barriers, so the three types of barriers are the same. */
# define PaUtil_FullMemoryBarrier() OSMemoryBarrier() # define PaUtil_FullMemoryBarrier() OSMemoryBarrier()
# define PaUtil_ReadMemoryBarrier() OSMemoryBarrier() # define PaUtil_ReadMemoryBarrier() OSMemoryBarrier()
# define PaUtil_WriteMemoryBarrier() OSMemoryBarrier() # define PaUtil_WriteMemoryBarrier() OSMemoryBarrier()
#elif defined(__GNUC__) #elif defined(__GNUC__)
/* GCC understands volatile __asm__ and "memory" to mean it
* should not reorder memory read/writes */ /* GCC understands volatile asm and "memory" to mean it
* should not reorder memory read/writes */
# if defined( __PPC__ ) # if defined( __PPC__ )
# define PaUtil_FullMemoryBarrier() __asm__ volatile("sync":::"memory") # define PaUtil_FullMemoryBarrier() __asm__ volatile("sync":::"memory")
# define PaUtil_ReadMemoryBarrier() __asm__ volatile("sync":::"memory") # define PaUtil_ReadMemoryBarrier() __asm__ volatile("sync":::"memory")
@ -90,63 +101,61 @@
# define PaUtil_ReadMemoryBarrier() __asm__ volatile("lfence":::"memory") # define PaUtil_ReadMemoryBarrier() __asm__ volatile("lfence":::"memory")
# define PaUtil_WriteMemoryBarrier() __asm__ volatile("sfence":::"memory") # define PaUtil_WriteMemoryBarrier() __asm__ volatile("sfence":::"memory")
# else # else
# ifdef ALLOW_SMP_DANGERS
# warning Memory barriers not defined on this system or system unknown
# warning For SMP safety, you should fix this.
# define PaUtil_FullMemoryBarrier()
# define PaUtil_ReadMemoryBarrier()
# define PaUtil_WriteMemoryBarrier()
# else
# error Memory barriers are not defined on this system. You can still compile by defining ALLOW_SMP_DANGERS, but SMP safety will not be guaranteed.
# endif
# endif
#else
# ifdef ALLOW_SMP_DANGERS
# warning Memory barriers not defined on this system or system unknown
# warning For SMP safety, you should fix this.
# define PaUtil_FullMemoryBarrier() # define PaUtil_FullMemoryBarrier()
# define PaUtil_ReadMemoryBarrier() # define PaUtil_ReadMemoryBarrier()
# define PaUtil_WriteMemoryBarrier() # define PaUtil_WriteMemoryBarrier()
# else
# error Memory barriers are not defined on this system. You can still compile by defining ALLOW_SMP_DANGERS, but SMP safety will not be guaranteed.
# endif # endif
#elif defined(_MSC_VER)
# include <intrin.h>
# pragma intrinsic(_ReadWriteBarrier)
# pragma intrinsic(_ReadBarrier)
# pragma intrinsic(_WriteBarrier)
# define PaUtil_FullMemoryBarrier() _ReadWriteBarrier()
# define PaUtil_ReadMemoryBarrier() _ReadBarrier()
# define PaUtil_WriteMemoryBarrier() _WriteBarrier()
#else
# define PaUtil_FullMemoryBarrier()
# define PaUtil_ReadMemoryBarrier()
# define PaUtil_WriteMemoryBarrier()
#endif
#endif #endif
/*************************************************************************** /***************************************************************************
* Initialize FIFO. * Initialize FIFO.
* numBytes must be power of 2, returns -1 if not. * numBytes must be power of 2, returns -1 if not.
*/ */
long PaUtil_InitializeRingBuffer( PaUtilRingBuffer *rbuf, long numBytes, void *dataPtr ) long PaUtil_InitializeRingBuffer(PaUtilRingBuffer * rbuf, long numBytes, void *dataPtr)
{ {
if( ((numBytes-1) & numBytes) != 0) return -1; /* Not Power of two. */ if (((numBytes - 1) & numBytes) != 0)
rbuf->bufferSize = numBytes; return -1; /* Not Power of two. */
rbuf->buffer = (char *)dataPtr; rbuf->bufferSize = numBytes;
PaUtil_FlushRingBuffer( rbuf ); rbuf->buffer = (char *) dataPtr;
rbuf->bigMask = (numBytes*2)-1; PaUtil_FlushRingBuffer(rbuf);
rbuf->smallMask = (numBytes)-1; rbuf->bigMask = (numBytes * 2) - 1;
return 0; rbuf->smallMask = (numBytes) - 1;
return 0;
} }
/*************************************************************************** /***************************************************************************
** Return number of bytes available for reading. */ ** Return number of bytes available for reading. */
long PaUtil_GetRingBufferReadAvailable( PaUtilRingBuffer *rbuf ) long PaUtil_GetRingBufferReadAvailable(PaUtilRingBuffer * rbuf)
{ {
PaUtil_ReadMemoryBarrier(); PaUtil_ReadMemoryBarrier();
return ( (rbuf->writeIndex - rbuf->readIndex) & rbuf->bigMask ); return ((rbuf->writeIndex - rbuf->readIndex) & rbuf->bigMask);
} }
/*************************************************************************** /***************************************************************************
** Return number of bytes available for writing. */ ** Return number of bytes available for writing. */
long PaUtil_GetRingBufferWriteAvailable( PaUtilRingBuffer *rbuf ) long PaUtil_GetRingBufferWriteAvailable(PaUtilRingBuffer * rbuf)
{ {
/* Since we are calling PaUtil_GetRingBufferReadAvailable, we don't need an aditional MB */ /* Since we are calling PaUtil_GetRingBufferReadAvailable, we don't need an aditional MB */
return ( rbuf->bufferSize - PaUtil_GetRingBufferReadAvailable(rbuf)); return (rbuf->bufferSize - PaUtil_GetRingBufferReadAvailable(rbuf));
} }
/*************************************************************************** /***************************************************************************
** Clear buffer. Should only be called when buffer is NOT being read. */ ** Clear buffer. Should only be called when buffer is NOT being read. */
void PaUtil_FlushRingBuffer( PaUtilRingBuffer *rbuf ) void PaUtil_FlushRingBuffer(PaUtilRingBuffer * rbuf)
{ {
rbuf->writeIndex = rbuf->readIndex = 0; rbuf->writeIndex = rbuf->readIndex = 0;
} }
/*************************************************************************** /***************************************************************************
@ -155,42 +164,38 @@ void PaUtil_FlushRingBuffer( PaUtilRingBuffer *rbuf )
** If non-contiguous, size2 will be the size of second region. ** If non-contiguous, size2 will be the size of second region.
** Returns room available to be written or numBytes, whichever is smaller. ** Returns room available to be written or numBytes, whichever is smaller.
*/ */
long PaUtil_GetRingBufferWriteRegions( PaUtilRingBuffer *rbuf, long numBytes, long PaUtil_GetRingBufferWriteRegions(PaUtilRingBuffer * rbuf, long numBytes, void **dataPtr1, long *sizePtr1, void **dataPtr2, long *sizePtr2)
void **dataPtr1, long *sizePtr1,
void **dataPtr2, long *sizePtr2 )
{ {
long index; long index;
long available = PaUtil_GetRingBufferWriteAvailable( rbuf ); long available = PaUtil_GetRingBufferWriteAvailable(rbuf);
if( numBytes > available ) numBytes = available; if (numBytes > available)
/* Check to see if write is not contiguous. */ numBytes = available;
index = rbuf->writeIndex & rbuf->smallMask; /* Check to see if write is not contiguous. */
if( (index + numBytes) > rbuf->bufferSize ) index = rbuf->writeIndex & rbuf->smallMask;
{ if ((index + numBytes) > rbuf->bufferSize) {
/* Write data in two blocks that wrap the buffer. */ /* Write data in two blocks that wrap the buffer. */
long firstHalf = rbuf->bufferSize - index; long firstHalf = rbuf->bufferSize - index;
*dataPtr1 = &rbuf->buffer[index]; *dataPtr1 = &rbuf->buffer[index];
*sizePtr1 = firstHalf; *sizePtr1 = firstHalf;
*dataPtr2 = &rbuf->buffer[0]; *dataPtr2 = &rbuf->buffer[0];
*sizePtr2 = numBytes - firstHalf; *sizePtr2 = numBytes - firstHalf;
} } else {
else *dataPtr1 = &rbuf->buffer[index];
{ *sizePtr1 = numBytes;
*dataPtr1 = &rbuf->buffer[index]; *dataPtr2 = NULL;
*sizePtr1 = numBytes; *sizePtr2 = 0;
*dataPtr2 = NULL; }
*sizePtr2 = 0; return numBytes;
}
return numBytes;
} }
/*************************************************************************** /***************************************************************************
*/ */
long PaUtil_AdvanceRingBufferWriteIndex( PaUtilRingBuffer *rbuf, long numBytes ) long PaUtil_AdvanceRingBufferWriteIndex(PaUtilRingBuffer * rbuf, long numBytes)
{ {
/* we need to ensure that previous writes are seen before we update the write index */ /* we need to ensure that previous writes are seen before we update the write index */
PaUtil_WriteMemoryBarrier(); PaUtil_WriteMemoryBarrier();
return rbuf->writeIndex = (rbuf->writeIndex + numBytes) & rbuf->bigMask; return rbuf->writeIndex = (rbuf->writeIndex + numBytes) & rbuf->bigMask;
} }
/*************************************************************************** /***************************************************************************
@ -199,81 +204,72 @@ long PaUtil_AdvanceRingBufferWriteIndex( PaUtilRingBuffer *rbuf, long numBytes )
** If non-contiguous, size2 will be the size of second region. ** If non-contiguous, size2 will be the size of second region.
** Returns room available to be written or numBytes, whichever is smaller. ** Returns room available to be written or numBytes, whichever is smaller.
*/ */
long PaUtil_GetRingBufferReadRegions( PaUtilRingBuffer *rbuf, long numBytes, long PaUtil_GetRingBufferReadRegions(PaUtilRingBuffer * rbuf, long numBytes, void **dataPtr1, long *sizePtr1, void **dataPtr2, long *sizePtr2)
void **dataPtr1, long *sizePtr1,
void **dataPtr2, long *sizePtr2 )
{ {
long index; long index;
long available = PaUtil_GetRingBufferReadAvailable( rbuf ); long available = PaUtil_GetRingBufferReadAvailable(rbuf);
if( numBytes > available ) numBytes = available; if (numBytes > available)
/* Check to see if read is not contiguous. */ numBytes = available;
index = rbuf->readIndex & rbuf->smallMask; /* Check to see if read is not contiguous. */
if( (index + numBytes) > rbuf->bufferSize ) index = rbuf->readIndex & rbuf->smallMask;
{ if ((index + numBytes) > rbuf->bufferSize) {
/* Write data in two blocks that wrap the buffer. */ /* Write data in two blocks that wrap the buffer. */
long firstHalf = rbuf->bufferSize - index; long firstHalf = rbuf->bufferSize - index;
*dataPtr1 = &rbuf->buffer[index]; *dataPtr1 = &rbuf->buffer[index];
*sizePtr1 = firstHalf; *sizePtr1 = firstHalf;
*dataPtr2 = &rbuf->buffer[0]; *dataPtr2 = &rbuf->buffer[0];
*sizePtr2 = numBytes - firstHalf; *sizePtr2 = numBytes - firstHalf;
} } else {
else *dataPtr1 = &rbuf->buffer[index];
{ *sizePtr1 = numBytes;
*dataPtr1 = &rbuf->buffer[index]; *dataPtr2 = NULL;
*sizePtr1 = numBytes; *sizePtr2 = 0;
*dataPtr2 = NULL; }
*sizePtr2 = 0; return numBytes;
}
return numBytes;
} }
/*************************************************************************** /***************************************************************************
*/ */
long PaUtil_AdvanceRingBufferReadIndex( PaUtilRingBuffer *rbuf, long numBytes ) long PaUtil_AdvanceRingBufferReadIndex(PaUtilRingBuffer * rbuf, long numBytes)
{ {
/* we need to ensure that previous writes are always seen before updating the index. */ /* we need to ensure that previous writes are always seen before updating the index. */
PaUtil_WriteMemoryBarrier(); PaUtil_WriteMemoryBarrier();
return rbuf->readIndex = (rbuf->readIndex + numBytes) & rbuf->bigMask; return rbuf->readIndex = (rbuf->readIndex + numBytes) & rbuf->bigMask;
} }
/*************************************************************************** /***************************************************************************
** Return bytes written. */ ** Return bytes written. */
long PaUtil_WriteRingBuffer( PaUtilRingBuffer *rbuf, const void *data, long numBytes ) long PaUtil_WriteRingBuffer(PaUtilRingBuffer * rbuf, const void *data, long numBytes)
{ {
long size1, size2, numWritten; long size1, size2, numWritten;
void *data1, *data2; void *data1, *data2;
numWritten = PaUtil_GetRingBufferWriteRegions( rbuf, numBytes, &data1, &size1, &data2, &size2 ); numWritten = PaUtil_GetRingBufferWriteRegions(rbuf, numBytes, &data1, &size1, &data2, &size2);
if( size2 > 0 ) if (size2 > 0) {
{
memcpy( data1, data, size1 ); memcpy(data1, data, size1);
data = ((char *)data) + size1; data = ((char *) data) + size1;
memcpy( data2, data, size2 ); memcpy(data2, data, size2);
} } else {
else memcpy(data1, data, size1);
{ }
memcpy( data1, data, size1 ); PaUtil_AdvanceRingBufferWriteIndex(rbuf, numWritten);
} return numWritten;
PaUtil_AdvanceRingBufferWriteIndex( rbuf, numWritten );
return numWritten;
} }
/*************************************************************************** /***************************************************************************
** Return bytes read. */ ** Return bytes read. */
long PaUtil_ReadRingBuffer( PaUtilRingBuffer *rbuf, void *data, long numBytes ) long PaUtil_ReadRingBuffer(PaUtilRingBuffer * rbuf, void *data, long numBytes)
{ {
long size1, size2, numRead; long size1, size2, numRead;
void *data1, *data2; void *data1, *data2;
numRead = PaUtil_GetRingBufferReadRegions( rbuf, numBytes, &data1, &size1, &data2, &size2 ); numRead = PaUtil_GetRingBufferReadRegions(rbuf, numBytes, &data1, &size1, &data2, &size2);
if( size2 > 0 ) if (size2 > 0) {
{ memcpy(data, data1, size1);
memcpy( data, data1, size1 ); data = ((char *) data) + size1;
data = ((char *)data) + size1; memcpy(data, data2, size2);
memcpy( data, data2, size2 ); } else {
} memcpy(data, data1, size1);
else }
{ PaUtil_AdvanceRingBufferReadIndex(rbuf, numRead);
memcpy( data, data1, size1 ); return numRead;
}
PaUtil_AdvanceRingBufferReadIndex( rbuf, numRead );
return numRead;
} }

View File

@ -51,19 +51,17 @@
*/ */
#ifdef __cplusplus #ifdef __cplusplus
extern "C" extern "C" {
{ #endif /* __cplusplus */
#endif /* __cplusplus */
typedef struct PaUtilRingBuffer typedef struct PaUtilRingBuffer {
{ long bufferSize; /* Number of bytes in FIFO. Power of 2. Set by PaUtil_InitRingBuffer. */
long bufferSize; /* Number of bytes in FIFO. Power of 2. Set by PaUtil_InitRingBuffer. */ long writeIndex; /* Index of next writable byte. Set by PaUtil_AdvanceRingBufferWriteIndex. */
long writeIndex; /* Index of next writable byte. Set by PaUtil_AdvanceRingBufferWriteIndex. */ long readIndex; /* Index of next readable byte. Set by PaUtil_AdvanceRingBufferReadIndex. */
long readIndex; /* Index of next readable byte. Set by PaUtil_AdvanceRingBufferReadIndex. */ long bigMask; /* Used for wrapping indices with extra bit to distinguish full/empty. */
long bigMask; /* Used for wrapping indices with extra bit to distinguish full/empty. */ long smallMask; /* Used for fitting indices to buffer. */
long smallMask; /* Used for fitting indices to buffer. */ char *buffer;
char *buffer; } PaUtilRingBuffer;
}PaUtilRingBuffer;
/** Initialize Ring Buffer. /** Initialize Ring Buffer.
@ -76,13 +74,13 @@ typedef struct PaUtilRingBuffer
@return -1 if numBytes is not a power of 2, otherwise 0. @return -1 if numBytes is not a power of 2, otherwise 0.
*/ */
long PaUtil_InitializeRingBuffer( PaUtilRingBuffer *rbuf, long numBytes, void *dataPtr ); long PaUtil_InitializeRingBuffer(PaUtilRingBuffer * rbuf, long numBytes, void *dataPtr);
/** Clear buffer. Should only be called when buffer is NOT being read. /** Clear buffer. Should only be called when buffer is NOT being read.
@param rbuf The ring buffer. @param rbuf The ring buffer.
*/ */
void PaUtil_FlushRingBuffer( PaUtilRingBuffer *rbuf ); void PaUtil_FlushRingBuffer(PaUtilRingBuffer * rbuf);
/** Retrieve the number of bytes available in the ring buffer for writing. /** Retrieve the number of bytes available in the ring buffer for writing.
@ -90,7 +88,7 @@ void PaUtil_FlushRingBuffer( PaUtilRingBuffer *rbuf );
@return The number of bytes available for writing. @return The number of bytes available for writing.
*/ */
long PaUtil_GetRingBufferWriteAvailable( PaUtilRingBuffer *rbuf ); long PaUtil_GetRingBufferWriteAvailable(PaUtilRingBuffer * rbuf);
/** Retrieve the number of bytes available in the ring buffer for reading. /** Retrieve the number of bytes available in the ring buffer for reading.
@ -98,7 +96,7 @@ long PaUtil_GetRingBufferWriteAvailable( PaUtilRingBuffer *rbuf );
@return The number of bytes available for reading. @return The number of bytes available for reading.
*/ */
long PaUtil_GetRingBufferReadAvailable( PaUtilRingBuffer *rbuf ); long PaUtil_GetRingBufferReadAvailable(PaUtilRingBuffer * rbuf);
/** Write data to the ring buffer. /** Write data to the ring buffer.
@ -110,7 +108,7 @@ long PaUtil_GetRingBufferReadAvailable( PaUtilRingBuffer *rbuf );
@return The number of bytes written. @return The number of bytes written.
*/ */
long PaUtil_WriteRingBuffer( PaUtilRingBuffer *rbuf, const void *data, long numBytes ); long PaUtil_WriteRingBuffer(PaUtilRingBuffer * rbuf, const void *data, long numBytes);
/** Read data from the ring buffer. /** Read data from the ring buffer.
@ -122,7 +120,7 @@ long PaUtil_WriteRingBuffer( PaUtilRingBuffer *rbuf, const void *data, long numB
@return The number of bytes read. @return The number of bytes read.
*/ */
long PaUtil_ReadRingBuffer( PaUtilRingBuffer *rbuf, void *data, long numBytes ); long PaUtil_ReadRingBuffer(PaUtilRingBuffer * rbuf, void *data, long numBytes);
/** Get address of region(s) to which we can write data. /** Get address of region(s) to which we can write data.
@ -144,9 +142,7 @@ long PaUtil_ReadRingBuffer( PaUtilRingBuffer *rbuf, void *data, long numBytes );
@return The room available to be written or numBytes, whichever is smaller. @return The room available to be written or numBytes, whichever is smaller.
*/ */
long PaUtil_GetRingBufferWriteRegions( PaUtilRingBuffer *rbuf, long numBytes, long PaUtil_GetRingBufferWriteRegions(PaUtilRingBuffer * rbuf, long numBytes, void **dataPtr1, long *sizePtr1, void **dataPtr2, long *sizePtr2);
void **dataPtr1, long *sizePtr1,
void **dataPtr2, long *sizePtr2 );
/** Advance the write index to the next location to be written. /** Advance the write index to the next location to be written.
@ -156,7 +152,7 @@ long PaUtil_GetRingBufferWriteRegions( PaUtilRingBuffer *rbuf, long numBytes,
@return The new position. @return The new position.
*/ */
long PaUtil_AdvanceRingBufferWriteIndex( PaUtilRingBuffer *rbuf, long numBytes ); long PaUtil_AdvanceRingBufferWriteIndex(PaUtilRingBuffer * rbuf, long numBytes);
/** Get address of region(s) from which we can write data. /** Get address of region(s) from which we can write data.
@ -178,9 +174,7 @@ long PaUtil_AdvanceRingBufferWriteIndex( PaUtilRingBuffer *rbuf, long numBytes )
@return The number of bytes available for reading. @return The number of bytes available for reading.
*/ */
long PaUtil_GetRingBufferReadRegions( PaUtilRingBuffer *rbuf, long numBytes, long PaUtil_GetRingBufferReadRegions(PaUtilRingBuffer * rbuf, long numBytes, void **dataPtr1, long *sizePtr1, void **dataPtr2, long *sizePtr2);
void **dataPtr1, long *sizePtr1,
void **dataPtr2, long *sizePtr2 );
/** Advance the read index to the next location to be read. /** Advance the read index to the next location to be read.
@ -190,9 +184,9 @@ long PaUtil_GetRingBufferReadRegions( PaUtilRingBuffer *rbuf, long numBytes,
@return The new position. @return The new position.
*/ */
long PaUtil_AdvanceRingBufferReadIndex( PaUtilRingBuffer *rbuf, long numBytes ); long PaUtil_AdvanceRingBufferReadIndex(PaUtilRingBuffer * rbuf, long numBytes);
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif /* __cplusplus */ #endif /* __cplusplus */
#endif /* PA_RINGBUFFER_H */ #endif /* PA_RINGBUFFER_H */