Fix typo
[awesomized/libmemcached] / libmemcached / common.h
1 /*
2 Common include file for libmemached
3 */
4
5 #ifndef LIBMEMCACHED_COMMON_H
6 #define LIBMEMCACHED_COMMON_H
7
8 #include "config.h"
9
10 #include <stdio.h>
11 #include <stdlib.h>
12 #include <string.h>
13 #include <strings.h>
14 #include <ctype.h>
15 #include <sys/types.h>
16 #include <sys/socket.h>
17 #include <netinet/in.h>
18 #include <arpa/inet.h>
19 #include <netdb.h>
20 #include <unistd.h>
21 #include <limits.h>
22 #include <errno.h>
23 #include <fcntl.h>
24 #include <sys/un.h>
25 #include <netinet/tcp.h>
26 #ifdef TIME_WITH_SYS_TIME
27 # include <sys/time.h>
28 # include <time.h>
29 #else
30 # ifdef HAVE_SYS_TIME_H
31 # include <sys/time.h>
32 # else
33 # include <time.h>
34 # endif
35 #endif
36
37 /* Define this here, which will turn on the visibilty controls while we're
38 * building libmemcached.
39 */
40 #define BUILDING_LIBMEMCACHED 1
41
42
43 #include "libmemcached/memcached.h"
44 #include "libmemcached/memcached_watchpoint.h"
45
46 /* These are private not to be installed headers */
47 #include "libmemcached/memcached_io.h"
48 #include "libmemcached/memcached_internal.h"
49 #include "libmemcached/libmemcached_probes.h"
50 #include "libmemcached/memcached/protocol_binary.h"
51 #include "libmemcached/byteorder.h"
52
53 /* string value */
54 struct memcached_continuum_item_st {
55 uint32_t index;
56 uint32_t value;
57 };
58
59
60 #if !defined(__GNUC__) || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
61
62 #define likely(x) if((x))
63 #define unlikely(x) if((x))
64
65 #else
66
67 #define likely(x) if(__builtin_expect(!!(x), 1))
68 #define unlikely(x) if(__builtin_expect((x), 0))
69 #endif
70
71
72 #define MEMCACHED_BLOCK_SIZE 1024
73 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
74 #define SMALL_STRING_LEN 1024
75 #define HUGE_STRING_LEN 8196
76
77
78 typedef enum {
79 MEM_NO_BLOCK= (1 << 0),
80 MEM_TCP_NODELAY= (1 << 1),
81 MEM_REUSE_MEMORY= (1 << 2),
82 MEM_USE_MD5= (1 << 3),
83 /* 4 was once Ketama */
84 MEM_USE_CRC= (1 << 5),
85 MEM_USE_CACHE_LOOKUPS= (1 << 6),
86 MEM_SUPPORT_CAS= (1 << 7),
87 MEM_BUFFER_REQUESTS= (1 << 8),
88 MEM_USE_SORT_HOSTS= (1 << 9),
89 MEM_VERIFY_KEY= (1 << 10),
90 /* 11 used for weighted ketama */
91 MEM_KETAMA_WEIGHTED= (1 << 11),
92 MEM_BINARY_PROTOCOL= (1 << 12),
93 MEM_HASH_WITH_PREFIX_KEY= (1 << 13),
94 MEM_NOREPLY= (1 << 14),
95 MEM_USE_UDP= (1 << 15),
96 MEM_AUTO_EJECT_HOSTS= (1 << 16)
97 } memcached_flags;
98
99 /* Hashing algo */
100
101 LIBMEMCACHED_LOCAL
102 void md5_signature(const unsigned char *key, unsigned int length, unsigned char *result);
103 LIBMEMCACHED_LOCAL
104 uint32_t hash_crc32(const char *data,
105 size_t data_len);
106 #ifdef HAVE_HSIEH_HASH
107 LIBMEMCACHED_LOCAL
108 uint32_t hsieh_hash(const char *key, size_t key_length);
109 #endif
110 LIBMEMCACHED_LOCAL
111 uint32_t murmur_hash(const char *key, size_t key_length);
112 LIBMEMCACHED_LOCAL
113 uint32_t jenkins_hash(const void *key, size_t length, uint32_t initval);
114
115 LIBMEMCACHED_LOCAL
116 memcached_return memcached_connect(memcached_server_st *ptr);
117 LIBMEMCACHED_LOCAL
118 memcached_return memcached_response(memcached_server_st *ptr,
119 char *buffer, size_t buffer_length,
120 memcached_result_st *result);
121 LIBMEMCACHED_LOCAL
122 void memcached_quit_server(memcached_server_st *ptr, uint8_t io_death);
123
124 #define memcached_server_response_increment(A) (A)->cursor_active++
125 #define memcached_server_response_decrement(A) (A)->cursor_active--
126 #define memcached_server_response_reset(A) (A)->cursor_active=0
127
128 LIBMEMCACHED_LOCAL
129 memcached_return memcached_do(memcached_server_st *ptr, const void *commmand,
130 size_t command_length, uint8_t with_flush);
131 LIBMEMCACHED_LOCAL
132 memcached_return value_fetch(memcached_server_st *ptr,
133 char *buffer,
134 memcached_result_st *result);
135 LIBMEMCACHED_LOCAL
136 void server_list_free(memcached_st *ptr, memcached_server_st *servers);
137
138 LIBMEMCACHED_LOCAL
139 memcached_return memcached_key_test(const char * const *keys,
140 const size_t *key_length,
141 size_t number_of_keys);
142
143
144 LIBMEMCACHED_LOCAL
145 uint32_t generate_hash(memcached_st *ptr, const char *key, size_t key_length);
146
147 LIBMEMCACHED_LOCAL
148 memcached_return memcached_purge(memcached_server_st *ptr);
149
150 static inline memcached_return memcached_validate_key_length(size_t key_length,
151 bool binary) {
152 unlikely (key_length == 0)
153 return MEMCACHED_BAD_KEY_PROVIDED;
154
155 if (binary)
156 {
157 unlikely (key_length > 0xffff)
158 return MEMCACHED_BAD_KEY_PROVIDED;
159 }
160 else
161 {
162 unlikely (key_length >= MEMCACHED_MAX_KEY)
163 return MEMCACHED_BAD_KEY_PROVIDED;
164 }
165
166 return MEMCACHED_SUCCESS;
167 }
168
169 #endif /* LIBMEMCACHED_COMMON_H */