Added SILC Thread Queue API

[silc.git] / lib / silcutil / silcbuffer.h

diff --git a/lib/silcutil/silcbuffer.h b/lib/silcutil/silcbuffer.h
index 3a3db7b679ffc7283060054813544fc80e2b69a7..dc9d405cdb51ea3b0714179ab9261c2b1e16fed6 100644 (file)
--- a/lib/silcutil/silcbuffer.h
+++ b/lib/silcutil/silcbuffer.h
@@ -135,6 +135,21 @@ typedef struct SilcBufferObject {
 #define silc_buffer_data(x) (x)->data
 /***/
 
+/****f* silcutil/SilcBufferAPI/silc_buffer_tail
+ *
+ * NAME
+ *
+ *    unsigned char *silc_buffer_tail(SilcBuffer sb)
+ *
+ * DESCRIPTION
+ *
+ *    Returns pointer to the tail area of the buffer.
+ *
+ * SOURCE
+ */
+#define silc_buffer_tail(x) (x)->tail
+/***/
+
 /****f* silcutil/SilcBufferAPI/silc_buffer_datalen
  *
  * NAME
@@ -554,7 +569,7 @@ unsigned char *silc_buffer_pull(SilcBuffer sb, SilcUInt32 len)
  *    Pushes current data area towards beginning. Length of the currently
  *    valid data area is also incremented. Returns a pointer to the
  *    data area before pushing. Returns NULL if the push would lead to
- *    buffer underflow or would go under the valid data area.
+ *    go beyond the buffer boundaries or current data area.
  *
  * EXAMPLE
  *
@@ -582,7 +597,7 @@ unsigned char *silc_buffer_push(SilcBuffer sb, SilcUInt32 len)
   SILC_ASSERT((sb->data - len) >= sb->head);
 #endif /* SILC_DIST_INPLACE */
   if (silc_unlikely((sb->data - len) < sb->head)) {
-    silc_set_errno(SILC_ERR_UNDERFLOW);
+    silc_set_errno(SILC_ERR_OVERFLOW);
     return NULL;
   }
 
@@ -649,7 +664,7 @@ unsigned char *silc_buffer_pull_tail(SilcBuffer sb, SilcUInt32 len)
  *    Pushes current tail section towards beginning. Length of the current
  *    valid data area is also decremented. Returns a pointer to the
  *    tail section before pushing. Returns NULL if the push would lead to
- *    buffer underflow or go under valid tail area.
+ *    go beyond buffer boundaries or current tail area.
  *
  * EXAMPLE
  *
@@ -677,7 +692,7 @@ unsigned char *silc_buffer_push_tail(SilcBuffer sb, SilcUInt32 len)
   SILC_ASSERT((sb->tail - len) >= sb->data);
 #endif /* SILC_DIST_INPLACE */
   if (silc_unlikely((sb->tail - len) < sb->data)) {
-    silc_set_errno(SILC_ERR_UNDERFLOW);
+    silc_set_errno(SILC_ERR_OVERFLOW);
     return NULL;
   }
 
@@ -1116,10 +1131,15 @@ SilcBuffer silc_buffer_sclone(SilcStack stack, SilcBuffer sb)
  * DESCRIPTION
  *
  *    Reallocates buffer. Old data is saved into the new buffer. The buffer
- *    is exact clone of the old one except that there is now more space
+ *    is exact clone of the old one except that there is now more/less space
  *    at the end of buffer.  This always returns the same `sb' unless `sb'
  *    was NULL. Returns NULL if system is out of memory.
  *
+ *    If the `newsize' is shorter than the current buffer size, the data
+ *    and tail area of the buffer must be set to correct position before
+ *    calling this function so that buffer overflow would not occur when
+ *    the buffer size is reduced.
+ *
  ***/
 
 static inline
@@ -1131,7 +1151,7 @@ SilcBuffer silc_buffer_realloc(SilcBuffer sb, SilcUInt32 newsize)
   if (!sb)
     return silc_buffer_alloc(newsize);
 
-  if (silc_unlikely(newsize <= silc_buffer_truelen(sb)))
+  if (silc_unlikely(newsize == silc_buffer_truelen(sb)))
     return sb;
 
   hlen = silc_buffer_headlen(sb);
@@ -1158,8 +1178,14 @@ SilcBuffer silc_buffer_realloc(SilcBuffer sb, SilcUInt32 newsize)
  * DESCRIPTION
  *
  *    Reallocates buffer. Old data is saved into the new buffer. The buffer
- *    is exact clone of the old one except that there is now more space
- *    at the end of buffer.  Returns NULL if system is out of memory.
+ *    is exact clone of the old one except that there is now more/less space
+ *    at the end of buffer.  Returns NULL if system is out of memory.  This
+ *    always returns `sb' unless `sb' was NULL.
+ *
+ *    If the `newsize' is shorter than the current buffer size, the data
+ *    and tail area of the buffer must be set to correct position before
+ *    calling this function so that buffer overflow would not occur when
+ *    the buffer size is reduced.
  *
  *    This routine use SilcStack are memory source.  If `stack' is NULL
  *    reverts back to normal allocating routine.
@@ -1182,7 +1208,7 @@ SilcBuffer silc_buffer_srealloc(SilcStack stack,
   if (!sb)
     return silc_buffer_salloc(stack, newsize);
 
-  if (newsize <= silc_buffer_truelen(sb))
+  if (newsize == silc_buffer_truelen(sb))
     return sb;
 
   hlen = silc_buffer_headlen(sb);
@@ -1485,7 +1511,7 @@ unsigned char *silc_buffer_strchr(SilcBuffer sb, int c, SilcBool first)
   return NULL;
 }
 
-/****f* silcutil/SilcBufferAPI/silc_buffer_cmp
+/****f* silcutil/SilcBufferAPI/silc_buffer_equal
  *
  * SYNOPSIS
  *
@@ -1507,6 +1533,31 @@ SilcBool silc_buffer_equal(SilcBuffer sb1, SilcBuffer sb2)
   return memcmp(sb1->data, sb2->data, silc_buffer_len(sb1)) == 0;
 }
 
+/****f* silcutil/SilcBufferAPI/silc_buffer_memcmp
+ *
+ * SYNOPSIS
+ *
+ *    static inline
+ *    SilcBool silc_buffer_memcmp(SilcBuffer buffer,
+ *                                const unsigned char *data,
+ *                                SilcUInt32 data_len)
+ *
+ * DESCRIPTION
+ *
+ *    Compares the data area of the buffer with the `data'.  Returns TRUE
+ *    if the data area is identical to `data' or FALSE if they differ.
+ *
+ ***/
+
+static inline
+SilcBool silc_buffer_memcmp(SilcBuffer buffer, const unsigned char *data,
+                           SilcUInt32 data_len)
+{
+  if (silc_buffer_len(buffer) != data_len)
+    return FALSE;
+  return memcmp(buffer->data, data, data_len) == 0;
+}
+
 /****f* silcutil/SilcBufferAPI/silc_buffer_printf
  *
  * SYNOPSIS