tor  0.4.2.0-alpha-dev
Macros | Typedefs | Functions
buffers.h File Reference
#include "lib/cc/compat_compiler.h"
#include "lib/cc/torint.h"
#include "lib/testsupport/testsupport.h"
#include <stdarg.h>

Go to the source code of this file.

Macros

#define buf_free(b)   FREE_AND_NULL(buf_t, buf_free_, (b))
 
#define PEEK_BUF_STARTSWITH_MAX   16
 

Typedefs

typedef struct buf_t buf_t
 

Functions

buf_t * buf_new (void)
 
buf_t * buf_new_with_capacity (size_t size)
 
size_t buf_get_default_chunk_size (const buf_t *buf)
 
void buf_free_ (buf_t *buf)
 
void buf_clear (buf_t *buf)
 
buf_t * buf_copy (const buf_t *buf)
 
 MOCK_DECL (size_t, buf_datalen,(const buf_t *buf))
 
size_t buf_allocation (const buf_t *buf)
 
size_t buf_slack (const buf_t *buf)
 
uint32_t buf_get_oldest_chunk_timestamp (const buf_t *buf, uint32_t now)
 
size_t buf_get_total_allocation (void)
 
int buf_add (buf_t *buf, const char *string, size_t string_len)
 
void buf_add_string (buf_t *buf, const char *string)
 
void buf_add_printf (buf_t *buf, const char *format,...) CHECK_PRINTF(2
 
void void buf_add_vprintf (buf_t *buf, const char *format, va_list args) CHECK_PRINTF(2
 
void void int buf_move_to_buf (buf_t *buf_out, buf_t *buf_in, size_t *buf_flushlen)
 
void buf_move_all (buf_t *buf_out, buf_t *buf_in)
 
void buf_peek (const buf_t *buf, char *string, size_t string_len)
 
void buf_drain (buf_t *buf, size_t n)
 
int buf_get_bytes (buf_t *buf, char *string, size_t string_len)
 
int buf_get_line (buf_t *buf, char *data_out, size_t *data_len)
 
int buf_peek_startswith (const buf_t *buf, const char *cmd)
 
int buf_set_to_copy (buf_t **output, const buf_t *input)
 
void buf_assert_ok (buf_t *buf)
 
int buf_find_string_offset (const buf_t *buf, const char *s, size_t n)
 
void buf_pullup (buf_t *buf, size_t bytes, const char **head_out, size_t *len_out)
 
char * buf_extract (buf_t *buf, size_t *sz_out)
 

Detailed Description

Header file for buffers.c.

Definition in file buffers.h.

Function Documentation

◆ buf_add()

int buf_add ( buf_t *  buf,
const char *  string,
size_t  string_len 
)

Append string_len bytes from string to the end of buf.

Return the new length of the buffer on success, -1 on failure.

Definition at line 525 of file buffers.c.

Referenced by buf_add_string(), buf_add_vprintf(), MOCK_IMPL(), and process_write().

◆ buf_add_string()

void buf_add_string ( buf_t *  buf,
const char *  string 
)

Add a nul-terminated string to buf, not including the terminating NUL.

Definition at line 559 of file buffers.c.

References buf_add().

◆ buf_allocation()

size_t buf_allocation ( const buf_t *  buf)

Return the total length of all chunks used in buf.

Definition at line 399 of file buffers.c.

References CHUNK_ALLOC_SIZE.

◆ buf_assert_ok()

void buf_assert_ok ( buf_t *  buf)

Log an error and exit if buf is corrupted.

Definition at line 899 of file buffers.c.

References tor_assert().

◆ buf_clear()

void buf_clear ( buf_t *  buf)

Remove all data from buf.

Definition at line 379 of file buffers.c.

Referenced by buf_free_().

◆ buf_copy()

buf_t* buf_copy ( const buf_t *  buf)

Return a new copy of buf

Definition at line 451 of file buffers.c.

References buf_new(), and chunk_copy().

◆ buf_drain()

void buf_drain ( buf_t *  buf,
size_t  n 
)

Remove the first n bytes from buf.

Definition at line 328 of file buffers.c.

References tor_assert().

Referenced by flush_chunk_tls().

◆ buf_extract()

char* buf_extract ( buf_t *  buf,
size_t *  sz_out 
)

Return a heap-allocated string containing the contents of buf, plus a NUL byte. If sz_out is provided, set *sz_out to the length of the returned string, not including the terminating NUL.

Definition at line 589 of file buffers.c.

References tor_assert().

◆ buf_find_string_offset()

int buf_find_string_offset ( const buf_t *  buf,
const char *  s,
size_t  n 
)

Return the first position in buf at which the n-character string s occurs, or -1 if it does not occur.

Definition at line 804 of file buffers.c.

References buf_find_pos_of_char(), buf_matches_at_pos(), buf_pos_inc(), buf_pos_init(), buf_pos_t::chunk_pos, buf_pos_t::pos, and tor_assert().

◆ buf_free_()

void buf_free_ ( buf_t *  buf)

Release storage held by buf.

Definition at line 422 of file buffers.c.

References buf_clear(), and tor_free.

◆ buf_get_bytes()

int buf_get_bytes ( buf_t *  buf,
char *  string,
size_t  string_len 
)

Remove string_len bytes from the front of buf, and store them into string. Return the new buffer size. string_len must be <= the number of bytes on the buffer.

Definition at line 634 of file buffers.c.

Referenced by buf_get_line(), and connection_buf_get_bytes().

◆ buf_get_line()

int buf_get_line ( buf_t *  buf,
char *  data_out,
size_t *  data_len 
)

Try to read a single LF-terminated line from buf, and write it (including the LF), NUL-terminated, into the *data_len byte buffer at data_out. Set *data_len to the number of bytes in the line, not counting the terminating NUL. Return 1 if we read a whole line, return 0 if we don't have a whole line yet, and return -1 if the line length exceeds *data_len.

Definition at line 863 of file buffers.c.

References buf_find_offset_of_char(), and buf_get_bytes().

Referenced by connection_buf_get_line().

◆ buf_get_oldest_chunk_timestamp()

uint32_t buf_get_oldest_chunk_timestamp ( const buf_t *  buf,
uint32_t  now 
)

Return the age of the oldest chunk in the buffer buf, in timestamp units. Requires the current monotonic timestamp as its input now.

Definition at line 504 of file buffers.c.

Referenced by conn_get_buffer_age().

◆ buf_move_all()

void buf_move_all ( buf_t *  buf_out,
buf_t *  buf_in 
)

Moves all data from buf_in to buf_out, without copying.

Definition at line 687 of file buffers.c.

References tor_assert().

Referenced by connection_buf_add_buf().

◆ buf_move_to_buf()

void void int buf_move_to_buf ( buf_t *  buf_out,
buf_t *  buf_in,
size_t *  buf_flushlen 
)

Move up to *buf_flushlen bytes from buf_in to buf_out, and modify *buf_flushlen appropriately. Return the number of bytes actually copied.

Definition at line 654 of file buffers.c.

◆ buf_new()

buf_t* buf_new ( void  )

Allocate and return a new buffer with default capacity.

Definition at line 363 of file buffers.c.

Referenced by buf_copy(), and buf_new_with_capacity().

◆ buf_new_with_capacity()

buf_t* buf_new_with_capacity ( size_t  size)

Create and return a new buf with default chunk capacity size.

Definition at line 354 of file buffers.c.

References buf_new(), and buf_preferred_chunk_size().

◆ buf_peek()

void buf_peek ( const buf_t *  buf,
char *  string,
size_t  string_len 
)

Helper: copy the first string_len bytes from buf onto string.

Definition at line 607 of file buffers.c.

References tor_assert().

◆ buf_peek_startswith()

int buf_peek_startswith ( const buf_t *  buf,
const char *  cmd 
)

Return 1 iff buf starts with cmd. cmd must be a null terminated string, of no more than PEEK_BUF_STARTSWITH_MAX bytes.

Definition at line 823 of file buffers.c.

◆ buf_pullup()

void buf_pullup ( buf_t *  buf,
size_t  bytes,
const char **  head_out,
size_t *  len_out 
)

Collapse data from the first N chunks from buf into buf->head, growing it as necessary, until buf->head has the first bytes bytes of data from the buffer, or until buf->head has all the data in buf.

Set *head_out to point to the first byte of available data, and *len_out to the number of bytes of data available at *head_out. Note that *len_out may be more or less than bytes, depending on the number of bytes available.

Definition at line 209 of file buffers.c.

◆ buf_set_to_copy()

int buf_set_to_copy ( buf_t **  output,
const buf_t *  input 
)

Set *output to contain a copy of the data in *input

Definition at line 887 of file buffers.c.

◆ buf_slack()

size_t buf_slack ( const buf_t *  buf)

Return the number of bytes that can be added to buf without performing any additional allocation.

Definition at line 412 of file buffers.c.

Referenced by connection_buf_read_from_socket().