mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-09-22 14:04:58 +02:00
a3e0a87d95
We previously used FILENAME_PRIVATE identifiers mostly for identifiers exposed only to the unit tests... but also for identifiers exposed to the benchmarker, and sometimes for identifiers exposed to a similar module, and occasionally for no really good reason at all. Now, we use FILENAME_PRIVATE identifiers for identifiers shared by Tor and the unit tests. They should be defined static when we aren't building the unit test, and globally visible otherwise. (The STATIC macro will keep us honest here.) For identifiers used only by the unit tests and never by Tor at all, on the other hand, we wrap them in #ifdef TOR_UNIT_TESTS. This is not the motivating use case for the split test/non-test build system; it's just a test example to see how it works, and to take a chance to clean up the code a little.
99 lines
3.9 KiB
C
99 lines
3.9 KiB
C
/* Copyright (c) 2001 Matej Pfajfar.
|
|
* Copyright (c) 2001-2004, Roger Dingledine.
|
|
* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
|
|
* Copyright (c) 2007-2013, The Tor Project, Inc. */
|
|
/* See LICENSE for licensing information */
|
|
|
|
/**
|
|
* \file buffers.h
|
|
* \brief Header file for buffers.c.
|
|
**/
|
|
|
|
#ifndef TOR_BUFFERS_H
|
|
#define TOR_BUFFERS_H
|
|
|
|
#include "testsupport.h"
|
|
|
|
buf_t *buf_new(void);
|
|
buf_t *buf_new_with_capacity(size_t size);
|
|
void buf_free(buf_t *buf);
|
|
void buf_clear(buf_t *buf);
|
|
buf_t *buf_copy(const buf_t *buf);
|
|
void buf_shrink(buf_t *buf);
|
|
void buf_shrink_freelists(int free_all);
|
|
void buf_dump_freelist_sizes(int severity);
|
|
|
|
size_t buf_datalen(const buf_t *buf);
|
|
size_t buf_allocation(const buf_t *buf);
|
|
size_t buf_slack(const buf_t *buf);
|
|
|
|
int read_to_buf(tor_socket_t s, size_t at_most, buf_t *buf, int *reached_eof,
|
|
int *socket_error);
|
|
int read_to_buf_tls(tor_tls_t *tls, size_t at_most, buf_t *buf);
|
|
|
|
int flush_buf(tor_socket_t s, buf_t *buf, size_t sz, size_t *buf_flushlen);
|
|
int flush_buf_tls(tor_tls_t *tls, buf_t *buf, size_t sz, size_t *buf_flushlen);
|
|
|
|
int write_to_buf(const char *string, size_t string_len, buf_t *buf);
|
|
int write_to_buf_zlib(buf_t *buf, tor_zlib_state_t *state,
|
|
const char *data, size_t data_len, int done);
|
|
int move_buf_to_buf(buf_t *buf_out, buf_t *buf_in, size_t *buf_flushlen);
|
|
int fetch_from_buf(char *string, size_t string_len, buf_t *buf);
|
|
int fetch_var_cell_from_buf(buf_t *buf, var_cell_t **out, int linkproto);
|
|
int fetch_from_buf_http(buf_t *buf,
|
|
char **headers_out, size_t max_headerlen,
|
|
char **body_out, size_t *body_used, size_t max_bodylen,
|
|
int force_complete);
|
|
socks_request_t *socks_request_new(void);
|
|
void socks_request_free(socks_request_t *req);
|
|
int fetch_from_buf_socks(buf_t *buf, socks_request_t *req,
|
|
int log_sockstype, int safe_socks);
|
|
int fetch_from_buf_socks_client(buf_t *buf, int state, char **reason);
|
|
int fetch_from_buf_line(buf_t *buf, char *data_out, size_t *data_len);
|
|
|
|
int peek_buf_has_control0_command(buf_t *buf);
|
|
|
|
#ifdef USE_BUFFEREVENTS
|
|
int fetch_var_cell_from_evbuffer(struct evbuffer *buf, var_cell_t **out,
|
|
int linkproto);
|
|
int fetch_from_evbuffer_socks(struct evbuffer *buf, socks_request_t *req,
|
|
int log_sockstype, int safe_socks);
|
|
int fetch_from_evbuffer_socks_client(struct evbuffer *buf, int state,
|
|
char **reason);
|
|
int fetch_from_evbuffer_http(struct evbuffer *buf,
|
|
char **headers_out, size_t max_headerlen,
|
|
char **body_out, size_t *body_used, size_t max_bodylen,
|
|
int force_complete);
|
|
int peek_evbuffer_has_control0_command(struct evbuffer *buf);
|
|
int write_to_evbuffer_zlib(struct evbuffer *buf, tor_zlib_state_t *state,
|
|
const char *data, size_t data_len,
|
|
int done);
|
|
#endif
|
|
|
|
#ifdef USE_BUFFEREVENTS
|
|
#define generic_buffer_new() evbuffer_new()
|
|
#define generic_buffer_len(b) evbuffer_get_length((b))
|
|
#define generic_buffer_add(b,dat,len) evbuffer_add((b),(dat),(len))
|
|
#define generic_buffer_get(b,buf,buflen) evbuffer_remove((b),(buf),(buflen))
|
|
#define generic_buffer_clear(b) evbuffer_drain((b), evbuffer_get_length((b)))
|
|
#define generic_buffer_free(b) evbuffer_free((b))
|
|
#else
|
|
#define generic_buffer_new() buf_new()
|
|
#define generic_buffer_len(b) buf_datalen((b))
|
|
#define generic_buffer_add(b,dat,len) write_to_buf((dat),(len),(b))
|
|
#define generic_buffer_get(b,buf,buflen) fetch_from_buf((buf),(buflen),(b))
|
|
#define generic_buffer_clear(b) buf_clear((b))
|
|
#define generic_buffer_free(b) buf_free((b))
|
|
#endif
|
|
int generic_buffer_set_to_copy(generic_buffer_t **output,
|
|
const generic_buffer_t *input);
|
|
|
|
void assert_buf_ok(buf_t *buf);
|
|
|
|
#ifdef BUFFERS_PRIVATE
|
|
STATIC int buf_find_string_offset(const buf_t *buf, const char *s, size_t n);
|
|
#endif
|
|
|
|
#endif
|
|
|