gnunet_buffer_lib.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GNUNET_Buffer
	Common buffer management functions. More...

Functions
void	GNUNET_buffer_prealloc (struct GNUNET_Buffer *buf, size_t capacity)
	Initialize a buffer with the given capacity. More...
void	GNUNET_buffer_ensure_remaining (struct GNUNET_Buffer *buf, size_t n)
	Make sure that at least n bytes remaining in the buffer. More...
void	GNUNET_buffer_write (struct GNUNET_Buffer *buf, const char *data, size_t len)
	Write bytes to the buffer. More...
void	GNUNET_buffer_write_str (struct GNUNET_Buffer *buf, const char *str)
	Write a 0-terminated string to a buffer, excluding the 0-terminator. More...
void	GNUNET_buffer_write_data_encoded (struct GNUNET_Buffer *buf, const void *data, size_t data_len)
	Write data encoded via GNUNET_STRINGS_data_to_string to the buffer. More...
void	GNUNET_buffer_write_path (struct GNUNET_Buffer *buf, const char *str)
	Write a path component to a buffer, ensuring that there is exactly one slash between the previous contents of the buffer and the new string. More...
void	GNUNET_buffer_write_fstr (struct GNUNET_Buffer *buf, const char *fmt,...) __attribute__((format(printf
	Write a 0-terminated formatted string to a buffer, excluding the 0-terminator. More...
void void	GNUNET_buffer_write_vfstr (struct GNUNET_Buffer *buf, const char *fmt, va_list args)
	Write a 0-terminated formatted string to a buffer, excluding the 0-terminator. More...
char *	GNUNET_buffer_reap_str (struct GNUNET_Buffer *buf)
	Clear the buffer and return the string it contained. More...
void *	GNUNET_buffer_reap (struct GNUNET_Buffer *buf, size_t *size)
	Clear the buffer and return its contents. More...
void	GNUNET_buffer_clear (struct GNUNET_Buffer *buf)
	Free the backing memory of the given buffer. More...

Function Documentation

GNUNET_buffer_prealloc()

void GNUNET_buffer_prealloc	(	struct GNUNET_Buffer *	buf,
		size_t	capacity
	)

Initialize a buffer with the given capacity.

When a buffer is allocated with this function, a warning is logged when the buffer exceeds the initial capacity.

Parameters

buf	the buffer to initialize
capacity	the capacity (in bytes) to allocate for buf

Definition at line 35 of file buffer.c.

References GNUNET_Buffer::capacity, GNUNET_assert, GNUNET_malloc, GNUNET_YES, GNUNET_Buffer::mem, GNUNET_Buffer::position, and GNUNET_Buffer::warn_grow.

{
  /* Buffer should be zero-initialized */
  GNUNET_assert (0 == buf->mem);
  GNUNET_assert (0 == buf->capacity);
  GNUNET_assert (0 == buf->position);
  buf->mem = GNUNET_malloc (capacity);
  buf->capacity = capacity;
  buf->warn_grow = GNUNET_YES;
}

GNUNET_buffer_ensure_remaining()

void GNUNET_buffer_ensure_remaining	(	struct GNUNET_Buffer *	buf,
		size_t	n
	)

Make sure that at least n bytes remaining in the buffer.

Parameters

buf	buffer to potentially grow
n	number of bytes that should be available to write

Definition at line 55 of file buffer.c.

References GNUNET_Buffer::capacity, GNUNET_assert, GNUNET_break, GNUNET_malloc, GNUNET_realloc, GNUNET_YES, GNUNET_Buffer::mem, GNUNET_Buffer::position, and GNUNET_Buffer::warn_grow.

Referenced by GNUNET_buffer_reap_str(), GNUNET_buffer_write(), GNUNET_buffer_write_data_encoded(), GNUNET_buffer_write_path(), and GNUNET_buffer_write_vfstr().

{
  size_t new_capacity = buf->position + n;

  /* guard against overflow */
  GNUNET_assert (new_capacity >= buf->position);
  if (new_capacity <= buf->capacity)
    return;
  /* warn if calculation of expected size was wrong */
  GNUNET_break (GNUNET_YES != buf->warn_grow);
  if (new_capacity < buf->capacity * 2)
    new_capacity = buf->capacity * 2;
  buf->capacity = new_capacity;
  if (NULL != buf->mem)
    buf->mem = GNUNET_realloc (buf->mem, new_capacity);
  else
    buf->mem = GNUNET_malloc (new_capacity);
}

Here is the caller graph for this function:

GNUNET_buffer_write()

void GNUNET_buffer_write	(	struct GNUNET_Buffer *	buf,
		const char *	data,
		size_t	len
	)

Write bytes to the buffer.

Grows the buffer if necessary.

Parameters

buf	buffer to write to
data	data to read from
len	number of bytes to copy from data to buf

Definition at line 86 of file buffer.c.

References GNUNET_buffer_ensure_remaining(), len, GNUNET_Buffer::mem, and GNUNET_Buffer::position.

Referenced by GNUNET_buffer_write_path(), GNUNET_buffer_write_str(), GNUNET_STRINGS_urlencode(), and write_to_buffer().

{
  GNUNET_buffer_ensure_remaining (buf, len);
  memcpy (buf->mem + buf->position, data, len);
  buf->position += len;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_buffer_write_str()

void GNUNET_buffer_write_str	(	struct GNUNET_Buffer *	buf,
		const char *	str
	)

Write a 0-terminated string to a buffer, excluding the 0-terminator.

Grows the buffer if necessary.

Parameters

buf	the buffer to write to
str	the string to write to buf
buf	the buffer to write to
str	the string to write to buf

Definition at line 103 of file buffer.c.

References GNUNET_buffer_write(), and len.

Referenced by login_redirect().

{
  size_t len = strlen (str);

  GNUNET_buffer_write (buf, str, len);
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_buffer_write_data_encoded()

void GNUNET_buffer_write_data_encoded	(	struct GNUNET_Buffer *	buf,
		const void *	data,
		size_t	data_len
	)

Write data encoded via GNUNET_STRINGS_data_to_string to the buffer.

Grows the buffer if necessary.

Parameters

buf	buffer to write to
data	data to read from
data_len	number of bytes to copy from data to buf

Definition at line 264 of file buffer.c.

References GNUNET_Buffer::capacity, GNUNET_assert, GNUNET_buffer_ensure_remaining(), GNUNET_STRINGS_data_to_string(), GNUNET_Buffer::mem, and GNUNET_Buffer::position.

{
  size_t outlen = data_len * 8;

  if (outlen % 5 > 0)
    outlen += 5 - outlen % 5;
  outlen /= 5;
  GNUNET_buffer_ensure_remaining (buf,
                                  outlen);
  GNUNET_assert (NULL !=
                 GNUNET_STRINGS_data_to_string (data,
                                                data_len,
                                                (buf->mem
                                                 + buf->position),
                                                outlen));
  buf->position += outlen;
  GNUNET_assert (buf->position <= buf->capacity);
}

Here is the call graph for this function:

GNUNET_buffer_write_path()

void GNUNET_buffer_write_path	(	struct GNUNET_Buffer *	buf,
		const char *	str
	)

Write a path component to a buffer, ensuring that there is exactly one slash between the previous contents of the buffer and the new string.

Parameters

buf	buffer to write to
str	string containing the new path component

Definition at line 180 of file buffer.c.

References GNUNET_buffer_ensure_remaining(), GNUNET_buffer_write(), len, GNUNET_Buffer::mem, and GNUNET_Buffer::position.

{
  size_t len = strlen (str);

  while ( (0 != len) && ('/' == str[0]) )
  {
    str++;
    len--;
  }
  if ( (0 == buf->position) || ('/' != buf->mem[buf->position - 1]) )
  {
    GNUNET_buffer_ensure_remaining (buf, 1);
    buf->mem[buf->position++] = '/';
  }
  GNUNET_buffer_write (buf, str, len);
}

Here is the call graph for this function:

GNUNET_buffer_write_fstr()

void GNUNET_buffer_write_fstr	(	struct GNUNET_Buffer *	buf,
		const char *	fmt,
			...
	)

Write a 0-terminated formatted string to a buffer, excluding the 0-terminator.

Grows the buffer if necessary.

Parameters

buf	the buffer to write to
fmt	format string
...	format arguments

Referenced by GNUNET_STRINGS_urlencode(), and login_redirect().

Here is the caller graph for this function:

GNUNET_buffer_write_vfstr()

void void GNUNET_buffer_write_vfstr	(	struct GNUNET_Buffer *	buf,
		const char *	fmt,
		va_list	args
	)

Write a 0-terminated formatted string to a buffer, excluding the 0-terminator.

Grows the buffer if necessary.

Parameters

buf	the buffer to write to
fmt	format string
args	format argument list

Definition at line 230 of file buffer.c.

References GNUNET_Buffer::capacity, GNUNET_assert, GNUNET_buffer_ensure_remaining(), GNUNET_Buffer::mem, GNUNET_Buffer::position, and res.

Referenced by GNUNET_buffer_write_fstr().

{
  int res;
  va_list args2;

  va_copy (args2, args);
  res = vsnprintf (NULL, 0, fmt, args2);
  va_end (args2);

  GNUNET_assert (res >= 0);
  GNUNET_buffer_ensure_remaining (buf, res + 1);

  va_copy (args2, args);
  res = vsnprintf (buf->mem + buf->position, res + 1, fmt, args2);
  va_end (args2);

  GNUNET_assert (res >= 0);
  buf->position += res;
  GNUNET_assert (buf->position <= buf->capacity);
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_buffer_reap_str()

char* GNUNET_buffer_reap_str

(

struct GNUNET_Buffer *

buf

)

Clear the buffer and return the string it contained.

The caller is responsible to eventually GNUNET_free the returned string.

The returned string is always 0-terminated.

Parameters

buf	the buffer to reap the string from

Returns

the buffer contained in the string

Definition at line 123 of file buffer.c.

References GNUNET_buffer_ensure_remaining(), GNUNET_Buffer::mem, GNUNET_Buffer::position, and res.

Referenced by GNUNET_STRINGS_urlencode(), and login_redirect().

{
  char *res;

  /* ensure 0-termination */
  if ( (0 == buf->position) || ('\0' != buf->mem[buf->position - 1]))
  {
    GNUNET_buffer_ensure_remaining (buf, 1);
    buf->mem[buf->position++] = '\0';
  }
  res = buf->mem;
  memset (buf, 0, sizeof (struct GNUNET_Buffer));
  return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_buffer_reap()

void* GNUNET_buffer_reap	(	struct GNUNET_Buffer *	buf,
		size_t *	size
	)

Clear the buffer and return its contents.

The caller is responsible to eventually GNUNET_free the returned data.

Parameters

buf	the buffer to reap the contents from
size	where to store the size of the returned data

Returns

the data contained in the string

Definition at line 149 of file buffer.c.

References GNUNET_Buffer::mem, GNUNET_Buffer::position, and res.

Referenced by GNUNET_BIO_get_buffer_contents().

{
  *size = buf->position;
  void *res = buf->mem;
  memset (buf, 0, sizeof (struct GNUNET_Buffer));
  return res;
}

Here is the caller graph for this function:

GNUNET_buffer_clear()

void GNUNET_buffer_clear

(

struct GNUNET_Buffer *

buf

)

Free the backing memory of the given buffer.

Does not free the memory of the buffer control structure, which is typically stack-allocated.

Definition at line 164 of file buffer.c.

References GNUNET_free, and GNUNET_Buffer::mem.

Referenced by GNUNET_BIO_write_close(), and GNUNET_STRINGS_urlencode().

{
  GNUNET_free (buf->mem);
  memset (buf, 0, sizeof (struct GNUNET_Buffer));
}

Here is the caller graph for this function: