/*
- silcbuffer.h
+ silcbuffer.h
- Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
+ Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 1998 - 2000 Pekka Riikonen
+ Copyright (C) 1998 - 2002 Pekka Riikonen
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
+ the Free Software Foundation; version 2 of the License.
+
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
*/
+/* $Id$ */
+/* Optimized buffer managing routines. These are short inline functions. */
#ifndef SILCBUFFER_H
#define SILCBUFFER_H
the allocated data area. Following short description of the fields
of the buffer.
- unsigned int truelen;
+ SilcUInt32 truelen;
True length of the buffer. This is set at the allocation of the
buffer and it should not be touched after that. This field should
be considered read-only.
- unsigned int len;
+ SilcUInt32 len;
Length of the currently valid data area. Tells the length of the
data at the buffer. This is set to zero at the allocation of the
Currently valid data area is considered to be the main data area in
the buffer. However, the entire buffer is of course valid data and can
be used as such. Usually head section of the buffer includes different
- kind of headers or similiar. Data section includes the main data of
+ kind of headers or similar. Data section includes the main data of
the buffer. Tail section can be seen as a reserve space of the data
section. Tail section can be pulled towards end thus the data section
becomes larger.
*/
-typedef struct SilcBufferStruct {
- unsigned int truelen;
- unsigned int len;
+typedef struct {
+ SilcUInt32 truelen;
+ SilcUInt32 len;
unsigned char *head;
unsigned char *data;
unsigned char *tail;
unsigned char *end;
-} SilcBufferObject;
-
-typedef SilcBufferObject *SilcBuffer;
+} *SilcBuffer, SilcBufferStruct;
/* Macros */
the buffer area to the end of the buffer. */
#define SILC_BUFFER_END(x) ((x)->end - (x)->head)
-#ifndef SILC_DEBUG /* When we are not doing debugging we use
- optimized inline buffer functions. */
-/*
- * Optimized buffer managing routines. These are short inline
- * functions.
- */
+/* Inline functions */
-extern inline
-SilcBuffer silc_buffer_alloc(unsigned int len)
+static inline
+SilcBuffer silc_buffer_alloc(SilcUInt32 len)
{
SilcBuffer sb;
- unsigned char *data;
/* Allocate new SilcBuffer */
- sb = silc_calloc(1, sizeof(*sb));
+ sb = (SilcBuffer)silc_calloc(1, sizeof(*sb));
/* Allocate the actual data area */
- data = silc_calloc(len, sizeof(*data));
- memset(data, 0, len);
+ sb->head = (unsigned char *)silc_calloc(len, sizeof(*sb->head));
/* Set pointers to the new buffer */
sb->truelen = len;
- sb->len = 0;
- sb->head = data;
- sb->data = data;
- sb->tail = data;
- sb->end = data + sb->truelen;
+ sb->data = sb->head;
+ sb->tail = sb->head;
+ sb->end = sb->head + sb->truelen;
return sb;
}
/* Free's a SilcBuffer */
-extern inline
+static inline
void silc_buffer_free(SilcBuffer sb)
{
if (sb) {
}
}
+/* Sets the `data' and `data_len' to the buffer pointer sent as argument.
+ The data area is automatically set to the `data_len'. This function
+ can be used to set the data to static buffer without needing any
+ memory allocations. The `data' will not be copied to the buffer. */
+
+static inline
+void silc_buffer_set(SilcBuffer sb, unsigned char *data, SilcUInt32 data_len)
+{
+ sb->data = sb->head = data;
+ sb->tail = sb->end = data + data_len;
+ sb->len = sb->truelen = data_len;
+}
+
/* 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.
^
*/
-extern inline
-unsigned char *silc_buffer_pull(SilcBuffer sb, unsigned int len)
+static inline
+unsigned char *silc_buffer_pull(SilcBuffer sb, SilcUInt32 len)
{
unsigned char *old_data = sb->data;
- assert(len <= (sb->tail - sb->data));
+#ifdef SILC_DEBUG
+ assert(len <= (SilcUInt32)(sb->tail - sb->data));
+#endif
sb->data += len;
sb->len -= len;
^
*/
-extern inline
-unsigned char *silc_buffer_push(SilcBuffer sb, unsigned int len)
+static inline
+unsigned char *silc_buffer_push(SilcBuffer sb, SilcUInt32 len)
{
unsigned char *old_data = sb->data;
+#ifdef SILC_DEBUG
assert((sb->data - len) >= sb->head);
+#endif
sb->data -= len;
sb->len += len;
^
*/
-extern inline
-unsigned char *silc_buffer_pull_tail(SilcBuffer sb, unsigned int len)
+static inline
+unsigned char *silc_buffer_pull_tail(SilcBuffer sb, SilcUInt32 len)
{
unsigned char *old_tail = sb->tail;
- assert((sb->end - sb->tail) >= len);
+#ifdef SILC_DEBUG
+ assert((SilcUInt32)(sb->end - sb->tail) >= len);
+#endif
sb->tail += len;
sb->len += len;
^
*/
-extern inline
-unsigned char *silc_buffer_push_tail(SilcBuffer sb, unsigned int len)
+static inline
+unsigned char *silc_buffer_push_tail(SilcBuffer sb, SilcUInt32 len)
{
unsigned char *old_tail = sb->tail;
+#ifdef SILC_DEBUG
assert((sb->tail - len) >= sb->data);
+#endif
sb->tail -= len;
sb->len -= len;
Puts data to the head section.
*/
-extern inline
+static inline
unsigned char *silc_buffer_put_head(SilcBuffer sb,
- unsigned char *data,
- unsigned int len)
+ const unsigned char *data,
+ SilcUInt32 len)
{
- assert((sb->data - sb->head) >= len);
- return memcpy(sb->head, data, len);
+#ifdef SILC_DEBUG
+ assert((SilcUInt32)(sb->data - sb->head) >= len);
+#endif
+ return (unsigned char *)memcpy(sb->head, data, len);
}
/* Puts data at the start of the valid data area. Returns a pointer
Puts data to the data section.
*/
-extern inline
+static inline
unsigned char *silc_buffer_put(SilcBuffer sb,
- unsigned char *data,
- unsigned int len)
+ const unsigned char *data,
+ SilcUInt32 len)
{
- assert((sb->tail - sb->data) >= len);
- return memcpy(sb->data, data, len);
+#ifdef SILC_DEBUG
+ assert((SilcUInt32)(sb->tail - sb->data) >= len);
+#endif
+ return (unsigned char *)memcpy(sb->data, data, len);
}
/* Puts data at the tail of the buffer. Returns pointer to the copied
Puts data to the tail section.
*/
-extern inline
+static inline
unsigned char *silc_buffer_put_tail(SilcBuffer sb,
- unsigned char *data,
- unsigned int len)
+ const unsigned char *data,
+ SilcUInt32 len)
{
- assert((sb->end - sb->tail) >= len);
- return memcpy(sb->tail, data, len);
+#ifdef SILC_DEBUG
+ assert((SilcUInt32)(sb->end - sb->tail) >= len);
+#endif
+ return (unsigned char *)memcpy(sb->tail, data, len);
}
-#endif /* !SILC_DEBUG */
+/* Clears and initialiazes the buffer to the state as if it was just
+ allocated by silc_buffer_alloc. */
-/* Prototypes */
-#ifdef SILC_DEBUG
-SilcBuffer silc_buffer_alloc(unsigned int len);
-void silc_buffer_free(SilcBuffer sb);
-unsigned char *silc_buffer_pull(SilcBuffer sb, unsigned int len);
-unsigned char *silc_buffer_push(SilcBuffer sb, unsigned int len);
-unsigned char *silc_buffer_pull_tail(SilcBuffer sb, unsigned int len);
-unsigned char *silc_buffer_push_tail(SilcBuffer sb, unsigned int len);
-unsigned char *silc_buffer_put_head(SilcBuffer sb,
- unsigned char *data,
- unsigned int len);
-unsigned char *silc_buffer_put(SilcBuffer sb,
- unsigned char *data,
- unsigned int len);
-unsigned char *silc_buffer_put_tail(SilcBuffer sb,
- unsigned char *data,
- unsigned int len);
-#endif
+static inline
+void silc_buffer_clear(SilcBuffer sb)
+{
+ memset(sb->head, 0, sb->truelen);
+ sb->data = sb->head;
+ sb->tail = sb->head;
+ sb->len = 0;
+}
+
+/* Generates copy of a SilcBuffer. This copies everything inside the
+ currently valid data area, nothing more. Use silc_buffer_clone to
+ copy entire buffer. */
+
+static inline
+SilcBuffer silc_buffer_copy(SilcBuffer sb)
+{
+ SilcBuffer sb_new;
+
+ sb_new = silc_buffer_alloc(sb->len);
+ silc_buffer_pull_tail(sb_new, SILC_BUFFER_END(sb_new));
+ silc_buffer_put(sb_new, sb->data, sb->len);
+
+ return sb_new;
+}
+
+/* Clones SilcBuffer. This generates new SilcBuffer and copies
+ everything from the source buffer. The result is exact clone of
+ the original buffer. */
+
+static inline
+SilcBuffer silc_buffer_clone(SilcBuffer sb)
+{
+ SilcBuffer sb_new;
+
+ sb_new = silc_buffer_alloc(sb->truelen);
+ silc_buffer_pull_tail(sb_new, SILC_BUFFER_END(sb_new));
+ silc_buffer_put(sb_new, sb->head, sb->truelen);
+ sb_new->data = sb_new->head + (sb->data - sb->head);
+ sb_new->tail = sb_new->data + sb->len;
+ sb_new->len = sb->len;
+
+ return sb_new;
+}
+
+/* Reallocates buffer. Old data is saved into the new buffer. Returns
+ new SilcBuffer pointer. The buffer is exact clone of the old one
+ except that there is now more space at the end of buffer. */
+
+static inline
+SilcBuffer silc_buffer_realloc(SilcBuffer sb, SilcUInt32 newsize)
+{
+ SilcBuffer sb_new;
+
+ if (!sb)
+ return silc_buffer_alloc(newsize);
+
+ if (newsize <= sb->truelen)
+ return sb;
+
+ sb_new = silc_buffer_alloc(newsize);
+ silc_buffer_pull_tail(sb_new, SILC_BUFFER_END(sb_new));
+ silc_buffer_put(sb_new, sb->head, sb->truelen);
+ sb_new->data = sb_new->head + (sb->data - sb->head);
+ sb_new->tail = sb_new->data + sb->len;
+ sb_new->len = sb->len;
+
+ silc_buffer_free(sb);
+
+ return sb_new;
+}
#endif
projects / silc.git / blobdiff