Add in test cases for --socket (and documentation).
[awesomized/libmemcached] / libmemcached / server.cc
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * Libmemcached library
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
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
18 * distribution.
19 *
20 * * The names of its contributors may not be used to endorse or
21 * promote products derived from this software without specific prior
22 * written permission.
23 *
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.
35 *
36 */
37
38 /*
39 This is a partial implementation for fetching/creating memcached_server_st objects.
40 */
41 #include <libmemcached/common.h>
42 #include <cassert>
43
44 static inline void _server_init(memcached_server_st *self, memcached_st *root,
45 const char *hostname, in_port_t port,
46 uint32_t weight, memcached_connection_t type)
47 {
48 self->options.is_shutting_down= false;
49 self->options.is_dead= false;
50 self->number_of_hosts= 0;
51 self->cursor_active= 0;
52 self->port= port;
53 self->cached_errno= 0;
54 self->fd= -1;
55 self->io_bytes_sent= 0;
56 self->server_failure_counter= 0;
57 self->weight= weight ? weight : 1; // 1 is the default weight value
58 WATCHPOINT_SET(self->io_wait_count.read= 0);
59 WATCHPOINT_SET(self->io_wait_count.write= 0);
60 self->major_version= UINT8_MAX;
61 self->micro_version= UINT8_MAX;
62 self->minor_version= UINT8_MAX;
63 self->type= type;
64 self->read_ptr= self->read_buffer;
65 self->cached_server_error= NULL;
66 self->read_buffer_length= 0;
67 self->read_data_length= 0;
68 self->write_buffer_offset= 0;
69 self->address_info= NULL;
70 self->address_info_next= NULL;
71
72 self->state= MEMCACHED_SERVER_STATE_NEW;
73
74 if (root)
75 {
76 self->next_retry= root->retry_timeout;
77 }
78 else
79 {
80 self->next_retry= 0;
81 }
82
83 self->root= root;
84 self->limit_maxbytes= 0;
85 if (hostname)
86 {
87 strncpy(self->hostname, hostname, NI_MAXHOST - 1);
88 }
89 else
90 {
91 self->hostname[0]= 0;
92 }
93 }
94
95 static memcached_server_st *_server_create(memcached_server_st *self, const memcached_st *memc)
96 {
97 if (not self)
98 {
99 self= (memcached_server_st *)libmemcached_malloc(memc, sizeof(memcached_server_st));
100
101 if (not self)
102 return NULL; /* MEMCACHED_MEMORY_ALLOCATION_FAILURE */
103
104 self->options.is_allocated= true;
105 }
106 else
107 {
108 self->options.is_allocated= false;
109 }
110
111 self->options.is_initialized= true;
112
113 return self;
114 }
115
116 memcached_server_st *memcached_server_create_with(const memcached_st *memc,
117 memcached_server_write_instance_st self,
118 const char *hostname, in_port_t port,
119 uint32_t weight, memcached_connection_t type)
120 {
121 self= _server_create(self, memc);
122
123 if (not self)
124 return NULL;
125
126 _server_init(self, const_cast<memcached_st *>(memc), hostname, port, weight, type);
127
128
129 if (type == MEMCACHED_CONNECTION_UDP)
130 {
131 self->write_buffer_offset= UDP_DATAGRAM_HEADER_LENGTH;
132 memcached_io_init_udp_header(self, 0);
133 }
134
135 return self;
136 }
137
138 void memcached_server_free(memcached_server_st *self)
139 {
140 if (not self)
141 return;
142
143 memcached_quit_server(self, false);
144
145 if (self->cached_server_error)
146 free(self->cached_server_error);
147
148 if (self->address_info)
149 freeaddrinfo(self->address_info);
150
151 if (memcached_is_allocated(self))
152 {
153 libmemcached_free(self->root, self);
154 }
155 else
156 {
157 self->options.is_initialized= false;
158 }
159 }
160
161 /*
162 If we do not have a valid object to clone from, we toss an error.
163 */
164 memcached_server_st *memcached_server_clone(memcached_server_st *destination,
165 const memcached_server_st *source)
166 {
167 /* We just do a normal create if source is missing */
168 if (not source)
169 return NULL;
170
171 destination= memcached_server_create_with(source->root, destination,
172 source->hostname, source->port, source->weight,
173 source->type);
174 if (not destination)
175 {
176 destination->cached_errno= source->cached_errno;
177
178 if (source->cached_server_error)
179 destination->cached_server_error= strdup(source->cached_server_error);
180 }
181
182 return destination;
183
184 }
185
186 memcached_return_t memcached_server_cursor(const memcached_st *ptr,
187 const memcached_server_fn *callback,
188 void *context,
189 uint32_t number_of_callbacks)
190 {
191 memcached_return_t rc;
192 if (memcached_failed(rc= initialize_const_query(ptr)))
193 {
194 return rc;
195 }
196
197 size_t errors= 0;
198 for (uint32_t x= 0; x < memcached_server_count(ptr); x++)
199 {
200 memcached_server_instance_st instance=
201 memcached_server_instance_by_position(ptr, x);
202
203 for (uint32_t y= 0; y < number_of_callbacks; y++)
204 {
205 memcached_return_t ret= (*callback[y])(ptr, instance, context);
206
207 if (memcached_failed(ret))
208 {
209 errors++;
210 continue;
211 }
212 }
213 }
214
215 return errors ? MEMCACHED_SOME_ERRORS : MEMCACHED_SUCCESS;
216 }
217
218 memcached_return_t memcached_server_execute(memcached_st *ptr,
219 memcached_server_execute_fn callback,
220 void *context)
221 {
222 for (uint32_t x= 0; x < memcached_server_count(ptr); x++)
223 {
224 memcached_server_write_instance_st instance= memcached_server_instance_fetch(ptr, x);
225
226 unsigned int iferror= (*callback)(ptr, instance, context);
227
228 if (iferror)
229 continue;
230 }
231
232 return MEMCACHED_SUCCESS;
233 }
234
235 memcached_server_instance_st memcached_server_by_key(const memcached_st *ptr,
236 const char *key,
237 size_t key_length,
238 memcached_return_t *error)
239 {
240 memcached_return_t rc;
241 memcached_return_t unused;
242
243 if (not error)
244 error= &unused;
245
246 if (memcached_failed(rc= initialize_const_query(ptr)))
247 {
248 *error= rc;
249 return NULL;
250 }
251
252 if (memcached_failed(rc= memcached_validate_key_length(key_length, ptr->flags.binary_protocol)))
253 {
254 *error= rc;
255 return NULL;
256 }
257
258 if (memcached_failed((memcached_key_test(*ptr, (const char **)&key, &key_length, 1))))
259 {
260 *error= MEMCACHED_BAD_KEY_PROVIDED;
261 return NULL;
262 }
263
264 uint32_t server_key= memcached_generate_hash(ptr, key, key_length);
265 return memcached_server_instance_by_position(ptr, server_key);
266
267 }
268
269 void memcached_server_error_reset(memcached_server_st *self)
270 {
271 WATCHPOINT_ASSERT(self);
272 if (not self)
273 return;
274
275 self->cached_server_error[0]= 0;
276 }
277
278 memcached_server_instance_st memcached_server_get_last_disconnect(const memcached_st *self)
279 {
280 WATCHPOINT_ASSERT(self);
281 if (not self)
282 return 0;
283
284 return self->last_disconnected_server;
285 }
286
287 void memcached_server_list_free(memcached_server_list_st self)
288 {
289 if (not self)
290 return;
291
292 for (uint32_t x= 0; x < memcached_server_list_count(self); x++)
293 {
294 if (self[x].address_info)
295 {
296 freeaddrinfo(self[x].address_info);
297 self[x].address_info= NULL;
298 }
299 }
300
301 libmemcached_free(self->root, self);
302 }
303
304 uint32_t memcached_servers_set_count(memcached_server_st *servers, uint32_t count)
305 {
306 WATCHPOINT_ASSERT(servers);
307 if (not servers)
308 return 0;
309
310 return servers->number_of_hosts= count;
311 }
312
313 uint32_t memcached_server_count(const memcached_st *self)
314 {
315 WATCHPOINT_ASSERT(self);
316 if (not self)
317 return 0;
318
319 return self->number_of_hosts;
320 }
321
322 const char *memcached_server_name(memcached_server_instance_st self)
323 {
324 WATCHPOINT_ASSERT(self);
325 if (not self)
326 return NULL;
327
328 return self->hostname;
329 }
330
331 in_port_t memcached_server_port(memcached_server_instance_st self)
332 {
333 WATCHPOINT_ASSERT(self);
334 if (not self)
335 return 0;
336
337 return self->port;
338 }
339
340 uint32_t memcached_server_response_count(memcached_server_instance_st self)
341 {
342 WATCHPOINT_ASSERT(self);
343 if (not self)
344 return 0;
345
346 return self->cursor_active;
347 }
348
349 const char *memcached_server_error(memcached_server_instance_st ptr)
350 {
351 return ptr ? ptr->cached_server_error : NULL;
352 }
353
354 const char *memcached_server_type(memcached_server_instance_st ptr)
355 {
356 if (ptr)
357 {
358 switch (ptr->type)
359 {
360 case MEMCACHED_CONNECTION_TCP:
361 return "TCP";
362
363 case MEMCACHED_CONNECTION_UDP:
364 return "UDP";
365
366 case MEMCACHED_CONNECTION_UNIX_SOCKET:
367 return "SOCKET";
368
369 case MEMCACHED_CONNECTION_MAX:
370 case MEMCACHED_CONNECTION_UNKNOWN:
371 break;
372 }
373 }
374
375 return "UNKNOWN";
376 }