Bump required version for touch.
[awesomized/libmemcached] / libmemcached / memcached.cc
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * Libmemcached library
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following disclaimer
17 * in the documentation and/or other materials provided with the
18 * distribution.
19 *
20 * * The names of its contributors may not be used to endorse or
21 * promote products derived from this software without specific prior
22 * written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 *
36 */
37
38 #include <libmemcached/common.h>
39
40 #include <libmemcached/options.hpp>
41 #include <libmemcached/virtual_bucket.h>
42
43 static inline bool _memcached_init(Memcached *self)
44 {
45 self->state.is_purging= false;
46 self->state.is_processing_input= false;
47 self->state.is_time_for_rebuild= false;
48 self->state.is_parsing= false;
49
50 self->flags.auto_eject_hosts= false;
51 self->flags.binary_protocol= false;
52 self->flags.buffer_requests= false;
53 self->flags.hash_with_namespace= false;
54 self->flags.no_block= false;
55 self->flags.reply= true;
56 self->flags.randomize_replica_read= false;
57 self->flags.support_cas= false;
58 self->flags.tcp_nodelay= false;
59 self->flags.use_sort_hosts= false;
60 self->flags.use_udp= false;
61 self->flags.verify_key= false;
62 self->flags.tcp_keepalive= false;
63 self->flags.is_aes= false;
64 self->flags.is_fetching_version= false;
65
66 self->virtual_bucket= NULL;
67
68 self->distribution= MEMCACHED_DISTRIBUTION_MODULA;
69
70 if (hashkit_create(&self->hashkit) == NULL)
71 {
72 return false;
73 }
74
75 self->server_info.version= 0;
76
77 self->ketama.continuum= NULL;
78 self->ketama.continuum_count= 0;
79 self->ketama.continuum_points_counter= 0;
80 self->ketama.next_distribution_rebuild= 0;
81 self->ketama.weighted_= false;
82
83 self->number_of_hosts= 0;
84 self->servers= NULL;
85 self->last_disconnected_server= NULL;
86
87 self->snd_timeout= 0;
88 self->rcv_timeout= 0;
89 self->server_failure_limit= MEMCACHED_SERVER_FAILURE_LIMIT;
90 self->query_id= 1; // 0 is considered invalid
91
92 /* TODO, Document why we picked these defaults */
93 self->io_msg_watermark= 500;
94 self->io_bytes_watermark= 65 * 1024;
95
96 self->tcp_keepidle= 0;
97
98 self->io_key_prefetch= 0;
99 self->poll_timeout= MEMCACHED_DEFAULT_TIMEOUT;
100 self->connect_timeout= MEMCACHED_DEFAULT_CONNECT_TIMEOUT;
101 self->retry_timeout= MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT;
102 self->dead_timeout= MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT;
103
104 self->send_size= -1;
105 self->recv_size= -1;
106
107 self->user_data= NULL;
108 self->number_of_replicas= 0;
109
110 self->allocators= memcached_allocators_return_default();
111
112 self->on_clone= NULL;
113 self->on_cleanup= NULL;
114 self->get_key_failure= NULL;
115 self->delete_trigger= NULL;
116 self->callbacks= NULL;
117 self->sasl.callbacks= NULL;
118 self->sasl.is_allocated= false;
119
120 self->error_messages= NULL;
121 self->_namespace= NULL;
122 self->configure.initial_pool_size= 1;
123 self->configure.max_pool_size= 1;
124 self->configure.version= -1;
125 self->configure.filename= NULL;
126
127 return true;
128 }
129
130 static void __memcached_free(Memcached *ptr, bool release_st)
131 {
132 /* If we have anything open, lets close it now */
133 send_quit(ptr);
134 memcached_instance_list_free(memcached_instance_list(ptr), memcached_instance_list_count(ptr));
135 memcached_result_free(&ptr->result);
136
137 memcached_virtual_bucket_free(ptr);
138
139 memcached_instance_free((org::libmemcached::Instance*)ptr->last_disconnected_server);
140
141 if (ptr->on_cleanup)
142 {
143 ptr->on_cleanup(ptr);
144 }
145
146 libmemcached_free(ptr, ptr->ketama.continuum);
147 ptr->ketama.continuum= NULL;
148
149 memcached_array_free(ptr->_namespace);
150 ptr->_namespace= NULL;
151
152 memcached_error_free(*ptr);
153
154 if (LIBMEMCACHED_WITH_SASL_SUPPORT and ptr->sasl.callbacks)
155 {
156 memcached_destroy_sasl_auth_data(ptr);
157 }
158
159 if (release_st)
160 {
161 memcached_array_free(ptr->configure.filename);
162 ptr->configure.filename= NULL;
163 }
164
165 hashkit_free(&ptr->hashkit);
166
167 if (memcached_is_allocated(ptr) and release_st)
168 {
169 libmemcached_free(ptr, ptr);
170 }
171 }
172
173 memcached_st *memcached_create(memcached_st *shell)
174 {
175 if (shell)
176 {
177 shell->options.is_allocated= false;
178 }
179 else
180 {
181 shell= (memcached_st *)libmemcached_xmalloc(NULL, memcached_st);
182
183 if (shell == NULL)
184 {
185 return NULL; /* MEMCACHED_MEMORY_ALLOCATION_FAILURE */
186 }
187
188 shell->options.is_allocated= true;
189 }
190
191 if (_memcached_init(shell) == false)
192 {
193 memcached_free(shell);
194 return NULL;
195 }
196
197 Memcached* memc= memcached2Memcached(shell);
198 if (memcached_result_create(shell, &memc->result) == NULL)
199 {
200 memcached_free(shell);
201 return NULL;
202 }
203
204 WATCHPOINT_ASSERT_INITIALIZED(&memc->result);
205
206 return shell;
207 }
208
209 memcached_st *memcached(const char *string, size_t length)
210 {
211 if (length == 0 and string)
212 {
213 return NULL;
214 }
215
216 if (length and string == NULL)
217 {
218 return NULL;
219 }
220
221 if (length == 0)
222 {
223 if (bool(getenv("LIBMEMCACHED")))
224 {
225 string= getenv("LIBMEMCACHED");
226 length= string ? strlen(string) : 0;
227 }
228 }
229
230 memcached_st *memc= memcached_create(NULL);
231 if (memc == NULL)
232 {
233 return NULL;
234 }
235
236 if (length == 0 or string == NULL)
237 {
238 return memc;
239 }
240
241 memcached_return_t rc= memcached_parse_configuration(memc, string, length);
242 if (memcached_success(rc) and memcached_parse_filename(memc))
243 {
244 rc= memcached_parse_configure_file(*memc, memcached_parse_filename(memc), memcached_parse_filename_length(memc));
245 }
246
247 if (memcached_failed(rc))
248 {
249 memcached_free(memc);
250 return NULL;
251 }
252
253 return memc;
254 }
255
256 memcached_return_t memcached_reset(memcached_st *shell)
257 {
258 Memcached* ptr= memcached2Memcached(shell);
259 WATCHPOINT_ASSERT(ptr);
260 if (ptr == NULL)
261 {
262 return MEMCACHED_INVALID_ARGUMENTS;
263 }
264
265 bool stored_is_allocated= memcached_is_allocated(ptr);
266 uint64_t query_id= ptr->query_id;
267 __memcached_free(ptr, false);
268 memcached_create(ptr);
269 memcached_set_allocated(ptr, stored_is_allocated);
270 ptr->query_id= query_id;
271
272 if (ptr->configure.filename)
273 {
274 return memcached_parse_configure_file(*ptr, memcached_param_array(ptr->configure.filename));
275 }
276
277 return MEMCACHED_SUCCESS;
278 }
279
280 void memcached_servers_reset(memcached_st *shell)
281 {
282 Memcached* self= memcached2Memcached(shell);
283 if (self)
284 {
285 libmemcached_free(self, self->ketama.continuum);
286 self->ketama.continuum= NULL;
287
288 memcached_instance_list_free(memcached_instance_list(self), self->number_of_hosts);
289 memcached_instance_set(self, NULL, 0);
290
291 memcached_reset_last_disconnected_server(self);
292 }
293 }
294
295 void memcached_reset_last_disconnected_server(memcached_st *shell)
296 {
297 Memcached* self= memcached2Memcached(shell);
298 if (self)
299 {
300 memcached_instance_free((org::libmemcached::Instance*)self->last_disconnected_server);
301 self->last_disconnected_server= NULL;
302 }
303 }
304
305 void memcached_free(memcached_st *ptr)
306 {
307 if (ptr)
308 {
309 __memcached_free(ptr, true);
310 }
311 }
312
313 /*
314 clone is the destination, while source is the structure to clone.
315 If source is NULL the call is the same as if a memcached_create() was
316 called.
317 */
318 memcached_st *memcached_clone(memcached_st *clone, const memcached_st *source)
319 {
320 if (source == NULL)
321 {
322 return memcached_create(clone);
323 }
324
325 if (clone and memcached_is_allocated(clone))
326 {
327 return NULL;
328 }
329
330 memcached_st *new_clone= memcached_create(clone);
331
332 if (new_clone == NULL)
333 {
334 return NULL;
335 }
336
337 new_clone->flags= source->flags;
338 new_clone->send_size= source->send_size;
339 new_clone->recv_size= source->recv_size;
340 new_clone->poll_timeout= source->poll_timeout;
341 new_clone->connect_timeout= source->connect_timeout;
342 new_clone->retry_timeout= source->retry_timeout;
343 new_clone->dead_timeout= source->dead_timeout;
344 new_clone->distribution= source->distribution;
345
346 if (hashkit_clone(&new_clone->hashkit, &source->hashkit) == NULL)
347 {
348 memcached_free(new_clone);
349 return NULL;
350 }
351
352 new_clone->user_data= source->user_data;
353
354 new_clone->snd_timeout= source->snd_timeout;
355 new_clone->rcv_timeout= source->rcv_timeout;
356
357 new_clone->on_clone= source->on_clone;
358 new_clone->on_cleanup= source->on_cleanup;
359
360 new_clone->allocators= source->allocators;
361
362 new_clone->get_key_failure= source->get_key_failure;
363 new_clone->delete_trigger= source->delete_trigger;
364 new_clone->server_failure_limit= source->server_failure_limit;
365 new_clone->io_msg_watermark= source->io_msg_watermark;
366 new_clone->io_bytes_watermark= source->io_bytes_watermark;
367 new_clone->io_key_prefetch= source->io_key_prefetch;
368 new_clone->number_of_replicas= source->number_of_replicas;
369 new_clone->tcp_keepidle= source->tcp_keepidle;
370
371 if (memcached_server_count(source))
372 {
373 if (memcached_failed(memcached_push(new_clone, source)))
374 {
375 return NULL;
376 }
377 }
378
379
380 new_clone->_namespace= memcached_array_clone(new_clone, source->_namespace);
381 new_clone->configure.filename= memcached_array_clone(new_clone, source->_namespace);
382 new_clone->configure.version= source->configure.version;
383
384 if (LIBMEMCACHED_WITH_SASL_SUPPORT and source->sasl.callbacks)
385 {
386 if (memcached_failed(memcached_clone_sasl(new_clone, source)))
387 {
388 memcached_free(new_clone);
389 return NULL;
390 }
391 }
392
393 if (memcached_failed(run_distribution(new_clone)))
394 {
395 memcached_free(new_clone);
396
397 return NULL;
398 }
399
400 if (source->on_clone)
401 {
402 source->on_clone(new_clone, source);
403 }
404
405 return new_clone;
406 }
407
408 void *memcached_get_user_data(const memcached_st *shell)
409 {
410 const Memcached* memc= memcached2Memcached(shell);
411 if (memc)
412 {
413 return memc->user_data;
414 }
415
416 return NULL;
417 }
418
419 void *memcached_set_user_data(memcached_st *shell, void *data)
420 {
421 Memcached* memc= memcached2Memcached(shell);
422 if (memc)
423 {
424 void *ret= memc->user_data;
425 memc->user_data= data;
426
427 return ret;
428 }
429
430 return NULL;
431 }
432
433 memcached_return_t memcached_push(memcached_st *destination, const memcached_st *source)
434 {
435 return memcached_instance_push(destination, (org::libmemcached::Instance*)source->servers, source->number_of_hosts);
436 }
437
438 org::libmemcached::Instance* memcached_instance_fetch(Memcached *ptr, uint32_t server_key)
439 {
440 if (ptr == NULL)
441 {
442 return NULL;
443 }
444
445 return &ptr->servers[server_key];
446 }
447
448 memcached_server_instance_st memcached_server_instance_by_position(const memcached_st *shell, uint32_t server_key)
449 {
450 const Memcached* memc= memcached2Memcached(shell);
451 if (memc)
452 {
453 return &memc->servers[server_key];
454 }
455
456 return NULL;
457 }
458
459 org::libmemcached::Instance* memcached_instance_by_position(const memcached_st *shell, uint32_t server_key)
460 {
461 const Memcached* memc= memcached2Memcached(shell);
462 if (memc)
463 {
464 return &memc->servers[server_key];
465 }
466
467 return NULL;
468 }
469
470 uint64_t memcached_query_id(const memcached_st *shell)
471 {
472 const Memcached* memc= memcached2Memcached(shell);
473 if (memc)
474 {
475 return memc->query_id;
476 }
477
478 return 0;
479 }
480
481 org::libmemcached::Instance* memcached_instance_list(const memcached_st *shell)
482 {
483 const Memcached* memc= memcached2Memcached(shell);
484 if (memc)
485 {
486 return (org::libmemcached::Instance*)memc->servers;
487 }
488
489 return NULL;
490 }
491