1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
20 * * The names of its contributors may not be used to endorse or
21 * promote products derived from this software without specific prior
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.
38 #include <libmemcached/common.h>
39 #include <libmemcached/virtual_bucket.h>
41 static const memcached_st global_copy
= {
44 .is_processing_input
= false,
45 .is_time_for_rebuild
= false,
48 .auto_eject_hosts
= false,
49 .binary_protocol
= false,
50 .buffer_requests
= false,
51 .hash_with_prefix_key
= false,
54 .randomize_replica_read
= false,
57 .use_sort_hosts
= false,
60 .tcp_keepalive
= false,
64 static inline bool _memcached_init(memcached_st
*self
)
66 self
->state
= global_copy
.state
;
67 self
->flags
= global_copy
.flags
;
68 self
->virtual_bucket
= NULL
;
70 self
->distribution
= MEMCACHED_DISTRIBUTION_MODULA
;
73 hash_ptr
= hashkit_create(&self
->hashkit
);
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;
83 self
->number_of_hosts
= 0;
85 self
->last_disconnected_server
= NULL
;
89 self
->server_failure_limit
= 0;
92 /* TODO, Document why we picked these defaults */
93 self
->io_msg_watermark
= 500;
94 self
->io_bytes_watermark
= 65 * 1024;
96 self
->tcp_keepidle
= 0;
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
= 0;
106 self
->user_data
= NULL
;
107 self
->number_of_replicas
= 0;
108 hash_ptr
= hashkit_create(&self
->distribution_hashkit
);
112 self
->allocators
= memcached_allocators_return_default();
114 self
->on_clone
= NULL
;
115 self
->on_cleanup
= NULL
;
116 self
->get_key_failure
= NULL
;
117 self
->delete_trigger
= NULL
;
118 self
->callbacks
= NULL
;
119 self
->sasl
.callbacks
= NULL
;
120 self
->sasl
.is_allocated
= false;
122 self
->error_messages
= NULL
;
123 self
->prefix_key
= NULL
;
124 self
->configure
.initial_pool_size
= 1;
125 self
->configure
.max_pool_size
= 1;
126 self
->configure
.filename
= NULL
;
131 static void _free(memcached_st
*ptr
, bool release_st
)
133 /* If we have anything open, lets close it now */
135 memcached_server_list_free(memcached_server_list(ptr
));
136 memcached_result_free(&ptr
->result
);
138 memcached_virtual_bucket_free(ptr
);
140 if (ptr
->last_disconnected_server
)
141 memcached_server_free(ptr
->last_disconnected_server
);
144 ptr
->on_cleanup(ptr
);
146 if (ptr
->ketama
.continuum
)
147 libmemcached_free(ptr
, ptr
->ketama
.continuum
);
149 memcached_array_free(ptr
->prefix_key
);
150 ptr
->prefix_key
= NULL
;
152 memcached_error_free(ptr
);
154 if (ptr
->sasl
.callbacks
)
156 #ifdef LIBMEMCACHED_WITH_SASL_SUPPORT
157 memcached_destroy_sasl_auth_data(ptr
);
163 memcached_array_free(ptr
->configure
.filename
);
164 ptr
->configure
.filename
= NULL
;
167 if (memcached_is_allocated(ptr
) && release_st
)
169 libmemcached_free(ptr
, ptr
);
173 memcached_st
*memcached_create(memcached_st
*ptr
)
177 ptr
= (memcached_st
*)malloc(sizeof(memcached_st
));
181 return NULL
; /* MEMCACHED_MEMORY_ALLOCATION_FAILURE */
184 ptr
->options
.is_allocated
= true;
188 ptr
->options
.is_allocated
= false;
192 memcached_set_purging(ptr
, false);
193 memcached_set_processing_input(ptr
, false);
196 if (! _memcached_init(ptr
))
202 if (! memcached_result_create(ptr
, &ptr
->result
))
208 WATCHPOINT_ASSERT_INITIALIZED(&ptr
->result
);
213 memcached_st
*memcached_create_with_options(const char *string
, size_t length
)
215 if (! length
|| ! string
)
221 memcached_st
*self
= memcached_create(NULL
);
228 memcached_return_t rc
;
229 rc
= memcached_parse_configuration(self
, string
, length
);
231 if (rc
== MEMCACHED_SUCCESS
&& memcached_parse_filename(self
))
233 rc
= memcached_parse_configure_file(self
, memcached_parse_filename(self
), memcached_parse_filename_length(self
));
236 if (rc
!= MEMCACHED_SUCCESS
)
238 memcached_free(self
);
248 memcached_return_t
memcached_reset(memcached_st
*ptr
)
250 WATCHPOINT_ASSERT(ptr
);
252 return MEMCACHED_INVALID_ARGUMENTS
;
254 bool stored_is_allocated
= memcached_is_allocated(ptr
);
255 uint64_t query_id
= ptr
->query_id
;
257 memcached_create(ptr
);
258 memcached_set_allocated(ptr
, stored_is_allocated
);
259 ptr
->query_id
= query_id
;
261 if (ptr
->configure
.filename
)
263 return memcached_parse_configure_file(ptr
, memcached_param_array(ptr
->configure
.filename
));
266 return MEMCACHED_SUCCESS
;
269 void memcached_servers_reset(memcached_st
*ptr
)
274 memcached_server_list_free(memcached_server_list(ptr
));
276 memcached_server_list_set(ptr
, NULL
);
277 ptr
->number_of_hosts
= 0;
278 if (ptr
->last_disconnected_server
)
280 memcached_server_free(ptr
->last_disconnected_server
);
282 ptr
->last_disconnected_server
= NULL
;
283 ptr
->server_failure_limit
= 0;
286 void memcached_reset_last_disconnected_server(memcached_st
*ptr
)
291 if (ptr
->last_disconnected_server
)
293 memcached_server_free(ptr
->last_disconnected_server
);
294 ptr
->last_disconnected_server
= NULL
;
298 void memcached_free(memcached_st
*ptr
)
307 clone is the destination, while source is the structure to clone.
308 If source is NULL the call is the same as if a memcached_create() was
311 memcached_st
*memcached_clone(memcached_st
*clone
, const memcached_st
*source
)
313 memcached_return_t rc
= MEMCACHED_SUCCESS
;
314 memcached_st
*new_clone
;
317 return memcached_create(clone
);
319 if (clone
&& memcached_is_allocated(clone
))
324 new_clone
= memcached_create(clone
);
326 if (new_clone
== NULL
)
329 new_clone
->flags
= source
->flags
;
330 new_clone
->send_size
= source
->send_size
;
331 new_clone
->recv_size
= source
->recv_size
;
332 new_clone
->poll_timeout
= source
->poll_timeout
;
333 new_clone
->connect_timeout
= source
->connect_timeout
;
334 new_clone
->retry_timeout
= source
->retry_timeout
;
335 new_clone
->distribution
= source
->distribution
;
337 hashkit_st
*hash_ptr
;
339 hash_ptr
= hashkit_clone(&new_clone
->hashkit
, &source
->hashkit
);
342 memcached_free(new_clone
);
346 hash_ptr
= hashkit_clone(&new_clone
->distribution_hashkit
, &source
->distribution_hashkit
);
349 memcached_free(new_clone
);
353 new_clone
->user_data
= source
->user_data
;
355 new_clone
->snd_timeout
= source
->snd_timeout
;
356 new_clone
->rcv_timeout
= source
->rcv_timeout
;
358 new_clone
->on_clone
= source
->on_clone
;
359 new_clone
->on_cleanup
= source
->on_cleanup
;
361 new_clone
->allocators
= source
->allocators
;
363 new_clone
->get_key_failure
= source
->get_key_failure
;
364 new_clone
->delete_trigger
= source
->delete_trigger
;
365 new_clone
->server_failure_limit
= source
->server_failure_limit
;
366 new_clone
->io_msg_watermark
= source
->io_msg_watermark
;
367 new_clone
->io_bytes_watermark
= source
->io_bytes_watermark
;
368 new_clone
->io_key_prefetch
= source
->io_key_prefetch
;
369 new_clone
->number_of_replicas
= source
->number_of_replicas
;
370 new_clone
->tcp_keepidle
= source
->tcp_keepidle
;
372 if (memcached_server_count(source
))
373 rc
= memcached_push(new_clone
, source
);
375 if (rc
!= MEMCACHED_SUCCESS
)
377 memcached_free(new_clone
);
383 new_clone
->prefix_key
= memcached_array_clone(new_clone
, source
->prefix_key
);
385 #ifdef LIBMEMCACHED_WITH_SASL_SUPPORT
386 if (source
->sasl
.callbacks
)
388 if (memcached_clone_sasl(new_clone
, source
) != MEMCACHED_SUCCESS
)
390 memcached_free(new_clone
);
396 rc
= run_distribution(new_clone
);
398 if (rc
!= MEMCACHED_SUCCESS
)
400 memcached_free(new_clone
);
405 if (source
->on_clone
)
406 source
->on_clone(new_clone
, source
);
411 void *memcached_get_user_data(const memcached_st
*ptr
)
413 return ptr
->user_data
;
416 void *memcached_set_user_data(memcached_st
*ptr
, void *data
)
418 void *ret
= ptr
->user_data
;
419 ptr
->user_data
= data
;
424 memcached_return_t
memcached_push(memcached_st
*destination
, const memcached_st
*source
)
426 return memcached_server_push(destination
, source
->servers
);
429 memcached_server_write_instance_st
memcached_server_instance_fetch(memcached_st
*ptr
, uint32_t server_key
)
431 return &ptr
->servers
[server_key
];
434 memcached_server_instance_st
memcached_server_instance_by_position(const memcached_st
*ptr
, uint32_t server_key
)
436 return &ptr
->servers
[server_key
];