mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-11-11 13:43:47 +01:00
294 lines
12 KiB
C
294 lines
12 KiB
C
/* Copyright (c) 2003-2004, Roger Dingledine
|
|
* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
|
|
* Copyright (c) 2007-2008, The Tor Project, Inc. */
|
|
/* See LICENSE for licensing information */
|
|
/* $Id$ */
|
|
|
|
/**
|
|
* \file util.h
|
|
* \brief Headers for util.c
|
|
**/
|
|
|
|
#ifndef __UTIL_H
|
|
#define __UTIL_H
|
|
#define UTIL_H_ID "$Id$"
|
|
|
|
#include "orconfig.h"
|
|
#include "torint.h"
|
|
#include "compat.h"
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
|
|
#ifndef O_BINARY
|
|
#define O_BINARY 0
|
|
#endif
|
|
#ifndef O_TEXT
|
|
#define O_TEXT 0
|
|
#endif
|
|
|
|
/* Replace assert() with a variant that sends failures to the log before
|
|
* calling assert() normally.
|
|
*/
|
|
#ifdef NDEBUG
|
|
/* Nobody should ever want to build with NDEBUG set. 99% of our asserts will
|
|
* be outside the critical path anyway, so it's silly to disable bugchecking
|
|
* throughout the entire program just because a few asserts are slowing you
|
|
* down. Profile, optimize the critical path, and keep debugging on.
|
|
*
|
|
* And I'm not just saying that because some of our asserts check
|
|
* security-critical properties.
|
|
*/
|
|
#error "Sorry; we don't support building with NDEBUG."
|
|
#endif
|
|
|
|
/** Like assert(3), but send assertion failures to the log as well as to
|
|
* stderr. */
|
|
#define tor_assert(expr) STMT_BEGIN \
|
|
if (PREDICT_UNLIKELY(!(expr))) { \
|
|
log(LOG_ERR, LD_BUG, "%s:%d: %s: Assertion %s failed; aborting.", \
|
|
_SHORT_FILE_, __LINE__, __func__, #expr); \
|
|
fprintf(stderr,"%s:%d %s: Assertion %s failed; aborting.\n", \
|
|
_SHORT_FILE_, __LINE__, __func__, #expr); \
|
|
abort(); \
|
|
} STMT_END
|
|
|
|
/* If we're building with dmalloc, we want all of our memory allocation
|
|
* functions to take an extra file/line pair of arguments. If not, not.
|
|
* We define DMALLOC_PARAMS to the extra parameters to insert in the
|
|
* function prototypes, and DMALLOC_ARGS to the extra arguments to add
|
|
* to calls. */
|
|
#ifdef USE_DMALLOC
|
|
#define DMALLOC_PARAMS , const char *file, const int line
|
|
#define DMALLOC_ARGS , _SHORT_FILE_, __LINE__
|
|
#else
|
|
#define DMALLOC_PARAMS
|
|
#define DMALLOC_ARGS
|
|
#endif
|
|
|
|
/** Define this if you want Tor to crash when any problem comes up,
|
|
* so you can get a coredump and track things down. */
|
|
// #define tor_fragile_assert() tor_assert(0)
|
|
#define tor_fragile_assert()
|
|
|
|
/* Memory management */
|
|
void *_tor_malloc(size_t size DMALLOC_PARAMS) ATTR_MALLOC;
|
|
void *_tor_malloc_zero(size_t size DMALLOC_PARAMS) ATTR_MALLOC;
|
|
void *_tor_malloc_roundup(size_t *size DMALLOC_PARAMS) ATTR_MALLOC;
|
|
void *_tor_realloc(void *ptr, size_t size DMALLOC_PARAMS);
|
|
char *_tor_strdup(const char *s DMALLOC_PARAMS) ATTR_MALLOC ATTR_NONNULL((1));
|
|
char *_tor_strndup(const char *s, size_t n DMALLOC_PARAMS)
|
|
ATTR_MALLOC ATTR_NONNULL((1));
|
|
void *_tor_memdup(const void *mem, size_t len DMALLOC_PARAMS)
|
|
ATTR_MALLOC ATTR_NONNULL((1));
|
|
void _tor_free(void *mem);
|
|
#ifdef USE_DMALLOC
|
|
extern int dmalloc_free(const char *file, const int line, void *pnt,
|
|
const int func_id);
|
|
#define tor_free(p) STMT_BEGIN \
|
|
if (PREDICT_LIKELY((p)!=NULL)) { \
|
|
dmalloc_free(_SHORT_FILE_, __LINE__, (p), 0); \
|
|
(p)=NULL; \
|
|
} \
|
|
STMT_END
|
|
#else
|
|
/** Release memory allocated by tor_malloc, tor_realloc, tor_strdup, etc.
|
|
* Unlike the free() function, tor_free() will still work on NULL pointers,
|
|
* and it sets the pointer value to NULL after freeing it.
|
|
*
|
|
* This is a macro. If you need a function pointer to release memory from
|
|
* tor_malloc(), use _tor_free().
|
|
*/
|
|
#define tor_free(p) STMT_BEGIN \
|
|
if (PREDICT_LIKELY((p)!=NULL)) { \
|
|
free(p); \
|
|
(p)=NULL; \
|
|
} \
|
|
STMT_END
|
|
#endif
|
|
|
|
#define tor_malloc(size) _tor_malloc(size DMALLOC_ARGS)
|
|
#define tor_malloc_zero(size) _tor_malloc_zero(size DMALLOC_ARGS)
|
|
#define tor_malloc_roundup(szp) _tor_malloc_roundup(szp DMALLOC_ARGS)
|
|
#define tor_realloc(ptr, size) _tor_realloc(ptr, size DMALLOC_ARGS)
|
|
#define tor_strdup(s) _tor_strdup(s DMALLOC_ARGS)
|
|
#define tor_strndup(s, n) _tor_strndup(s, n DMALLOC_ARGS)
|
|
#define tor_memdup(s, n) _tor_memdup(s, n DMALLOC_ARGS)
|
|
|
|
void tor_log_mallinfo(int severity);
|
|
|
|
/** Return the offset of <b>member</b> within the type <b>tp</b>, in bytes */
|
|
#if defined(__GNUC__) && __GNUC__ > 3
|
|
#define STRUCT_OFFSET(tp, member) __builtin_offsetof(tp, member)
|
|
#else
|
|
#define STRUCT_OFFSET(tp, member) \
|
|
((off_t) (((char*)&((tp*)0)->member)-(char*)0))
|
|
#endif
|
|
|
|
/** Macro: yield a pointer to the field at position <b>off</b> within the
|
|
* structure <b>st</b>. Example:
|
|
* <pre>
|
|
* struct a { int foo; int bar; } x;
|
|
* off_t bar_offset = STRUCT_OFFSET(struct a, bar);
|
|
* int *bar_p = STRUCT_VAR_P(&x, bar_offset);
|
|
* *bar_p = 3;
|
|
* </pre>
|
|
*/
|
|
#define STRUCT_VAR_P(st, off) ((void*) ( ((char*)(st)) + (off) ) )
|
|
|
|
/** Macro: yield a pointer to an enclosing structure given a pointer to
|
|
* a substructure at offset <b>off</b>. Example:
|
|
* <pre>
|
|
* struct base { ... };
|
|
* struct subtype { int x; struct base b; } x;
|
|
* struct base *bp = &x.base;
|
|
* struct *sp = SUBTYPE_P(bp, struct subtype, b);
|
|
* </pre>
|
|
*/
|
|
#define SUBTYPE_P(p, subtype, basemember) \
|
|
((void*) ( ((char*)(p)) - STRUCT_OFFSET(subtype, basemember) ))
|
|
|
|
/* Logic */
|
|
/** Macro: true if two values have the same boolean value. */
|
|
#define bool_eq(a,b) (!(a)==!(b))
|
|
/** Macro: true if two values have different boolean values. */
|
|
#define bool_neq(a,b) (!(a)!=!(b))
|
|
|
|
/* Math functions */
|
|
int tor_log2(uint64_t u64) ATTR_CONST;
|
|
uint64_t round_to_power_of_2(uint64_t u64);
|
|
|
|
/* String manipulation */
|
|
|
|
/** Allowable characters in a hexadecimal string. */
|
|
#define HEX_CHARACTERS "0123456789ABCDEFabcdef"
|
|
void tor_strlower(char *s) ATTR_NONNULL((1));
|
|
void tor_strupper(char *s) ATTR_NONNULL((1));
|
|
int tor_strisprint(const char *s) ATTR_PURE ATTR_NONNULL((1));
|
|
int tor_strisnonupper(const char *s) ATTR_PURE ATTR_NONNULL((1));
|
|
int strcmpstart(const char *s1, const char *s2) ATTR_PURE ATTR_NONNULL((1,2));
|
|
int strcmp_len(const char *s1, const char *s2, size_t len)
|
|
ATTR_PURE ATTR_NONNULL((1,2));
|
|
int strcasecmpstart(const char *s1, const char *s2)
|
|
ATTR_PURE ATTR_NONNULL((1,2));
|
|
int strcmpend(const char *s1, const char *s2) ATTR_PURE ATTR_NONNULL((1,2));
|
|
int strcasecmpend(const char *s1, const char *s2)
|
|
ATTR_PURE ATTR_NONNULL((1,2));
|
|
int memcmpstart(const void *mem, size_t memlen,
|
|
const char *prefix) ATTR_PURE;
|
|
|
|
void tor_strstrip(char *s, const char *strip) ATTR_NONNULL((1,2));
|
|
long tor_parse_long(const char *s, int base, long min,
|
|
long max, int *ok, char **next);
|
|
unsigned long tor_parse_ulong(const char *s, int base, unsigned long min,
|
|
unsigned long max, int *ok, char **next);
|
|
uint64_t tor_parse_uint64(const char *s, int base, uint64_t min,
|
|
uint64_t max, int *ok, char **next);
|
|
const char *hex_str(const char *from, size_t fromlen) ATTR_NONNULL((1));
|
|
const char *eat_whitespace(const char *s) ATTR_PURE;
|
|
const char *eat_whitespace_eos(const char *s, const char *eos) ATTR_PURE;
|
|
const char *eat_whitespace_no_nl(const char *s) ATTR_PURE;
|
|
const char *eat_whitespace_eos_no_nl(const char *s, const char *eos) ATTR_PURE;
|
|
const char *find_whitespace(const char *s) ATTR_PURE;
|
|
const char *find_whitespace_eos(const char *s, const char *eos) ATTR_PURE;
|
|
int tor_mem_is_zero(const char *mem, size_t len) ATTR_PURE;
|
|
int tor_digest_is_zero(const char *digest) ATTR_PURE;
|
|
char *esc_for_log(const char *string) ATTR_MALLOC;
|
|
const char *escaped(const char *string);
|
|
struct smartlist_t;
|
|
void wrap_string(struct smartlist_t *out, const char *string, size_t width,
|
|
const char *prefix0, const char *prefixRest);
|
|
|
|
void base16_encode(char *dest, size_t destlen, const char *src, size_t srclen);
|
|
int base16_decode(char *dest, size_t destlen, const char *src, size_t srclen);
|
|
|
|
/* Time helpers */
|
|
long tv_udiff(const struct timeval *start, const struct timeval *end);
|
|
time_t tor_timegm(struct tm *tm);
|
|
#define RFC1123_TIME_LEN 29
|
|
void format_rfc1123_time(char *buf, time_t t);
|
|
int parse_rfc1123_time(const char *buf, time_t *t);
|
|
#define ISO_TIME_LEN 19
|
|
void format_local_iso_time(char *buf, time_t t);
|
|
void format_iso_time(char *buf, time_t t);
|
|
int parse_iso_time(const char *buf, time_t *t);
|
|
int parse_http_time(const char *buf, struct tm *tm);
|
|
int format_time_interval(char *out, size_t out_len, long interval);
|
|
|
|
/* Cached time */
|
|
#ifdef TIME_IS_FAST
|
|
#define approx_time() time(NULL)
|
|
#define update_approx_time(t) STMT_NIL
|
|
#else
|
|
time_t approx_time(void);
|
|
void update_approx_time(time_t now);
|
|
#endif
|
|
|
|
/* Fuzzy time. */
|
|
void ftime_set_maximum_sloppiness(int seconds);
|
|
void ftime_set_estimated_skew(int seconds);
|
|
/* typedef struct ftime_t { time_t earliest; time_t latest; } ftime_t; */
|
|
/* void ftime_get_window(time_t now, ftime_t *ft_out); */
|
|
int ftime_maybe_after(time_t now, time_t when);
|
|
int ftime_maybe_before(time_t now, time_t when);
|
|
int ftime_definitely_after(time_t now, time_t when);
|
|
int ftime_definitely_before(time_t now, time_t when);
|
|
|
|
/* File helpers */
|
|
ssize_t write_all(int fd, const char *buf, size_t count, int isSocket);
|
|
ssize_t read_all(int fd, char *buf, size_t count, int isSocket);
|
|
|
|
/** Return values from file_status(); see that function's documentation
|
|
* for details. */
|
|
typedef enum { FN_ERROR, FN_NOENT, FN_FILE, FN_DIR } file_status_t;
|
|
file_status_t file_status(const char *filename);
|
|
|
|
/** Possible behaviors for check_private_dir() on encountering a nonexistent
|
|
* directory; see that function's documentation for details. */
|
|
typedef enum { CPD_NONE, CPD_CREATE, CPD_CHECK } cpd_check_t;
|
|
int check_private_dir(const char *dirname, cpd_check_t check);
|
|
#define OPEN_FLAGS_REPLACE (O_WRONLY|O_CREAT|O_TRUNC)
|
|
#define OPEN_FLAGS_APPEND (O_WRONLY|O_CREAT|O_APPEND)
|
|
typedef struct open_file_t open_file_t;
|
|
int start_writing_to_file(const char *fname, int open_flags, int mode,
|
|
open_file_t **data_out);
|
|
FILE *start_writing_to_stdio_file(const char *fname, int open_flags, int mode,
|
|
open_file_t **data_out);
|
|
FILE *fdopen_file(open_file_t *file_data);
|
|
int finish_writing_to_file(open_file_t *file_data);
|
|
int abort_writing_to_file(open_file_t *file_data);
|
|
int write_str_to_file(const char *fname, const char *str, int bin);
|
|
int write_bytes_to_file(const char *fname, const char *str, size_t len,
|
|
int bin);
|
|
/** An ad-hoc type to hold a string of characters and a count; used by
|
|
* write_chunks_to_file. */
|
|
typedef struct sized_chunk_t {
|
|
const char *bytes;
|
|
size_t len;
|
|
} sized_chunk_t;
|
|
int write_chunks_to_file(const char *fname, const struct smartlist_t *chunks,
|
|
int bin);
|
|
int append_bytes_to_file(const char *fname, const char *str, size_t len,
|
|
int bin);
|
|
|
|
/** Flag for read_file_to_str: open the file in binary mode. */
|
|
#define RFTS_BIN 1
|
|
/** Flag for read_file_to_str: it's okay if the file doesn't exist. */
|
|
#define RFTS_IGNORE_MISSING 2
|
|
|
|
struct stat;
|
|
char *read_file_to_str(const char *filename, int flags, struct stat *stat_out)
|
|
ATTR_MALLOC;
|
|
const char *parse_config_line_from_str(const char *line,
|
|
char **key_out, char **value_out);
|
|
char *expand_filename(const char *filename);
|
|
struct smartlist_t *tor_listdir(const char *dirname);
|
|
int path_is_relative(const char *filename) ATTR_PURE;
|
|
|
|
/* Process helpers */
|
|
void start_daemon(void);
|
|
void finish_daemon(const char *desired_cwd);
|
|
void write_pidfile(char *filename);
|
|
|
|
#endif
|
|
|