util.h 5.49 KB
Newer Older
Nick Mathewson's avatar
Nick Mathewson committed
1
2
/* Copyright 2003-2004 Roger Dingledine
 * Copyright 2004-2005 Roger Dingledine, Nick Mathewson */
3
4
5
/* See LICENSE for licensing information */
/* $Id$ */

6
7
8
/**
 * \file util.h
 * \brief Headers for util.c
9
 **/
10

11
12
#ifndef __UTIL_H
#define __UTIL_H
13
#define UTIL_H_ID "$Id$"
14

15
16
#include "orconfig.h"
#include "torint.h"
17
#include "compat.h"
18
19
20
21
#include <stdio.h>
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
Nick Mathewson's avatar
Nick Mathewson committed
22
23
24
#ifdef HAVE_TIME_H
#include <time.h>
#endif
25

26
/** Replace assert() with a variant that sends failures to the log before
27
28
 * calling assert() normally.
 */
29
#ifdef NDEBUG
30
31
32
33
34
35
36
37
38
/* Nobody should ever want to build with NDEBUG set.  99% of your 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."
39
40
41
42
#else
#define tor_assert(expr) do {                                 \
 if (!(expr)) {                                               \
   log(LOG_ERR, "%s:%d: %s: Assertion %s failed; aborting.",  \
43
       _SHORT_FILE_, __LINE__, __FUNCTION__, #expr);          \
44
45
   fprintf(stderr,"%s:%d %s: Assertion %s failed; aborting.\n", \
       _SHORT_FILE_, __LINE__, __FUNCTION__, #expr);          \
46
47
48
49
   abort();  /* unreached */                                  \
 } } while (0)
#endif

50
/* Memory management */
51
52
53
54
55
void *_tor_malloc(const char *file, const int line, size_t size);
void *_tor_malloc_zero(const char *file, const int line, size_t size);
void *_tor_realloc(const char *file, const int line, void *ptr, size_t size);
char *_tor_strdup(const char *file, const int line, const char *s);
char *_tor_strndup(const char *file, const int line, const char *s, size_t n);
56
#define tor_free(p) do { if (p) {free(p); (p)=NULL;} } while (0)
57

58
59
60
61
62
63
#define tor_malloc(size)       _tor_malloc(_SHORT_FILE_, __LINE__, size)
#define tor_malloc_zero(size)  _tor_malloc_zero(_SHORT_FILE_, __LINE__, size)
#define tor_realloc(ptr, size) _tor_realloc(_SHORT_FILE_, __LINE__, ptr, size)
#define tor_strdup(s)          _tor_strdup(_SHORT_FILE_, __LINE__, s)
#define tor_strndup(s, n)      _tor_strndup(_SHORT_FILE_, __LINE__, s, n)

64
65
/* String manipulation */
#define HEX_CHARACTERS "0123456789ABCDEFabcdef"
66
void tor_strlower(char *s);
67
int strcmpstart(const char *s1, const char *s2);
68
int strcasecmpstart(const char *s1, const char *s2);
69
int strcmpend(const char *s1, const char *s2);
70
int strcasecmpend(const char *s1, const char *s2);
71
int tor_strstrip(char *s, const char *strip);
72
73
74
typedef enum {
  ALWAYS_TERMINATE, NEVER_TERMINATE, TERMINATE_IF_EVEN
} part_finish_rule_t;
75
int tor_strpartition(char *dest, size_t dest_len,
76
77
                     const char *s, const char *insert, size_t n,
                     part_finish_rule_t rule);
78
79
80
81
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);
82
83
uint64_t tor_parse_uint64(const char *s, int base, uint64_t min,
                         uint64_t max, int *ok, char **next);
84
const char *hex_str(const char *from, size_t fromlen);
85
86
87
const char *eat_whitespace(const char *s);
const char *eat_whitespace_no_nl(const char *s);
const char *find_whitespace(const char *s);
88

89
90
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);
91

92
/* Time helpers */
93
94
95
96
long tv_udiff(struct timeval *start, struct timeval *end);
void tv_addms(struct timeval *a, long ms);
void tv_add(struct timeval *a, struct timeval *b);
int tv_cmp(struct timeval *a, struct timeval *b);
Nick Mathewson's avatar
Nick Mathewson committed
97
time_t tor_timegm(struct tm *tm);
98
#define RFC1123_TIME_LEN 29
99
100
101
void format_rfc1123_time(char *buf, time_t t);
int parse_rfc1123_time(const char *buf, time_t *t);
#define ISO_TIME_LEN 19
102
void format_local_iso_time(char *buf, time_t t);
103
104
void format_iso_time(char *buf, time_t t);
int parse_iso_time(const char *buf, time_t *t);
105

106
/* File helpers */
107
108
int write_all(int fd, const char *buf, size_t count, int isSocket);
int read_all(int fd, char *buf, size_t count, int isSocket);
Roger Dingledine's avatar
Roger Dingledine committed
109

110
111
typedef enum { FN_ERROR, FN_NOENT, FN_FILE, FN_DIR} file_status_t;
file_status_t file_status(const char *filename);
112

113
114
typedef enum { CPD_NONE, CPD_CREATE, CPD_CHECK } cpd_check_t;
int check_private_dir(const char *dirname, cpd_check_t check);
115
int write_str_to_file(const char *fname, const char *str, int bin);
116
117
int write_bytes_to_file(const char *fname, const char *str, size_t len,
                        int bin);
118
char *read_file_to_str(const char *filename, int bin);
119
char *parse_line_from_str(char *line, char **key_out, char **value_out);
120
char *expand_filename(const char *filename);
121

122
/* Net helpers */
123
int is_internal_IP(uint32_t ip);
124
int is_local_IP(uint32_t ip);
125
126
int parse_addr_port(const char *addrport, char **address, uint32_t *addr,
                    uint16_t *port);
127
128
129
int parse_addr_and_port_range(const char *s, uint32_t *addr_out,
                              uint32_t *mask_out, uint16_t *port_min_out,
                              uint16_t *port_max_out);
130
131
#define INET_NTOA_BUF_LEN 16
int tor_inet_ntoa(struct in_addr *in, char *buf, size_t buf_len);
132
int is_plausible_address(const char *name);
133

134
/* Process helpers */
135
136
void start_daemon(void);
void finish_daemon(const char *desired_cwd);
137
void write_pidfile(char *filename);
138

139
#endif