*
* DESCRIPTION
*
- * Allocates new SilcBuffer and returns it. Returns NULL on error.
+ * Allocates new SilcBuffer and returns it. Returns NULL if system is
+ * out of memory.
*
***/
*
* DESCRIPTION
*
- * Allocates new SilcBuffer and returns it.
+ * Allocates new SilcBuffer and returns it. Returns NULL if system is
+ * out of memory.
*
* This routine use SilcStack are memory source. If `stack' is NULL
* reverts back to normal allocating routine.
*
* Pulls current data area towards end. The length of the currently
* valid data area is also decremented. Returns pointer to the data
- * area before pulling. Returns NULL on error.
+ * area before pulling. Returns NULL if the pull would lead to buffer
+ * overflow or would go beyond the valid data area.
*
* EXAMPLE
*
unsigned char *silc_buffer_pull(SilcBuffer sb, SilcUInt32 len)
{
unsigned char *old_data = sb->data;
-#if defined(SILC_DEBUG)
+
+#ifdef SILC_DIST_INPLACE
SILC_ASSERT(len <= silc_buffer_len(sb));
-#else
- if (silc_unlikely(len > silc_buffer_len(sb)))
+#endif /* SILC_DIST_INPLACE */
+ if (silc_unlikely(len > silc_buffer_len(sb))) {
+ silc_set_errno(SILC_ERR_OVERFLOW);
return NULL;
-#endif
+ }
+
sb->data += len;
return old_data;
}
*
* 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 on error.
+ * data area before pushing. Returns NULL if the push would lead to
+ * buffer underflow or would go under the valid data area.
*
* EXAMPLE
*
unsigned char *silc_buffer_push(SilcBuffer sb, SilcUInt32 len)
{
unsigned char *old_data = sb->data;
-#if defined(SILC_DEBUG)
+
+#ifdef SILC_DIST_INPLACE
SILC_ASSERT((sb->data - len) >= sb->head);
-#else
- if (silc_unlikely((sb->data - len) < sb->head))
+#endif /* SILC_DIST_INPLACE */
+ if (silc_unlikely((sb->data - len) < sb->head)) {
+ silc_set_errno(SILC_ERR_UNDERFLOW);
return NULL;
-#endif
+ }
+
sb->data -= len;
return old_data;
}
*
* Pulls current tail section towards end. Length of the current valid
* data area is also incremented. Returns a pointer to the data area
- * before pulling. Returns NULL on error.
+ * before pulling. Returns NULL if the pull would lead to buffer overflow.
*
* EXAMPLE
*
unsigned char *silc_buffer_pull_tail(SilcBuffer sb, SilcUInt32 len)
{
unsigned char *old_tail = sb->tail;
-#if defined(SILC_DEBUG)
+
+#ifdef SILC_DIST_INPLACE
SILC_ASSERT(len <= silc_buffer_taillen(sb));
-#else
- if (silc_unlikely(len > silc_buffer_taillen(sb)))
+#endif /* SILC_DIST_INPLACE */
+ if (silc_unlikely(len > silc_buffer_taillen(sb))) {
+ silc_set_errno(SILC_ERR_OVERFLOW);
return NULL;
-#endif
+ }
+
sb->tail += len;
return old_tail;
}
*
* 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 on error.
+ * tail section before pushing. Returns NULL if the push would lead to
+ * buffer underflow or go under valid tail area.
*
* EXAMPLE
*
unsigned char *silc_buffer_push_tail(SilcBuffer sb, SilcUInt32 len)
{
unsigned char *old_tail = sb->tail;
-#if defined(SILC_DEBUG)
+
+#ifdef SILC_DIST_INPLACE
SILC_ASSERT((sb->tail - len) >= sb->data);
-#else
- if (silc_unlikely((sb->tail - len) < sb->data))
+#endif /* SILC_DIST_INPLACE */
+ if (silc_unlikely((sb->tail - len) < sb->data)) {
+ silc_set_errno(SILC_ERR_UNDERFLOW);
return NULL;
-#endif
+ }
+
sb->tail -= len;
return old_tail;
}
* DESCRIPTION
*
* Puts data at the head of the buffer. Returns pointer to the copied
- * data area. Returns NULL on error.
+ * data area. Returns NULL if the data is longer that the current head
+ * area.
*
* EXAMPLE
*
const unsigned char *data,
SilcUInt32 len)
{
-#if defined(SILC_DEBUG)
+#ifdef SILC_DIST_INPLACE
SILC_ASSERT(len <= silc_buffer_headlen(sb));
-#else
- if (silc_unlikely(len > silc_buffer_headlen(sb)))
+#endif /* SILC_DIST_INPLACE */
+ if (silc_unlikely(len > silc_buffer_headlen(sb))) {
+ silc_set_errno(SILC_ERR_OVERFLOW);
return NULL;
-#endif
+ }
+
return (unsigned char *)memcpy(sb->head, data, len);
}
* DESCRIPTION
*
* Puts data at the start of the valid data area. Returns a pointer
- * to the copied data area. Returns NULL on error.
+ * to the copied data area. Returns NULL if the data is longer than the
+ * current data area.
*
* EXAMPLE
*
const unsigned char *data,
SilcUInt32 len)
{
-#if defined(SILC_DEBUG)
+#ifdef SILC_DIST_INPLACE
SILC_ASSERT(len <= silc_buffer_len(sb));
-#else
- if (silc_unlikely(len > silc_buffer_len(sb)))
+#endif /* SILC_DIST_INPLACE */
+ if (silc_unlikely(len > silc_buffer_len(sb))) {
+ silc_set_errno(SILC_ERR_OVERFLOW);
return NULL;
-#endif
+ }
+
return (unsigned char *)memcpy(sb->data, data, len);
}
* DESCRIPTION
*
* Puts data at the tail of the buffer. Returns pointer to the copied
- * data area. Returns NULL on error.
+ * data area. Returns NULL if the data is longer than the current tail
+ * area.
*
* EXAMPLE
*
const unsigned char *data,
SilcUInt32 len)
{
-#if defined(SILC_DEBUG)
+#ifdef SILC_DIST_INPLACE
SILC_ASSERT(len <= silc_buffer_taillen(sb));
-#else
- if (silc_unlikely(len > silc_buffer_taillen(sb)))
+#endif /* SILC_DIST_INPLACE */
+ if (silc_unlikely(len > silc_buffer_taillen(sb))) {
+ silc_set_errno(SILC_ERR_OVERFLOW);
return NULL;
-#endif
+ }
+
return (unsigned char *)memcpy(sb->tail, data, len);
}
*
* Allocates `len' bytes size buffer and moves the tail area automatically
* `len' bytes so that the buffer is ready to use without calling the
- * silc_buffer_pull_tail. Returns NULL on error.
+ * silc_buffer_pull_tail. Returns NULL if system is out of memory.
*
***/
*
* Allocates `len' bytes size buffer and moves the tail area automatically
* `len' bytes so that the buffer is ready to use without calling the
- * silc_buffer_pull_tail.
+ * silc_buffer_pull_tail. Returns NULL if system is out of memory.
*
* This routine use SilcStack are memory source. If `stack' is NULL
* reverts back to normal allocating routine.
*
* Generates copy of a SilcBuffer. This copies everything inside the
* currently valid data area, nothing more. Use silc_buffer_clone to
- * copy entire buffer. Returns NULL on error.
+ * copy entire buffer. Returns NULL if system is out of memory.
*
***/
*
* Generates copy of a SilcBuffer. This copies everything inside the
* currently valid data area, nothing more. Use silc_buffer_clone to
- * copy entire buffer.
+ * copy entire buffer. Returns NULL if system is out of memory.
*
* This routine use SilcStack are memory source. If `stack' is NULL
* reverts back to normal allocating routine.
*
* Clones SilcBuffer. This generates new SilcBuffer and copies
* everything from the source buffer. The result is exact clone of
- * the original buffer. Returns NULL on error.
+ * the original buffer. Returns NULL if system is out of memory.
*
***/
*
* Clones SilcBuffer. This generates new SilcBuffer and copies
* everything from the source buffer. The result is exact clone of
- * the original buffer.
+ * the original buffer. Returns NULL if system is out of memory.
*
* This routine use SilcStack are memory source. If `stack' is NULL
* reverts back to normal allocating routine.
* 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. This always returns the same `sb' unless `sb'
- * was NULL. Returns NULL on error.
+ * was NULL. Returns NULL if system is out of memory.
*
***/
*
* 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.
+ * at the end of buffer. Returns NULL if system is out of memory.
*
* This routine use SilcStack are memory source. If `stack' is NULL
* reverts back to normal allocating routine.
*
* Same as silc_buffer_realloc but moves moves the tail area
* automatically so that the buffer is ready to use without calling the
- * silc_buffer_pull_tail. Returns NULL on error.
+ * silc_buffer_pull_tail. Returns NULL if system is out of memory.
*
***/
*
* Same as silc_buffer_srealloc but moves moves the tail area
* automatically so that the buffer is ready to use without calling the
- * silc_buffer_pull_tail.
+ * silc_buffer_pull_tail. Returns NULL if system is out of memory.
*
* This routine use SilcStack are memory source. If `stack' is NULL
* reverts back to normal allocating routine.
* is at least the size of `size'. If there is more space than `size'
* in the data area this does not do anything. If there is enough
* space in the tail area this merely moves the tail area to reveal
- * the extra space. Returns FALSE on error.
+ * the extra space. Returns FALSE if system is out of memory.
*
***/
* is at least the size of `size'. If there is more space than `size'
* in the data area this does not do anything. If there is enough
* space in the tail area this merely moves the tail area to reveal
- * the extra space. Returns FALSE on error.
+ * the extra space. Returns FALSE if system is out of memory.
*
* This routine use SilcStack are memory source. If `stack' is NULL
* reverts back to normal allocating routine.
return TRUE;
}
+/****f* silcutil/SilcBufferAPI/silc_buffer_strchr
+ *
+ * SYNOPSIS
+ *
+ * static inline
+ * unsigned char *silc_buffer_strchr(SilcBuffer sb, int c, SilcBool first);
+ *
+ * DESCRIPTION
+ *
+ * Returns pointer to the occurence of the character `c' in the buffer
+ * `sb'. If the `first' is TRUE this finds the first occurene of `c',
+ * if it is FALSE this finds the last occurence of `c'. If the character
+ * is found the `sb' data area is moved to that location and its pointer
+ * is returned. The silc_buffer_data call will return the same pointer.
+ * Returns NULL if such character could not be located and the buffer
+ * remains unmodified.
+ *
+ * This call is equivalent to strchr(), strrchr(), memchr() and memrchr()
+ * except it works with SilcBuffer.
+ *
+ * NOTES
+ *
+ * This searches only the data area of the buffer. Head and tail area
+ * are not searched.
+ *
+ * The `sb' data need not be NULL terminated.
+ *
+ ***/
+
+static inline
+unsigned char *silc_buffer_strchr(SilcBuffer sb, int c, SilcBool first)
+{
+ int i;
+
+ if (first) {
+ for (i = 0; i < silc_buffer_len(sb); i++) {
+ if (sb->data[i] == (unsigned char)c) {
+ sb->data = &sb->data[i];
+ return sb->data;
+ }
+ }
+ } else {
+ for (i = silc_buffer_len(sb) - 1; 1 >= 0; i--) {
+ if (sb->data[i] == (unsigned char)c) {
+ sb->data = &sb->data[i];
+ return sb->data;
+ }
+ }
+ }
+
+ return NULL;
+}
+
#endif /* SILCBUFFER_H */
projects / crypto.git / blobdiff