67d7cb059ce8ff5fec3764ab3f4913f68544d790
[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_write_instance_st;
58
59 LIBMEMCACHED_LOCAL
60 memcached_server_write_instance_st memcached_server_instance_fetch(memcached_st *ptr, uint32_t server_key);
61
62 /* These are private not to be installed headers */
63 #include "libmemcached/do.h"
64 #include "libmemcached/io.h"
65 #include "libmemcached/internal.h"
66 #include "libmemcached/libmemcached_probes.h"
67 #include "libmemcached/memcached/protocol_binary.h"
68 #include "libmemcached/byteorder.h"
69 #include "libmemcached/response.h"
70
71 /* string value */
72 struct memcached_continuum_item_st
73 {
74 uint32_t index;
75 uint32_t value;
76 };
77
78 /* Yum, Fortran.... can you make the reference? */
79 typedef enum {
80 MEM_NOT= -1,
81 MEM_FALSE= false,
82 MEM_TRUE= true,
83 } memcached_ternary_t;
84
85
86 #if !defined(__GNUC__) || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
87
88 #define likely(x) if((x))
89 #define unlikely(x) if((x))
90
91 #else
92
93 #define likely(x) if(__builtin_expect((x) != 0, 1))
94 #define unlikely(x) if(__builtin_expect((x) != 0, 0))
95 #endif
96
97 #define MEMCACHED_BLOCK_SIZE 1024
98 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
99 #define SMALL_STRING_LEN 1024
100 #define HUGE_STRING_LEN 8196
101
102 #ifdef __cplusplus
103 extern "C" {
104 #endif
105
106 LIBMEMCACHED_LOCAL
107 memcached_return_t memcached_connect(memcached_server_write_instance_st ptr);
108
109 LIBMEMCACHED_LOCAL
110 memcached_return_t run_distribution(memcached_st *ptr);
111
112 #define memcached_server_response_increment(A) (A)->cursor_active++
113 #define memcached_server_response_decrement(A) (A)->cursor_active--
114 #define memcached_server_response_reset(A) (A)->cursor_active=0
115
116 // These are private
117 #define memcached_is_allocated(__object) ((__object)->options.is_allocated)
118 #define memcached_is_initialized(__object) ((__object)->options.is_initialized)
119 #define memcached_is_purging(__object) ((__object)->state.is_purging)
120 #define memcached_is_processing_input(__object) ((__object)->state.is_processing_input)
121 #define memcached_set_purging(__object, __value) ((__object)->state.is_purging= (__value))
122 #define memcached_set_processing_input(__object, __value) ((__object)->state.is_processing_input= (__value))
123 #define memcached_set_initialized(__object, __value) ((__object)->options.is_initialized(= (__value))
124 #define memcached_set_allocated(__object, __value) ((__object)->options.is_allocated(= (__value))
125
126
127 LIBMEMCACHED_LOCAL
128 memcached_return_t value_fetch(memcached_server_instance_st *ptr,
129 char *buffer,
130 memcached_result_st *result);
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 LIBMEMCACHED_LOCAL
137 memcached_return_t memcached_purge(memcached_server_write_instance_st ptr);
138
139 LIBMEMCACHED_LOCAL
140 memcached_server_st *memcached_server_create_with(const memcached_st *memc,
141 memcached_server_write_instance_st host,
142 const char *hostname,
143 in_port_t port,
144 uint32_t weight,
145 memcached_connection_t type);
146
147
148 static inline memcached_return_t memcached_validate_key_length(size_t key_length, bool binary)
149 {
150 unlikely (key_length == 0)
151 return MEMCACHED_BAD_KEY_PROVIDED;
152
153 if (binary)
154 {
155 unlikely (key_length > 0xffff)
156 return MEMCACHED_BAD_KEY_PROVIDED;
157 }
158 else
159 {
160 unlikely (key_length >= MEMCACHED_MAX_KEY)
161 return MEMCACHED_BAD_KEY_PROVIDED;
162 }
163
164 return MEMCACHED_SUCCESS;
165 }
166
167 #ifdef TCP_CORK
168 #define CORK TCP_CORK
169 #elif defined TCP_NOPUSH
170 #define CORK TCP_NOPUSH
171 #endif
172
173 /*
174 test_cork() tries to enable TCP_CORK. IF TCP_CORK is not an option
175 on the system it returns false but sets errno to 0. Otherwise on
176 failure errno is set.
177 */
178 static inline memcached_ternary_t test_cork(memcached_server_st *ptr, int enable)
179 {
180 #ifdef CORK
181 if (ptr->type != MEMCACHED_CONNECTION_TCP)
182 return MEM_FALSE;
183
184 int err= setsockopt(ptr->fd, IPPROTO_TCP, CORK,
185 &enable, (socklen_t)sizeof(int));
186 if (! err)
187 {
188 return MEM_TRUE;
189 }
190
191 perror(strerror(errno));
192 ptr->cached_errno= errno;
193
194 return MEM_FALSE;
195 #else
196 (void)ptr;
197 (void)enable;
198
199 ptr->cached_errno= 0;
200
201 return MEM_NOT;
202 #endif
203 }
204
205 static inline void libmemcached_free(const memcached_st *ptr, void *mem)
206 {
207 ptr->allocators.free(ptr, mem, ptr->allocators.context);
208 }
209
210 static inline void *libmemcached_malloc(const memcached_st *ptr, const size_t size)
211 {
212 return ptr->allocators.malloc(ptr, size, ptr->allocators.context);
213 }
214
215 static inline void *libmemcached_realloc(const memcached_st *ptr, void *mem, const size_t size)
216 {
217 return ptr->allocators.realloc(ptr, mem, size, ptr->allocators.context);
218 }
219
220 static inline void *libmemcached_calloc(const memcached_st *ptr, size_t nelem, size_t size)
221 {
222 return ptr->allocators.calloc(ptr, nelem, size, ptr->allocators.context);
223 }
224
225 #ifdef __cplusplus
226 }
227 #endif
228
229 #endif /* __LIBMEMCACHED_COMMON_H__ */