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