Merge in changes around setting up better syntax for distribution.
[m6w6/libmemcached] / libmemcached / memcached.c
1 /* LibMemcached
2 * Copyright (C) 2006-2010 Brian Aker
3 * All rights reserved.
4 *
5 * Use and distribution licensed under the BSD license. See
6 * the COPYING file in the parent directory for full text.
7 *
8 * Summary:
9 *
10 */
11
12 #include "common.h"
13
14 static const memcached_st global_copy= {
15 .state= {
16 .is_purging= false,
17 .is_processing_input= false,
18 .is_time_for_rebuild= false,
19 },
20 .flags= {
21 .auto_eject_hosts= false,
22 .binary_protocol= false,
23 .buffer_requests= false,
24 .hash_with_prefix_key= false,
25 .no_block= false,
26 .no_reply= false,
27 .randomize_replica_read= false,
28 .reuse_memory= false,
29 .support_cas= false,
30 .tcp_nodelay= false,
31 .use_cache_lookups= false,
32 .use_sort_hosts= false,
33 .use_udp= false,
34 .verify_key= false,
35 .tcp_keepalive= false,
36 }
37 };
38
39 static inline bool _memcached_init(memcached_st *self)
40 {
41 self->state= global_copy.state;
42 self->flags= global_copy.flags;
43
44 self->distribution= MEMCACHED_DISTRIBUTION_MODULA;
45
46 hashkit_st *hash_ptr;
47 hash_ptr= hashkit_create(&self->hashkit);
48 if (! hash_ptr)
49 return false;
50
51 self->ketama.continuum= NULL;
52 self->ketama.continuum_count= 0;
53 self->ketama.continuum_points_counter= 0;
54 self->ketama.next_distribution_rebuild= 0;
55 self->ketama.weighted= false;
56
57 self->number_of_hosts= 0;
58 self->servers= NULL;
59 self->last_disconnected_server= NULL;
60
61 self->snd_timeout= 0;
62 self->rcv_timeout= 0;
63 self->server_failure_limit= 0;
64
65 /* TODO, Document why we picked these defaults */
66 self->io_msg_watermark= 500;
67 self->io_bytes_watermark= 65 * 1024;
68
69 self->tcp_keepidle= 0;
70
71 self->io_key_prefetch= 0;
72 self->poll_timeout= MEMCACHED_DEFAULT_TIMEOUT;
73 self->connect_timeout= MEMCACHED_DEFAULT_CONNECT_TIMEOUT;
74 self->retry_timeout= 0;
75
76 self->send_size= -1;
77 self->recv_size= -1;
78
79 self->user_data= NULL;
80 self->number_of_replicas= 0;
81 hash_ptr= hashkit_create(&self->distribution_hashkit);
82 if (! hash_ptr)
83 return false;
84
85 self->allocators= memcached_allocators_return_default();
86
87 self->on_clone= NULL;
88 self->on_cleanup= NULL;
89 self->get_key_failure= NULL;
90 self->delete_trigger= NULL;
91 self->callbacks= NULL;
92 self->sasl.callbacks= NULL;
93 self->sasl.is_allocated= false;
94
95 self->error_messages= NULL;
96 self->prefix_key= NULL;
97 self->configure.filename= NULL;
98
99 return true;
100 }
101
102 static void _free(memcached_st *ptr, bool release_st)
103 {
104 /* If we have anything open, lets close it now */
105 memcached_quit(ptr);
106 memcached_server_list_free(memcached_server_list(ptr));
107 memcached_result_free(&ptr->result);
108
109 if (ptr->last_disconnected_server)
110 memcached_server_free(ptr->last_disconnected_server);
111
112 if (ptr->on_cleanup)
113 ptr->on_cleanup(ptr);
114
115 if (ptr->ketama.continuum)
116 libmemcached_free(ptr, ptr->ketama.continuum);
117
118 memcached_array_free(ptr->prefix_key);
119 ptr->prefix_key= NULL;
120
121 memcached_error_free(ptr);
122
123 if (ptr->sasl.callbacks)
124 {
125 #ifdef LIBMEMCACHED_WITH_SASL_SUPPORT
126 memcached_destroy_sasl_auth_data(ptr);
127 #endif
128 }
129
130 if (release_st)
131 {
132 memcached_array_free(ptr->configure.filename);
133 ptr->configure.filename= NULL;
134 }
135
136 if (memcached_is_allocated(ptr) && release_st)
137 {
138 libmemcached_free(ptr, ptr);
139 }
140 }
141
142 memcached_st *memcached_create(memcached_st *ptr)
143 {
144 if (ptr == NULL)
145 {
146 ptr= (memcached_st *)malloc(sizeof(memcached_st));
147
148 if (! ptr)
149 {
150 return NULL; /* MEMCACHED_MEMORY_ALLOCATION_FAILURE */
151 }
152
153 ptr->options.is_allocated= true;
154 }
155 else
156 {
157 ptr->options.is_allocated= false;
158 }
159
160 #if 0
161 memcached_set_purging(ptr, false);
162 memcached_set_processing_input(ptr, false);
163 #endif
164
165 if (! _memcached_init(ptr))
166 {
167 memcached_free(ptr);
168 return NULL;
169 }
170
171 if (! memcached_result_create(ptr, &ptr->result))
172 {
173 memcached_free(ptr);
174 return NULL;
175 }
176
177 WATCHPOINT_ASSERT_INITIALIZED(&ptr->result);
178
179 return ptr;
180 }
181
182 memcached_st *memcached_create_with_options(const char *string, size_t length)
183 {
184 memcached_st *self= memcached_create(NULL);
185
186 if (! self)
187 return NULL;
188
189 memcached_return_t rc;
190 if ((rc= memcached_parse_configuration(self, string, length)) != MEMCACHED_SUCCESS)
191 {
192 return self;
193 }
194
195 if (memcached_parse_filename(self))
196 {
197 rc= memcached_parse_configure_file(self, memcached_parse_filename(self), memcached_parse_filename_length(self));
198 }
199
200 return self;
201 }
202
203 memcached_return_t memcached_reset(memcached_st *ptr)
204 {
205 WATCHPOINT_ASSERT(ptr);
206 if (! ptr)
207 return MEMCACHED_INVALID_ARGUMENTS;
208
209 bool stored_is_allocated= memcached_is_allocated(ptr);
210 _free(ptr, false);
211 memcached_create(ptr);
212 memcached_set_allocated(ptr, stored_is_allocated);
213
214 if (ptr->configure.filename)
215 {
216 return memcached_parse_configure_file(ptr, memcached_param_array(ptr->configure.filename));
217 }
218
219 return MEMCACHED_SUCCESS;
220 }
221
222 void memcached_servers_reset(memcached_st *ptr)
223 {
224 memcached_server_list_free(memcached_server_list(ptr));
225
226 memcached_server_list_set(ptr, NULL);
227 ptr->number_of_hosts= 0;
228 if (ptr->last_disconnected_server)
229 {
230 memcached_server_free(ptr->last_disconnected_server);
231 }
232 ptr->last_disconnected_server= NULL;
233 ptr->server_failure_limit= 0;
234 }
235
236 void memcached_reset_last_disconnected_server(memcached_st *ptr)
237 {
238 if (ptr->last_disconnected_server)
239 {
240 memcached_server_free(ptr->last_disconnected_server);
241 ptr->last_disconnected_server= NULL;
242 }
243 }
244
245 void memcached_free(memcached_st *ptr)
246 {
247 _free(ptr, true);
248 }
249
250 /*
251 clone is the destination, while source is the structure to clone.
252 If source is NULL the call is the same as if a memcached_create() was
253 called.
254 */
255 memcached_st *memcached_clone(memcached_st *clone, const memcached_st *source)
256 {
257 memcached_return_t rc= MEMCACHED_SUCCESS;
258 memcached_st *new_clone;
259
260 if (source == NULL)
261 return memcached_create(clone);
262
263 if (clone && memcached_is_allocated(clone))
264 {
265 return NULL;
266 }
267
268 new_clone= memcached_create(clone);
269
270 if (new_clone == NULL)
271 return NULL;
272
273 new_clone->flags= source->flags;
274 new_clone->send_size= source->send_size;
275 new_clone->recv_size= source->recv_size;
276 new_clone->poll_timeout= source->poll_timeout;
277 new_clone->connect_timeout= source->connect_timeout;
278 new_clone->retry_timeout= source->retry_timeout;
279 new_clone->distribution= source->distribution;
280
281 hashkit_st *hash_ptr;
282
283 hash_ptr= hashkit_clone(&new_clone->hashkit, &source->hashkit);
284 if (! hash_ptr)
285 {
286 memcached_free(new_clone);
287 return NULL;
288 }
289
290 hash_ptr= hashkit_clone(&new_clone->distribution_hashkit, &source->distribution_hashkit);
291 if (! hash_ptr)
292 {
293 memcached_free(new_clone);
294 return NULL;
295 }
296
297 new_clone->user_data= source->user_data;
298
299 new_clone->snd_timeout= source->snd_timeout;
300 new_clone->rcv_timeout= source->rcv_timeout;
301
302 new_clone->on_clone= source->on_clone;
303 new_clone->on_cleanup= source->on_cleanup;
304
305 new_clone->allocators= source->allocators;
306
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->io_msg_watermark= source->io_msg_watermark;
311 new_clone->io_bytes_watermark= source->io_bytes_watermark;
312 new_clone->io_key_prefetch= source->io_key_prefetch;
313 new_clone->number_of_replicas= source->number_of_replicas;
314 new_clone->tcp_keepidle= source->tcp_keepidle;
315
316 if (memcached_server_count(source))
317 rc= memcached_push(new_clone, source);
318
319 if (rc != MEMCACHED_SUCCESS)
320 {
321 memcached_free(new_clone);
322
323 return NULL;
324 }
325
326
327 new_clone->prefix_key= memcached_array_clone(new_clone, source->prefix_key);
328
329 #ifdef LIBMEMCACHED_WITH_SASL_SUPPORT
330 if (source->sasl.callbacks)
331 {
332 if (memcached_clone_sasl(new_clone, source) != MEMCACHED_SUCCESS)
333 {
334 memcached_free(new_clone);
335 return NULL;
336 }
337 }
338 #endif
339
340 rc= run_distribution(new_clone);
341
342 if (rc != MEMCACHED_SUCCESS)
343 {
344 memcached_free(new_clone);
345
346 return NULL;
347 }
348
349 if (source->on_clone)
350 source->on_clone(new_clone, source);
351
352 return new_clone;
353 }
354
355 void *memcached_get_user_data(const memcached_st *ptr)
356 {
357 return ptr->user_data;
358 }
359
360 void *memcached_set_user_data(memcached_st *ptr, void *data)
361 {
362 void *ret= ptr->user_data;
363 ptr->user_data= data;
364
365 return ret;
366 }
367
368 memcached_return_t memcached_push(memcached_st *destination, const memcached_st *source)
369 {
370 return memcached_server_push(destination, source->servers);
371 }
372
373 memcached_server_write_instance_st memcached_server_instance_fetch(memcached_st *ptr, uint32_t server_key)
374 {
375 return &ptr->servers[server_key];
376 }
377
378 memcached_server_instance_st memcached_server_instance_by_position(const memcached_st *ptr, uint32_t server_key)
379 {
380 return &ptr->servers[server_key];
381 }