1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
20 * * The names of its contributors may not be used to endorse or
21 * promote products derived from this software without specific prior
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.
38 #include <libmemcached/common.h>
40 #include "libmemcached/assert.hpp"
46 #define MAX_ERROR_LENGTH 2048
47 struct memcached_error_t
51 struct memcached_error_t
*next
;
52 memcached_return_t rc
;
55 char message
[MAX_ERROR_LENGTH
];
58 static void _set(memcached_instance_st
& server
, Memcached
& memc
)
60 if (server
.error_messages
and server
.error_messages
->query_id
!= server
.root
->query_id
)
62 memcached_error_free(server
);
65 if (memc
.error_messages
)
67 if (memc
.error_messages
->rc
== MEMCACHED_TIMEOUT
)
69 server
.io_wait_count
.timeouts
++;
72 memcached_error_t
*error
= libmemcached_xmalloc(&memc
, memcached_error_t
);
75 memcpy(error
, memc
.error_messages
, sizeof(memcached_error_t
));
76 error
->next
= server
.error_messages
;
77 server
.error_messages
= error
;
83 static int error_log_fd
= -1;
86 static void _set(Memcached
& memc
, memcached_string_t
*str
, memcached_return_t
&rc
, const char *at
, int local_errno
= 0)
88 if (memc
.error_messages
&& memc
.error_messages
->query_id
!= memc
.query_id
)
90 memcached_error_free(memc
);
93 if (memcached_fatal(rc
))
95 // For memory allocation we use our error since it is a bit more specific
96 if (local_errno
== ENOMEM
and rc
== MEMCACHED_ERRNO
)
98 rc
= MEMCACHED_MEMORY_ALLOCATION_FAILURE
;
101 if (rc
== MEMCACHED_MEMORY_ALLOCATION_FAILURE
)
106 if (rc
== MEMCACHED_ERRNO
and not local_errno
)
112 if (rc
== MEMCACHED_ERRNO
and local_errno
== ENOTCONN
)
114 rc
= MEMCACHED_CONNECTION_FAILURE
;
117 if (rc
== MEMCACHED_ERRNO
and local_errno
== ECONNRESET
)
119 rc
= MEMCACHED_CONNECTION_FAILURE
;
122 if (local_errno
== EINVAL
)
124 rc
= MEMCACHED_INVALID_ARGUMENTS
;
127 if (local_errno
== ECONNREFUSED
)
129 rc
= MEMCACHED_CONNECTION_FAILURE
;
132 if (rc
== MEMCACHED_TIMEOUT
)
136 memcached_error_t
*error
= libmemcached_xmalloc(&memc
, memcached_error_t
);
137 if (error
== NULL
) // Bad business if this happens
139 assert_msg(error
, "libmemcached_xmalloc() failed to allocate a memcached_error_t");
144 error
->query_id
= memc
.query_id
;
146 error
->local_errno
= local_errno
;
148 const char *errmsg_ptr
;
149 char errmsg
[MAX_ERROR_LENGTH
];
155 #if defined(STRERROR_R_CHAR_P) && STRERROR_R_CHAR_P
156 errmsg_ptr
= strerror_r(local_errno
, errmsg
, sizeof(errmsg
));
157 #elif defined(HAVE_STRERROR_R) && HAVE_STRERROR_R
158 strerror_r(local_errno
, errmsg
, sizeof(errmsg
));
160 #elif defined(HAVE_STRERROR) && HAVE_STRERROR
161 snprintf(errmsg
, sizeof(errmsg
), "%s", strerror(local_errno
));
167 if (str
and str
->size
and local_errno
)
169 error
->size
= (int)snprintf(error
->message
, MAX_ERROR_LENGTH
, "(%p) %s(%s), %.*s -> %s",
171 memcached_strerror(&memc
, rc
),
173 memcached_string_printf(*str
), at
);
175 else if (local_errno
)
177 error
->size
= (int)snprintf(error
->message
, MAX_ERROR_LENGTH
, "(%p) %s(%s) -> %s",
179 memcached_strerror(&memc
, rc
),
183 else if (rc
== MEMCACHED_PARSE_ERROR
and str
and str
->size
)
185 error
->size
= (int)snprintf(error
->message
, MAX_ERROR_LENGTH
, "(%p) %.*s -> %s",
187 int(str
->size
), str
->c_str
, at
);
189 else if (str
and str
->size
)
191 error
->size
= (int)snprintf(error
->message
, MAX_ERROR_LENGTH
, "(%p) %s, %.*s -> %s",
193 memcached_strerror(&memc
, rc
),
194 int(str
->size
), str
->c_str
, at
);
198 error
->size
= (int)snprintf(error
->message
, MAX_ERROR_LENGTH
, "(%p) %s -> %s",
200 memcached_strerror(&memc
, rc
), at
);
203 error
->next
= memc
.error_messages
;
204 memc
.error_messages
= error
;
208 if (error_log_fd
== -1)
210 // unlink("/tmp/libmemcachd.log");
211 if ((error_log_fd
= open("/tmp/libmemcachd.log", O_CREAT
| O_WRONLY
| O_APPEND
, 0644)) < 0)
217 ::write(error_log_fd
, error
->message
, error
->size
);
218 ::write(error_log_fd
, "\n", 1);
222 memcached_return_t
memcached_set_error(Memcached
& memc
, memcached_return_t rc
, const char *at
, const char *str
, size_t length
)
224 assert_msg(rc
!= MEMCACHED_ERRNO
, "Programmer error, MEMCACHED_ERRNO was set to be returned to client");
225 memcached_string_t tmp
= { str
, length
};
226 return memcached_set_error(memc
, rc
, at
, tmp
);
229 memcached_return_t
memcached_set_error(memcached_instance_st
& self
, memcached_return_t rc
, const char *at
, const char *str
, size_t length
)
231 assert_msg(rc
!= MEMCACHED_ERRNO
, "Programmer error, MEMCACHED_ERRNO was set to be returned to client");
232 assert_msg(rc
!= MEMCACHED_SOME_ERRORS
, "Programmer error, MEMCACHED_SOME_ERRORS was about to be set on a Instance");
234 memcached_string_t tmp
= { str
, length
};
235 return memcached_set_error(self
, rc
, at
, tmp
);
238 #ifndef __INTEL_COMPILER
239 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
242 memcached_return_t
memcached_set_error(Memcached
& memc
, memcached_return_t rc
, const char *at
, memcached_string_t
& str
)
244 assert_msg(rc
!= MEMCACHED_ERRNO
, "Programmer error, MEMCACHED_ERRNO was set to be returned to client");
245 if (memcached_fatal(rc
))
247 _set(memc
, &str
, rc
, at
);
253 memcached_return_t
memcached_set_parser_error(Memcached
& memc
,
255 const char *format
, ...)
260 va_start(args
, format
);
261 int length
= vsnprintf(buffer
, sizeof(buffer
), format
, args
);
264 return memcached_set_error(memc
, MEMCACHED_PARSE_ERROR
, at
, buffer
, length
);
267 static inline size_t append_host_to_string(memcached_instance_st
& self
, char* buffer
, const size_t buffer_length
)
272 case MEMCACHED_CONNECTION_TCP
:
273 case MEMCACHED_CONNECTION_UDP
:
274 size
+= snprintf(buffer
, buffer_length
, " host: %s:%d",
275 self
.hostname(), int(self
.port()));
278 case MEMCACHED_CONNECTION_UNIX_SOCKET
:
279 size
+= snprintf(buffer
, buffer_length
, " socket: %s",
287 memcached_return_t
memcached_set_error(memcached_instance_st
& self
, memcached_return_t rc
, const char *at
, memcached_string_t
& str
)
289 assert_msg(rc
!= MEMCACHED_ERRNO
, "Programmer error, MEMCACHED_ERRNO was set to be returned to client");
290 assert_msg(rc
!= MEMCACHED_SOME_ERRORS
, "Programmer error, MEMCACHED_SOME_ERRORS was about to be set on a memcached_instance_st");
291 if (memcached_fatal(rc
) == false and rc
!= MEMCACHED_CLIENT_ERROR
)
296 char hostname_port_message
[MAX_ERROR_LENGTH
];
297 char* hostname_port_message_ptr
= hostname_port_message
;
301 size
= snprintf(hostname_port_message_ptr
, sizeof(hostname_port_message
), "%.*s, ",
302 memcached_string_printf(str
));
303 hostname_port_message_ptr
+= size
;
306 size
+= append_host_to_string(self
, hostname_port_message_ptr
, sizeof(hostname_port_message
) -size
);
308 memcached_string_t error_host
= { hostname_port_message
, size_t(size
) };
310 assert_msg(self
.root
, "Programmer error, root was not set on instance");
313 _set(*self
.root
, &error_host
, rc
, at
);
314 _set(self
, (*self
.root
));
315 assert(self
.root
->error_messages
);
316 assert(self
.error_messages
);
317 assert(self
.error_messages
->rc
== self
.root
->error_messages
->rc
);
323 memcached_return_t
memcached_set_error(memcached_instance_st
& self
, memcached_return_t rc
, const char *at
)
325 assert_msg(rc
!= MEMCACHED_SOME_ERRORS
, "Programmer error, MEMCACHED_SOME_ERRORS was about to be set on a memcached_instance_st");
326 if (memcached_fatal(rc
) == false)
331 char hostname_port
[MEMCACHED_NI_MAXHOST
+MEMCACHED_NI_MAXSERV
+ sizeof("host : ")];
332 size_t size
= append_host_to_string(self
, hostname_port
, sizeof(hostname_port
));
334 memcached_string_t error_host
= { hostname_port
, size
};
338 _set(*self
.root
, &error_host
, rc
, at
);
339 _set(self
, *self
.root
);
345 memcached_return_t
memcached_set_error(Memcached
& self
, memcached_return_t rc
, const char *at
)
347 assert_msg(rc
!= MEMCACHED_ERRNO
, "Programmer error, MEMCACHED_ERRNO was set to be returned to client");
348 if (memcached_fatal(rc
) == false)
353 _set(self
, NULL
, rc
, at
);
358 memcached_return_t
memcached_set_errno(Memcached
& self
, int local_errno
, const char *at
, const char *str
, size_t length
)
360 memcached_string_t tmp
= { str
, length
};
361 return memcached_set_errno(self
, local_errno
, at
, tmp
);
364 memcached_return_t
memcached_set_errno(memcached_instance_st
& self
, int local_errno
, const char *at
, const char *str
, size_t length
)
366 memcached_string_t tmp
= { str
, length
};
367 return memcached_set_errno(self
, local_errno
, at
, tmp
);
370 memcached_return_t
memcached_set_errno(Memcached
& self
, int local_errno
, const char *at
)
372 if (local_errno
== 0)
374 return MEMCACHED_SUCCESS
;
377 memcached_return_t rc
= MEMCACHED_ERRNO
;
378 _set(self
, NULL
, rc
, at
, local_errno
);
383 memcached_return_t
memcached_set_errno(Memcached
& memc
, int local_errno
, const char *at
, memcached_string_t
& str
)
385 if (local_errno
== 0)
387 return MEMCACHED_SUCCESS
;
390 memcached_return_t rc
= MEMCACHED_ERRNO
;
391 _set(memc
, &str
, rc
, at
, local_errno
);
396 memcached_return_t
memcached_set_errno(memcached_instance_st
& self
, int local_errno
, const char *at
, memcached_string_t
& str
)
398 if (local_errno
== 0)
400 return MEMCACHED_SUCCESS
;
403 char hostname_port_message
[MAX_ERROR_LENGTH
];
404 char* hostname_port_message_ptr
= hostname_port_message
;
408 size
= snprintf(hostname_port_message_ptr
, sizeof(hostname_port_message
), "%.*s, ", memcached_string_printf(str
));
410 size
+= append_host_to_string(self
, hostname_port_message_ptr
, sizeof(hostname_port_message
) -size
);
412 memcached_string_t error_host
= { hostname_port_message
, size
};
414 memcached_return_t rc
= MEMCACHED_ERRNO
;
415 if (self
.root
== NULL
)
420 _set(*self
.root
, &error_host
, rc
, at
, local_errno
);
421 _set(self
, (*self
.root
));
424 if (self
.root
->error_messages
->rc
!= self
.error_messages
->rc
)
426 fprintf(stderr
, "%s:%d %s != %s\n", __FILE__
, __LINE__
,
427 memcached_strerror(NULL
, self
.root
->error_messages
->rc
),
428 memcached_strerror(NULL
, self
.error_messages
->rc
));
435 memcached_return_t
memcached_set_errno(memcached_instance_st
& self
, int local_errno
, const char *at
)
437 if (local_errno
== 0)
439 return MEMCACHED_SUCCESS
;
442 char hostname_port_message
[MAX_ERROR_LENGTH
];
443 size_t size
= append_host_to_string(self
, hostname_port_message
, sizeof(hostname_port_message
));
445 memcached_string_t error_host
= { hostname_port_message
, size
};
447 memcached_return_t rc
= MEMCACHED_ERRNO
;
448 if (self
.root
== NULL
)
453 _set(*self
.root
, &error_host
, rc
, at
, local_errno
);
454 _set(self
, (*self
.root
));
459 static void _error_print(const memcached_error_t
*error
)
466 if (error
->size
== 0)
468 fprintf(stderr
, "\t%s\n", memcached_strerror(NULL
, error
->rc
) );
472 fprintf(stderr
, "\t%s %s\n", memcached_strerror(NULL
, error
->rc
), error
->message
);
475 _error_print(error
->next
);
478 void memcached_error_print(const Memcached
*shell
)
480 const Memcached
* self
= memcached2Memcached(shell
);
486 _error_print(self
->error_messages
);
488 for (uint32_t x
= 0; x
< memcached_server_count(self
); x
++)
490 memcached_instance_st
* instance
= memcached_instance_by_position(self
, x
);
492 _error_print(instance
->error_messages
);
496 static void _error_free(memcached_error_t
*error
)
500 _error_free(error
->next
);
502 libmemcached_free(error
->root
, error
);
506 void memcached_error_free(Memcached
& self
)
508 _error_free(self
.error_messages
);
509 self
.error_messages
= NULL
;
512 void memcached_error_free(memcached_instance_st
& self
)
514 _error_free(self
.error_messages
);
515 self
.error_messages
= NULL
;
518 void memcached_error_free(memcached_server_st
& self
)
520 _error_free(self
.error_messages
);
521 self
.error_messages
= NULL
;
524 const char *memcached_error(const memcached_st
*memc
)
526 return memcached_last_error_message(memc
);
529 const char *memcached_last_error_message(const memcached_st
*shell
)
531 const Memcached
* memc
= memcached2Memcached(shell
);
534 if (memc
->error_messages
)
536 if (memc
->error_messages
->size
and memc
->error_messages
->message
[0])
538 return memc
->error_messages
->message
;
541 return memcached_strerror(memc
, memc
->error_messages
->rc
);
544 return memcached_strerror(memc
, MEMCACHED_SUCCESS
);
547 return memcached_strerror(memc
, MEMCACHED_INVALID_ARGUMENTS
);
550 bool memcached_has_current_error(Memcached
&memc
)
552 if (memc
.error_messages
553 and memc
.error_messages
->query_id
== memc
.query_id
554 and memcached_failed(memc
.error_messages
->rc
))
562 bool memcached_has_current_error(memcached_instance_st
& server
)
564 return memcached_has_current_error(*(server
.root
));
567 memcached_return_t
memcached_last_error(const memcached_st
*shell
)
569 const Memcached
* memc
= memcached2Memcached(shell
);
572 if (memc
->error_messages
)
574 return memc
->error_messages
->rc
;
577 return MEMCACHED_SUCCESS
;
580 return MEMCACHED_INVALID_ARGUMENTS
;
583 int memcached_last_error_errno(const memcached_st
*shell
)
585 const Memcached
* memc
= memcached2Memcached(shell
);
591 if (memc
->error_messages
== NULL
)
596 return memc
->error_messages
->local_errno
;
599 const char *memcached_server_error(const memcached_instance_st
* server
)
606 if (server
->error_messages
== NULL
)
608 return memcached_strerror(server
->root
, MEMCACHED_SUCCESS
);
611 if (server
->error_messages
->size
== 0)
613 return memcached_strerror(server
->root
, server
->error_messages
->rc
);
616 return server
->error_messages
->message
;
620 memcached_error_t
*memcached_error_copy(const memcached_instance_st
& server
)
622 if (server
.error_messages
== NULL
)
627 memcached_error_t
*error
= libmemcached_xmalloc(server
.root
, memcached_error_t
);
628 memcpy(error
, server
.error_messages
, sizeof(memcached_error_t
));
634 memcached_return_t
memcached_server_error_return(const memcached_instance_st
* ptr
)
638 return MEMCACHED_INVALID_ARGUMENTS
;
641 if (ptr
and ptr
->error_messages
)
643 return ptr
->error_messages
->rc
;
646 return MEMCACHED_SUCCESS
;
649 memcached_return_t
memcached_instance_error_return(memcached_instance_st
* instance
)
651 if (instance
== NULL
)
653 return MEMCACHED_INVALID_ARGUMENTS
;
656 if (instance
and instance
->error_messages
)
658 return instance
->error_messages
->rc
;
661 return MEMCACHED_SUCCESS
;