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;
91 /* TODO, Document why we picked these defaults */
92 self
->io_msg_watermark
= 500;
93 self
->io_bytes_watermark
= 65 * 1024;
95 self
->tcp_keepidle
= 0;
97 self
->io_key_prefetch
= 0;
98 self
->poll_timeout
= MEMCACHED_DEFAULT_TIMEOUT
;
99 self
->connect_timeout
= MEMCACHED_DEFAULT_CONNECT_TIMEOUT
;
100 self
->retry_timeout
= 0;
105 self
->user_data
= NULL
;
106 self
->number_of_replicas
= 0;
107 hash_ptr
= hashkit_create(&self
->distribution_hashkit
);
111 self
->allocators
= memcached_allocators_return_default();
113 self
->on_clone
= NULL
;
114 self
->on_cleanup
= NULL
;
115 self
->get_key_failure
= NULL
;
116 self
->delete_trigger
= NULL
;
117 self
->callbacks
= NULL
;
118 self
->sasl
.callbacks
= NULL
;
119 self
->sasl
.is_allocated
= false;
121 self
->error_messages
= NULL
;
122 self
->prefix_key
= NULL
;
123 self
->configure
.filename
= NULL
;
128 static void _free(memcached_st
*ptr
, bool release_st
)
130 /* If we have anything open, lets close it now */
132 memcached_server_list_free(memcached_server_list(ptr
));
133 memcached_result_free(&ptr
->result
);
135 memcached_virtual_bucket_free(ptr
);
137 if (ptr
->last_disconnected_server
)
138 memcached_server_free(ptr
->last_disconnected_server
);
141 ptr
->on_cleanup(ptr
);
143 if (ptr
->ketama
.continuum
)
144 libmemcached_free(ptr
, ptr
->ketama
.continuum
);
146 memcached_array_free(ptr
->prefix_key
);
147 ptr
->prefix_key
= NULL
;
149 memcached_error_free(ptr
);
151 if (ptr
->sasl
.callbacks
)
153 #ifdef LIBMEMCACHED_WITH_SASL_SUPPORT
154 memcached_destroy_sasl_auth_data(ptr
);
160 memcached_array_free(ptr
->configure
.filename
);
161 ptr
->configure
.filename
= NULL
;
164 if (memcached_is_allocated(ptr
) && release_st
)
166 libmemcached_free(ptr
, ptr
);
170 memcached_st
*memcached_create(memcached_st
*ptr
)
174 ptr
= (memcached_st
*)malloc(sizeof(memcached_st
));
178 return NULL
; /* MEMCACHED_MEMORY_ALLOCATION_FAILURE */
181 ptr
->options
.is_allocated
= true;
185 ptr
->options
.is_allocated
= false;
189 memcached_set_purging(ptr
, false);
190 memcached_set_processing_input(ptr
, false);
193 if (! _memcached_init(ptr
))
199 if (! memcached_result_create(ptr
, &ptr
->result
))
205 WATCHPOINT_ASSERT_INITIALIZED(&ptr
->result
);
210 memcached_st
*memcached_create_with_options(const char *string
, size_t length
)
212 memcached_st
*self
= memcached_create(NULL
);
217 memcached_return_t rc
;
218 if ((rc
= memcached_parse_configuration(self
, string
, length
)) != MEMCACHED_SUCCESS
)
223 if (memcached_parse_filename(self
))
225 rc
= memcached_parse_configure_file(self
, memcached_parse_filename(self
), memcached_parse_filename_length(self
));
231 memcached_return_t
memcached_reset(memcached_st
*ptr
)
233 WATCHPOINT_ASSERT(ptr
);
235 return MEMCACHED_INVALID_ARGUMENTS
;
237 bool stored_is_allocated
= memcached_is_allocated(ptr
);
238 uint64_t query_id
= ptr
->query_id
;
240 memcached_create(ptr
);
241 memcached_set_allocated(ptr
, stored_is_allocated
);
242 ptr
->query_id
= query_id
;
244 if (ptr
->configure
.filename
)
246 return memcached_parse_configure_file(ptr
, memcached_param_array(ptr
->configure
.filename
));
249 return MEMCACHED_SUCCESS
;
252 void memcached_servers_reset(memcached_st
*ptr
)
254 memcached_server_list_free(memcached_server_list(ptr
));
256 memcached_server_list_set(ptr
, NULL
);
257 ptr
->number_of_hosts
= 0;
258 if (ptr
->last_disconnected_server
)
260 memcached_server_free(ptr
->last_disconnected_server
);
262 ptr
->last_disconnected_server
= NULL
;
263 ptr
->server_failure_limit
= 0;
266 void memcached_reset_last_disconnected_server(memcached_st
*ptr
)
268 if (ptr
->last_disconnected_server
)
270 memcached_server_free(ptr
->last_disconnected_server
);
271 ptr
->last_disconnected_server
= NULL
;
275 void memcached_free(memcached_st
*ptr
)
281 clone is the destination, while source is the structure to clone.
282 If source is NULL the call is the same as if a memcached_create() was
285 memcached_st
*memcached_clone(memcached_st
*clone
, const memcached_st
*source
)
287 memcached_return_t rc
= MEMCACHED_SUCCESS
;
288 memcached_st
*new_clone
;
291 return memcached_create(clone
);
293 if (clone
&& memcached_is_allocated(clone
))
298 new_clone
= memcached_create(clone
);
300 if (new_clone
== NULL
)
303 new_clone
->flags
= source
->flags
;
304 new_clone
->send_size
= source
->send_size
;
305 new_clone
->recv_size
= source
->recv_size
;
306 new_clone
->poll_timeout
= source
->poll_timeout
;
307 new_clone
->connect_timeout
= source
->connect_timeout
;
308 new_clone
->retry_timeout
= source
->retry_timeout
;
309 new_clone
->distribution
= source
->distribution
;
311 hashkit_st
*hash_ptr
;
313 hash_ptr
= hashkit_clone(&new_clone
->hashkit
, &source
->hashkit
);
316 memcached_free(new_clone
);
320 hash_ptr
= hashkit_clone(&new_clone
->distribution_hashkit
, &source
->distribution_hashkit
);
323 memcached_free(new_clone
);
327 new_clone
->user_data
= source
->user_data
;
329 new_clone
->snd_timeout
= source
->snd_timeout
;
330 new_clone
->rcv_timeout
= source
->rcv_timeout
;
332 new_clone
->on_clone
= source
->on_clone
;
333 new_clone
->on_cleanup
= source
->on_cleanup
;
335 new_clone
->allocators
= source
->allocators
;
337 new_clone
->get_key_failure
= source
->get_key_failure
;
338 new_clone
->delete_trigger
= source
->delete_trigger
;
339 new_clone
->server_failure_limit
= source
->server_failure_limit
;
340 new_clone
->io_msg_watermark
= source
->io_msg_watermark
;
341 new_clone
->io_bytes_watermark
= source
->io_bytes_watermark
;
342 new_clone
->io_key_prefetch
= source
->io_key_prefetch
;
343 new_clone
->number_of_replicas
= source
->number_of_replicas
;
344 new_clone
->tcp_keepidle
= source
->tcp_keepidle
;
346 if (memcached_server_count(source
))
347 rc
= memcached_push(new_clone
, source
);
349 if (rc
!= MEMCACHED_SUCCESS
)
351 memcached_free(new_clone
);
357 new_clone
->prefix_key
= memcached_array_clone(new_clone
, source
->prefix_key
);
359 #ifdef LIBMEMCACHED_WITH_SASL_SUPPORT
360 if (source
->sasl
.callbacks
)
362 if (memcached_clone_sasl(new_clone
, source
) != MEMCACHED_SUCCESS
)
364 memcached_free(new_clone
);
370 rc
= run_distribution(new_clone
);
372 if (rc
!= MEMCACHED_SUCCESS
)
374 memcached_free(new_clone
);
379 if (source
->on_clone
)
380 source
->on_clone(new_clone
, source
);
385 void *memcached_get_user_data(const memcached_st
*ptr
)
387 return ptr
->user_data
;
390 void *memcached_set_user_data(memcached_st
*ptr
, void *data
)
392 void *ret
= ptr
->user_data
;
393 ptr
->user_data
= data
;
398 memcached_return_t
memcached_push(memcached_st
*destination
, const memcached_st
*source
)
400 return memcached_server_push(destination
, source
->servers
);
403 memcached_server_write_instance_st
memcached_server_instance_fetch(memcached_st
*ptr
, uint32_t server_key
)
405 return &ptr
->servers
[server_key
];
408 memcached_server_instance_st
memcached_server_instance_by_position(const memcached_st
*ptr
, uint32_t server_key
)
410 return &ptr
->servers
[server_key
];