Cleanup dead files in libmemcached.
[m6w6/libmemcached] / libmemcached / common.h
1 /* LibMemcached
2 * Copyright (C) 2006-2009 Brian Aker
3 * All rights reserved.
4 *
5 * Use and distribution licensed under the BSD license. See
6 * the COPYING file in the parent directory for full text.
7 *
8 * Summary:
9 *
10 */
11
12 /*
13 Common include file for libmemached
14 */
15
16 #ifndef LIBMEMCACHED_COMMON_H
17 #define LIBMEMCACHED_COMMON_H
18
19 #include "config.h"
20
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <strings.h>
25 #include <ctype.h>
26 #include <sys/types.h>
27 #include <sys/socket.h>
28 #include <netinet/in.h>
29 #include <arpa/inet.h>
30 #include <netdb.h>
31 #include <unistd.h>
32 #include <limits.h>
33 #include <errno.h>
34 #include <fcntl.h>
35 #include <sys/un.h>
36 #include <netinet/tcp.h>
37 #ifdef TIME_WITH_SYS_TIME
38 # include <sys/time.h>
39 # include <time.h>
40 #else
41 # ifdef HAVE_SYS_TIME_H
42 # include <sys/time.h>
43 # else
44 # include <time.h>
45 # endif
46 #endif
47
48 /* Define this here, which will turn on the visibilty controls while we're
49 * building libmemcached.
50 */
51 #define BUILDING_LIBMEMCACHED 1
52
53
54 #include "libmemcached/memcached.h"
55 #include "libmemcached/watchpoint.h"
56
57 typedef struct memcached_server_st memcached_server_instance_st;
58
59 /* These are private not to be installed headers */
60 #include "libmemcached/io.h"
61 #include "libmemcached/internal.h"
62 #include "libmemcached/libmemcached_probes.h"
63 #include "libmemcached/memcached/protocol_binary.h"
64 #include "libmemcached/byteorder.h"
65 #include "libmemcached/response.h"
66
67 /* string value */
68 struct memcached_continuum_item_st
69 {
70 uint32_t index;
71 uint32_t value;
72 };
73
74 /* Yum, Fortran.... can you make the reference? */
75 typedef enum {
76 MEM_NOT= -1,
77 MEM_FALSE= false,
78 MEM_TRUE= true,
79 } memcached_ternary_t;
80
81
82 #if !defined(__GNUC__) || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
83
84 #define likely(x) if((x))
85 #define unlikely(x) if((x))
86
87 #else
88
89 #define likely(x) if(__builtin_expect((x) != 0, 1))
90 #define unlikely(x) if(__builtin_expect((x) != 0, 0))
91 #endif
92
93 #define MEMCACHED_BLOCK_SIZE 1024
94 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
95 #define SMALL_STRING_LEN 1024
96 #define HUGE_STRING_LEN 8196
97
98 LIBMEMCACHED_LOCAL
99 memcached_return_t memcached_connect(memcached_server_instance_st *ptr);
100 LIBMEMCACHED_LOCAL
101 void memcached_quit_server(memcached_server_instance_st *ptr, uint8_t io_death);
102
103 LIBMEMCACHED_LOCAL
104 memcached_return_t run_distribution(memcached_st *ptr);
105
106 #define memcached_server_response_increment(A) (A)->cursor_active++
107 #define memcached_server_response_decrement(A) (A)->cursor_active--
108 #define memcached_server_response_reset(A) (A)->cursor_active=0
109
110 // These are private
111 #define memcached_is_allocated(__object) ((__object)->options.is_allocated)
112 #define memcached_is_initialized(__object) ((__object)->options.is_initialized)
113 #define memcached_is_purging(__object) ((__object)->state.is_purging)
114 #define memcached_is_processing_input(__object) ((__object)->state.is_processing_input)
115 #define memcached_set_purging(__object, __value) ((__object)->state.is_purging= (__value))
116 #define memcached_set_processing_input(__object, __value) ((__object)->state.is_processing_input= (__value))
117 #define memcached_set_initialized(__object, __value) ((__object)->options.is_initialized(= (__value))
118 #define memcached_set_allocated(__object, __value) ((__object)->options.is_allocated(= (__value))
119
120
121 LIBMEMCACHED_LOCAL
122 memcached_return_t memcached_do(memcached_server_instance_st *ptr, const void *commmand,
123 size_t command_length, uint8_t with_flush);
124 LIBMEMCACHED_LOCAL
125 memcached_return_t value_fetch(memcached_server_instance_st *ptr,
126 char *buffer,
127 memcached_result_st *result);
128 LIBMEMCACHED_LOCAL
129 void server_list_free(memcached_st *ptr, memcached_server_instance_st *servers);
130
131 LIBMEMCACHED_LOCAL
132 memcached_return_t memcached_key_test(const char * const *keys,
133 const size_t *key_length,
134 size_t number_of_keys);
135
136
137 LIBMEMCACHED_LOCAL
138 uint32_t generate_hash(memcached_st *ptr, const char *key, size_t key_length);
139
140 LIBMEMCACHED_LOCAL
141 memcached_return_t memcached_purge(memcached_server_instance_st *ptr);
142
143 static inline memcached_return_t memcached_validate_key_length(size_t key_length, bool binary)
144 {
145 unlikely (key_length == 0)
146 return MEMCACHED_BAD_KEY_PROVIDED;
147
148 if (binary)
149 {
150 unlikely (key_length > 0xffff)
151 return MEMCACHED_BAD_KEY_PROVIDED;
152 }
153 else
154 {
155 unlikely (key_length >= MEMCACHED_MAX_KEY)
156 return MEMCACHED_BAD_KEY_PROVIDED;
157 }
158
159 return MEMCACHED_SUCCESS;
160 }
161
162 #ifdef TCP_CORK
163 #define CORK TCP_CORK
164 #elif defined TCP_NOPUSH
165 #define CORK TCP_NOPUSH
166 #endif
167
168 /*
169 test_cork() tries to enable TCP_CORK. IF TCP_CORK is not an option
170 on the system it returns false but sets errno to 0. Otherwise on
171 failure errno is set.
172 */
173 static inline memcached_ternary_t test_cork(memcached_server_st *ptr, int enable)
174 {
175 #ifdef CORK
176 if (ptr->type != MEMCACHED_CONNECTION_TCP)
177 return MEM_FALSE;
178
179 int err= setsockopt(ptr->fd, IPPROTO_TCP, CORK,
180 &enable, (socklen_t)sizeof(int));
181 if (! err)
182 {
183 return MEM_TRUE;
184 }
185
186 perror(strerror(errno));
187 ptr->cached_errno= errno;
188
189 return MEM_FALSE;
190 #else
191 (void)ptr;
192 (void)enable;
193
194 ptr->cached_errno= 0;
195
196 return MEM_NOT;
197 #endif
198 }
199
200 static inline void libmemcached_free(const memcached_st *ptr, void *mem)
201 {
202 ptr->allocators.free(ptr, mem, ptr->allocators.context);
203 }
204
205 static inline void *libmemcached_malloc(const memcached_st *ptr, const size_t size)
206 {
207 return ptr->allocators.malloc(ptr, size, ptr->allocators.context);
208 }
209
210 static inline void *libmemcached_realloc(const memcached_st *ptr, void *mem, const size_t size)
211 {
212 return ptr->allocators.realloc(ptr, mem, size, ptr->allocators.context);
213 }
214
215 static inline void *libmemcached_calloc(const memcached_st *ptr, size_t nelem, size_t size)
216 {
217 return ptr->allocators.calloc(ptr, nelem, size, ptr->allocators.context);
218 }
219
220
221 #endif /* LIBMEMCACHED_COMMON_H */