2 +--------------------------------------------------------------------+
3 | libmemcached - C/C++ Client Library for memcached |
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted under the terms of the BSD license. |
7 | You should have received a copy of the license in a bundled file |
8 | named LICENSE; in case you did not receive a copy you can review |
9 | the terms online at: https://opensource.org/licenses/BSD-3-Clause |
10 +--------------------------------------------------------------------+
11 | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ |
12 | Copyright (c) 2020 Michael Wallner <mike@php.net> |
13 +--------------------------------------------------------------------+
16 #include "libmemcached/common.h"
18 #include "libmemcached/options.hpp"
19 #include "libmemcached/virtual_bucket.h"
21 static inline bool _memcached_init(Memcached
*self
) {
22 self
->state
.is_purging
= false;
23 self
->state
.is_processing_input
= false;
24 self
->state
.is_time_for_rebuild
= false;
25 self
->state
.is_parsing
= false;
27 self
->flags
.auto_eject_hosts
= false;
28 self
->flags
.binary_protocol
= false;
29 self
->flags
.buffer_requests
= false;
30 self
->flags
.hash_with_namespace
= false;
31 self
->flags
.no_block
= false;
32 self
->flags
.reply
= true;
33 self
->flags
.randomize_replica_read
= false;
34 self
->flags
.support_cas
= false;
35 self
->flags
.tcp_nodelay
= false;
36 self
->flags
.use_sort_hosts
= false;
37 self
->flags
.use_udp
= false;
38 self
->flags
.verify_key
= false;
39 self
->flags
.tcp_keepalive
= false;
40 self
->flags
.is_aes
= false;
41 self
->flags
.is_fetching_version
= false;
43 self
->virtual_bucket
= NULL
;
45 self
->distribution
= MEMCACHED_DISTRIBUTION_MODULA
;
47 if (hashkit_create(&self
->hashkit
) == NULL
) {
51 self
->server_info
.version
= 0;
53 self
->ketama
.continuum
= NULL
;
54 self
->ketama
.continuum_count
= 0;
55 self
->ketama
.continuum_points_counter
= 0;
56 self
->ketama
.next_distribution_rebuild
= 0;
57 self
->ketama
.weighted_
= false;
59 self
->number_of_hosts
= 0;
61 self
->last_disconnected_server
= NULL
;
63 self
->snd_timeout
= 0;
64 self
->rcv_timeout
= 0;
65 self
->server_failure_limit
= MEMCACHED_SERVER_FAILURE_LIMIT
;
66 self
->server_timeout_limit
= MEMCACHED_SERVER_TIMEOUT_LIMIT
;
67 self
->query_id
= 1; // 0 is considered invalid
69 /* TODO, Document why we picked these defaults */
70 self
->io_msg_watermark
= 500;
71 self
->io_bytes_watermark
= 65 * 1024;
73 self
->tcp_keepidle
= 0;
75 self
->io_key_prefetch
= 0;
76 self
->poll_timeout
= MEMCACHED_DEFAULT_TIMEOUT
;
77 self
->connect_timeout
= MEMCACHED_DEFAULT_CONNECT_TIMEOUT
;
78 self
->retry_timeout
= MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT
;
79 self
->dead_timeout
= MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT
;
84 self
->user_data
= NULL
;
85 self
->number_of_replicas
= 0;
87 self
->allocators
= memcached_allocators_return_default();
89 self
->on_clone
= NULL
;
90 self
->on_cleanup
= NULL
;
91 self
->get_key_failure
= NULL
;
92 self
->delete_trigger
= NULL
;
93 self
->callbacks
= NULL
;
94 self
->sasl
.callbacks
= NULL
;
95 self
->sasl
.is_allocated
= false;
97 self
->error_messages
= NULL
;
98 self
->_namespace
= NULL
;
99 self
->configure
.initial_pool_size
= 1;
100 self
->configure
.max_pool_size
= 1;
101 self
->configure
.version
= -1;
102 self
->configure
.filename
= NULL
;
107 static void memcached_free_ex(Memcached
*ptr
, bool release_st
) {
108 /* If we have anything open, lets close it now */
110 memcached_instance_list_free(memcached_instance_list(ptr
), memcached_instance_list_count(ptr
));
111 memcached_result_free(&ptr
->result
);
113 memcached_virtual_bucket_free(ptr
);
115 memcached_instance_free((memcached_instance_st
*) ptr
->last_disconnected_server
);
117 if (ptr
->on_cleanup
) {
118 ptr
->on_cleanup(ptr
);
121 libmemcached_free(ptr
, ptr
->ketama
.continuum
);
122 ptr
->ketama
.continuum
= NULL
;
124 memcached_array_free(ptr
->_namespace
);
125 ptr
->_namespace
= NULL
;
127 memcached_error_free(*ptr
);
129 if (LIBMEMCACHED_WITH_SASL_SUPPORT
and ptr
->sasl
.callbacks
) {
130 memcached_destroy_sasl_auth_data(ptr
);
134 memcached_array_free(ptr
->configure
.filename
);
135 ptr
->configure
.filename
= NULL
;
138 hashkit_free(&ptr
->hashkit
);
140 if (memcached_is_allocated(ptr
) and release_st
) {
141 libmemcached_free(ptr
, ptr
);
145 memcached_st
*memcached_create(memcached_st
*shell
) {
147 shell
->options
.is_allocated
= false;
149 shell
= (memcached_st
*) libmemcached_xmalloc(NULL
, memcached_st
);
152 return NULL
; /* MEMCACHED_MEMORY_ALLOCATION_FAILURE */
155 shell
->options
.is_allocated
= true;
158 if (_memcached_init(shell
) == false) {
159 memcached_free(shell
);
163 Memcached
*memc
= memcached2Memcached(shell
);
164 if (memcached_result_create(shell
, &memc
->result
) == NULL
) {
165 memcached_free(shell
);
169 WATCHPOINT_ASSERT_INITIALIZED(&memc
->result
);
174 memcached_st
*memcached(const char *string
, size_t length
) {
175 if (length
== 0 and string
) {
179 if (length
and string
== NULL
) {
184 if (bool(getenv("LIBMEMCACHED"))) {
185 string
= getenv("LIBMEMCACHED");
186 length
= string
? strlen(string
) : 0;
190 memcached_st
*memc
= memcached_create(NULL
);
195 if (length
== 0 or string
== NULL
) {
199 memcached_return_t rc
= memcached_parse_configuration(memc
, string
, length
);
200 if (memcached_success(rc
) and memcached_parse_filename(memc
)) {
201 rc
= memcached_parse_configure_file(*memc
, memcached_parse_filename(memc
),
202 memcached_parse_filename_length(memc
));
205 if (memcached_failed(rc
)) {
206 memcached_free(memc
);
213 memcached_return_t
memcached_reset(memcached_st
*shell
) {
214 Memcached
*ptr
= memcached2Memcached(shell
);
215 WATCHPOINT_ASSERT(ptr
);
217 return MEMCACHED_INVALID_ARGUMENTS
;
220 bool stored_is_allocated
= memcached_is_allocated(ptr
);
221 uint64_t query_id
= ptr
->query_id
;
222 memcached_free_ex(ptr
, false);
223 memcached_create(ptr
);
224 memcached_set_allocated(ptr
, stored_is_allocated
);
225 ptr
->query_id
= query_id
;
227 if (ptr
->configure
.filename
) {
228 return memcached_parse_configure_file(*ptr
, memcached_param_array(ptr
->configure
.filename
));
231 return MEMCACHED_SUCCESS
;
234 void memcached_servers_reset(memcached_st
*shell
) {
235 Memcached
*self
= memcached2Memcached(shell
);
237 libmemcached_free(self
, self
->ketama
.continuum
);
238 self
->ketama
.continuum
= NULL
;
239 self
->ketama
.continuum_count
= 0;
240 self
->ketama
.continuum_points_counter
= 0;
242 memcached_instance_list_free(memcached_instance_list(self
), self
->number_of_hosts
);
243 memcached_instance_set(self
, NULL
, 0);
245 memcached_reset_last_disconnected_server(self
);
249 void memcached_reset_last_disconnected_server(memcached_st
*shell
) {
250 Memcached
*self
= memcached2Memcached(shell
);
252 memcached_instance_free((memcached_instance_st
*) self
->last_disconnected_server
);
253 self
->last_disconnected_server
= NULL
;
257 void memcached_free(memcached_st
*ptr
) {
259 memcached_free_ex(ptr
, true);
264 clone is the destination, while source is the structure to clone.
265 If source is NULL the call is the same as if a memcached_create() was
268 memcached_st
*memcached_clone(memcached_st
*clone
, const memcached_st
*source
) {
269 if (source
== NULL
) {
270 return memcached_create(clone
);
273 if (clone
and memcached_is_allocated(clone
)) {
277 memcached_st
*new_clone
= memcached_create(clone
);
279 if (new_clone
== NULL
) {
283 new_clone
->flags
= source
->flags
;
284 new_clone
->send_size
= source
->send_size
;
285 new_clone
->recv_size
= source
->recv_size
;
286 new_clone
->poll_timeout
= source
->poll_timeout
;
287 new_clone
->connect_timeout
= source
->connect_timeout
;
288 new_clone
->retry_timeout
= source
->retry_timeout
;
289 new_clone
->dead_timeout
= source
->dead_timeout
;
290 new_clone
->distribution
= source
->distribution
;
292 if (hashkit_clone(&new_clone
->hashkit
, &source
->hashkit
) == NULL
) {
293 memcached_free(new_clone
);
297 new_clone
->user_data
= source
->user_data
;
299 new_clone
->snd_timeout
= source
->snd_timeout
;
300 new_clone
->rcv_timeout
= source
->rcv_timeout
;
302 new_clone
->on_clone
= source
->on_clone
;
303 new_clone
->on_cleanup
= source
->on_cleanup
;
305 new_clone
->allocators
= source
->allocators
;
307 new_clone
->get_key_failure
= source
->get_key_failure
;
308 new_clone
->delete_trigger
= source
->delete_trigger
;
309 new_clone
->server_failure_limit
= source
->server_failure_limit
;
310 new_clone
->server_timeout_limit
= source
->server_timeout_limit
;
311 new_clone
->io_msg_watermark
= source
->io_msg_watermark
;
312 new_clone
->io_bytes_watermark
= source
->io_bytes_watermark
;
313 new_clone
->io_key_prefetch
= source
->io_key_prefetch
;
314 new_clone
->number_of_replicas
= source
->number_of_replicas
;
315 new_clone
->tcp_keepidle
= source
->tcp_keepidle
;
317 if (memcached_server_count(source
)) {
318 if (memcached_failed(memcached_push(new_clone
, source
))) {
323 new_clone
->_namespace
= memcached_array_clone(new_clone
, source
->_namespace
);
324 new_clone
->configure
.filename
= memcached_array_clone(new_clone
, source
->_namespace
);
325 new_clone
->configure
.version
= source
->configure
.version
;
327 if (LIBMEMCACHED_WITH_SASL_SUPPORT
and source
->sasl
.callbacks
) {
328 if (memcached_failed(memcached_clone_sasl(new_clone
, source
))) {
329 memcached_free(new_clone
);
334 if (memcached_failed(run_distribution(new_clone
))) {
335 memcached_free(new_clone
);
340 if (source
->on_clone
) {
341 source
->on_clone(new_clone
, source
);
347 void *memcached_get_user_data(const memcached_st
*shell
) {
348 const Memcached
*memc
= memcached2Memcached(shell
);
350 return memc
->user_data
;
356 void *memcached_set_user_data(memcached_st
*shell
, void *data
) {
357 Memcached
*memc
= memcached2Memcached(shell
);
359 void *ret
= memc
->user_data
;
360 memc
->user_data
= data
;
368 memcached_return_t
memcached_push(memcached_st
*destination
, const memcached_st
*source
) {
369 return memcached_instance_push(destination
, (memcached_instance_st
*) source
->servers
,
370 source
->number_of_hosts
);
373 memcached_instance_st
*memcached_instance_fetch(Memcached
*ptr
, uint32_t server_key
) {
378 return &ptr
->servers
[server_key
];
381 const memcached_instance_st
*memcached_server_instance_by_position(const memcached_st
*shell
,
382 uint32_t server_key
) {
383 const Memcached
*memc
= memcached2Memcached(shell
);
385 return &memc
->servers
[server_key
];
391 memcached_instance_st
*memcached_instance_by_position(const memcached_st
*shell
,
392 uint32_t server_key
) {
393 const Memcached
*memc
= memcached2Memcached(shell
);
395 return &memc
->servers
[server_key
];
401 uint64_t memcached_query_id(const memcached_st
*shell
) {
402 const Memcached
*memc
= memcached2Memcached(shell
);
404 return memc
->query_id
;
410 memcached_instance_st
*memcached_instance_list(const memcached_st
*shell
) {
411 const Memcached
*memc
= memcached2Memcached(shell
);
413 return (memcached_instance_st
*) memc
->servers
;