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