Merge in all scanner tree + virtual buckets.
[awesomized/libmemcached] / libmemcached / common.h
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * LibMemcached
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are
11 * met:
12 *
13 * * Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * * Redistributions in binary form must reproduce the above
17 * copyright notice, this list of conditions and the following disclaimer
18 * in the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * * The names of its contributors may not be used to endorse or
22 * promote products derived from this software without specific prior
23 * written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 */
38
39 /*
40 Common include file for libmemached
41 */
42
43 #pragma once
44
45 #include <config.h>
46
47 #include <stdio.h>
48 #include <stdlib.h>
49 #include <string.h>
50 #include <strings.h>
51 #include <ctype.h>
52 #include <sys/types.h>
53 #include <unistd.h>
54 #include <limits.h>
55 #include <errno.h>
56 #include <fcntl.h>
57 #ifdef TIME_WITH_SYS_TIME
58 # include <sys/time.h>
59 # include <time.h>
60 #else
61 # ifdef HAVE_SYS_TIME_H
62 # include <sys/time.h>
63 # else
64 # include <time.h>
65 # endif
66 #endif
67
68 /* Define this here, which will turn on the visibilty controls while we're
69 * building libmemcached.
70 */
71 #define BUILDING_LIBMEMCACHED 1
72
73
74 #include "libmemcached/memcached.h"
75 #include "libmemcached/watchpoint.h"
76 #include "libmemcached/is.h"
77 #include "libmemcached/prefix_key.h"
78
79 typedef struct memcached_server_st * memcached_server_write_instance_st;
80
81 typedef memcached_return_t (*memcached_server_execute_fn)(memcached_st *ptr, memcached_server_write_instance_st server, void *context);
82
83 LIBMEMCACHED_LOCAL
84 memcached_server_write_instance_st memcached_server_instance_fetch(memcached_st *ptr, uint32_t server_key);
85
86 LIBMEMCACHED_LOCAL
87 memcached_return_t memcached_server_execute(memcached_st *ptr,
88 memcached_server_execute_fn callback,
89 void *context);
90
91
92 /* These are private not to be installed headers */
93 #include "libmemcached/io.h"
94 #include "libmemcached/do.h"
95 #include "libmemcached/internal.h"
96 #include "libmemcached/array.h"
97 #include "libmemcached/libmemcached_probes.h"
98 #include "libmemcached/memcached/protocol_binary.h"
99 #include "libmemcached/byteorder.h"
100 #include "libmemcached/response.h"
101 #include "libmemcached/prefix_key.h"
102
103 /* string value */
104 struct memcached_continuum_item_st
105 {
106 uint32_t index;
107 uint32_t value;
108 };
109
110 #if !defined(__GNUC__) || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
111
112 #define likely(x) if((x))
113 #define unlikely(x) if((x))
114
115 #else
116
117 #define likely(x) if(__builtin_expect((x) != 0, 1))
118 #define unlikely(x) if(__builtin_expect((x) != 0, 0))
119 #endif
120
121 #define MEMCACHED_BLOCK_SIZE 1024
122 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
123 #define SMALL_STRING_LEN 1024
124 #define HUGE_STRING_LEN 8196
125
126 #ifdef __cplusplus
127 extern "C" {
128 #endif
129
130 LIBMEMCACHED_LOCAL
131 memcached_return_t memcached_connect(memcached_server_write_instance_st ptr);
132
133 LIBMEMCACHED_LOCAL
134 memcached_return_t run_distribution(memcached_st *ptr);
135
136 #define memcached_server_response_increment(A) (A)->cursor_active++
137 #define memcached_server_response_decrement(A) (A)->cursor_active--
138 #define memcached_server_response_reset(A) (A)->cursor_active=0
139
140 LIBMEMCACHED_LOCAL
141 void set_last_disconnected_host(memcached_server_write_instance_st ptr);
142
143 LIBMEMCACHED_LOCAL
144 memcached_return_t memcached_key_test(const char * const *keys,
145 const size_t *key_length,
146 size_t number_of_keys);
147
148 LIBMEMCACHED_LOCAL
149 memcached_return_t memcached_purge(memcached_server_write_instance_st ptr);
150
151 LIBMEMCACHED_LOCAL
152 memcached_server_st *memcached_server_create_with(const memcached_st *memc,
153 memcached_server_write_instance_st host,
154 const char *hostname,
155 in_port_t port,
156 uint32_t weight,
157 memcached_connection_t type);
158
159
160 static inline memcached_return_t memcached_validate_key_length(size_t key_length, bool binary)
161 {
162 unlikely (key_length == 0)
163 return MEMCACHED_BAD_KEY_PROVIDED;
164
165 if (binary)
166 {
167 unlikely (key_length > 0xffff)
168 return MEMCACHED_BAD_KEY_PROVIDED;
169 }
170 else
171 {
172 unlikely (key_length >= MEMCACHED_MAX_KEY)
173 return MEMCACHED_BAD_KEY_PROVIDED;
174 }
175
176 return MEMCACHED_SUCCESS;
177 }
178
179 static inline void libmemcached_free(const memcached_st *ptr, void *mem)
180 {
181 ptr->allocators.free(ptr, mem, ptr->allocators.context);
182 }
183
184 static inline void *libmemcached_malloc(const memcached_st *ptr, const size_t size)
185 {
186 return ptr->allocators.malloc(ptr, size, ptr->allocators.context);
187 }
188
189 static inline void *libmemcached_realloc(const memcached_st *ptr, void *mem, const size_t size)
190 {
191 return ptr->allocators.realloc(ptr, mem, size, ptr->allocators.context);
192 }
193
194 static inline void *libmemcached_calloc(const memcached_st *ptr, size_t nelem, size_t size)
195 {
196 return ptr->allocators.calloc(ptr, nelem, size, ptr->allocators.context);
197 }
198
199 #ifdef __cplusplus
200 }
201 #endif