buffers.h 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. /* Copyright (c) 2001 Matej Pfajfar.
  2. * Copyright (c) 2001-2004, Roger Dingledine.
  3. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  4. * Copyright (c) 2007-2012, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7. * \file buffers.h
  8. * \brief Header file for buffers.c.
  9. **/
  10. #ifndef _TOR_BUFFERS_H
  11. #define _TOR_BUFFERS_H
  12. buf_t *buf_new(void);
  13. buf_t *buf_new_with_capacity(size_t size);
  14. void buf_free(buf_t *buf);
  15. void buf_clear(buf_t *buf);
  16. buf_t *buf_copy(const buf_t *buf);
  17. void buf_shrink(buf_t *buf);
  18. void buf_shrink_freelists(int free_all);
  19. void buf_dump_freelist_sizes(int severity);
  20. size_t buf_datalen(const buf_t *buf);
  21. size_t buf_allocation(const buf_t *buf);
  22. size_t buf_slack(const buf_t *buf);
  23. int read_to_buf(tor_socket_t s, size_t at_most, buf_t *buf, int *reached_eof,
  24. int *socket_error);
  25. int read_to_buf_tls(tor_tls_t *tls, size_t at_most, buf_t *buf);
  26. int flush_buf(tor_socket_t s, buf_t *buf, size_t sz, size_t *buf_flushlen);
  27. int flush_buf_tls(tor_tls_t *tls, buf_t *buf, size_t sz, size_t *buf_flushlen);
  28. int write_to_buf(const char *string, size_t string_len, buf_t *buf);
  29. int write_to_buf_zlib(buf_t *buf, tor_zlib_state_t *state,
  30. const char *data, size_t data_len, int done);
  31. int move_buf_to_buf(buf_t *buf_out, buf_t *buf_in, size_t *buf_flushlen);
  32. int fetch_from_buf(char *string, size_t string_len, buf_t *buf);
  33. int fetch_var_cell_from_buf(buf_t *buf, var_cell_t **out, int linkproto);
  34. int fetch_from_buf_http(buf_t *buf,
  35. char **headers_out, size_t max_headerlen,
  36. char **body_out, size_t *body_used, size_t max_bodylen,
  37. int force_complete);
  38. socks_request_t *socks_request_new(void);
  39. void socks_request_free(socks_request_t *req);
  40. int fetch_from_buf_socks(buf_t *buf, socks_request_t *req,
  41. int log_sockstype, int safe_socks);
  42. int fetch_from_buf_socks_client(buf_t *buf, int state, char **reason);
  43. int fetch_from_buf_line(buf_t *buf, char *data_out, size_t *data_len);
  44. int peek_buf_has_control0_command(buf_t *buf);
  45. #ifdef USE_BUFFEREVENTS
  46. int fetch_var_cell_from_evbuffer(struct evbuffer *buf, var_cell_t **out,
  47. int linkproto);
  48. int fetch_from_evbuffer_socks(struct evbuffer *buf, socks_request_t *req,
  49. int log_sockstype, int safe_socks);
  50. int fetch_from_evbuffer_socks_client(struct evbuffer *buf, int state,
  51. char **reason);
  52. int fetch_from_evbuffer_http(struct evbuffer *buf,
  53. char **headers_out, size_t max_headerlen,
  54. char **body_out, size_t *body_used, size_t max_bodylen,
  55. int force_complete);
  56. int peek_evbuffer_has_control0_command(struct evbuffer *buf);
  57. int write_to_evbuffer_zlib(struct evbuffer *buf, tor_zlib_state_t *state,
  58. const char *data, size_t data_len,
  59. int done);
  60. #endif
  61. #ifdef USE_BUFFEREVENTS
  62. #define generic_buffer_new() evbuffer_new()
  63. #define generic_buffer_len(b) evbuffer_get_length((b))
  64. #define generic_buffer_add(b,dat,len) evbuffer_add((b),(dat),(len))
  65. #define generic_buffer_get(b,buf,buflen) evbuffer_remove((b),(buf),(buflen))
  66. #define generic_buffer_clear(b) evbuffer_drain((b), evbuffer_get_length((b)))
  67. #define generic_buffer_free(b) evbuffer_free((b))
  68. #else
  69. #define generic_buffer_new() buf_new()
  70. #define generic_buffer_len(b) buf_datalen((b))
  71. #define generic_buffer_add(b,dat,len) write_to_buf((dat),(len),(b))
  72. #define generic_buffer_get(b,buf,buflen) fetch_from_buf((buf),(buflen),(b))
  73. #define generic_buffer_clear(b) buf_clear((b))
  74. #define generic_buffer_free(b) buf_free((b))
  75. #endif
  76. int generic_buffer_set_to_copy(generic_buffer_t **output,
  77. const generic_buffer_t *input);
  78. void assert_buf_ok(buf_t *buf);
  79. #ifdef BUFFERS_PRIVATE
  80. int buf_find_string_offset(const buf_t *buf, const char *s, size_t n);
  81. #endif
  82. #endif