Tristan Matthews | 0a329cc | 2013-07-17 13:20:14 -0400 | [diff] [blame] | 1 | /* $Id$ */ |
| 2 | /* |
| 3 | * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com) |
| 4 | * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org> |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this program; if not, write to the Free Software |
| 18 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 19 | */ |
| 20 | #include <pj/errno.h> |
| 21 | #include <pj/log.h> |
| 22 | #include <pj/string.h> |
| 23 | #include <pj/compat/string.h> |
| 24 | #include <pj/compat/stdarg.h> |
| 25 | #include <pj/assert.h> |
| 26 | |
| 27 | /* Prototype for platform specific error message, which will be defined |
| 28 | * in separate file. |
| 29 | */ |
| 30 | PJ_BEGIN_DECL |
| 31 | |
| 32 | PJ_DECL(int) platform_strerror(pj_os_err_type code, |
| 33 | char *buf, pj_size_t bufsize ); |
| 34 | PJ_END_DECL |
| 35 | |
| 36 | #ifndef PJLIB_MAX_ERR_MSG_HANDLER |
| 37 | # define PJLIB_MAX_ERR_MSG_HANDLER 10 |
| 38 | #endif |
| 39 | |
| 40 | /* Error message handler. */ |
| 41 | static unsigned err_msg_hnd_cnt; |
| 42 | static struct err_msg_hnd |
| 43 | { |
| 44 | pj_status_t begin; |
| 45 | pj_status_t end; |
| 46 | pj_str_t (*strerror)(pj_status_t, char*, pj_size_t); |
| 47 | |
| 48 | } err_msg_hnd[PJLIB_MAX_ERR_MSG_HANDLER]; |
| 49 | |
| 50 | /* PJLIB's own error codes/messages */ |
| 51 | #if defined(PJ_HAS_ERROR_STRING) && PJ_HAS_ERROR_STRING!=0 |
| 52 | |
| 53 | static const struct |
| 54 | { |
| 55 | int code; |
| 56 | const char *msg; |
| 57 | } err_str[] = |
| 58 | { |
| 59 | PJ_BUILD_ERR(PJ_EUNKNOWN, "Unknown Error" ), |
| 60 | PJ_BUILD_ERR(PJ_EPENDING, "Pending operation" ), |
| 61 | PJ_BUILD_ERR(PJ_ETOOMANYCONN, "Too many connecting sockets" ), |
| 62 | PJ_BUILD_ERR(PJ_EINVAL, "Invalid value or argument" ), |
| 63 | PJ_BUILD_ERR(PJ_ENAMETOOLONG, "Name too long" ), |
| 64 | PJ_BUILD_ERR(PJ_ENOTFOUND, "Not found" ), |
| 65 | PJ_BUILD_ERR(PJ_ENOMEM, "Not enough memory" ), |
| 66 | PJ_BUILD_ERR(PJ_EBUG, "BUG DETECTED!" ), |
| 67 | PJ_BUILD_ERR(PJ_ETIMEDOUT, "Operation timed out" ), |
| 68 | PJ_BUILD_ERR(PJ_ETOOMANY, "Too many objects of the specified type"), |
| 69 | PJ_BUILD_ERR(PJ_EBUSY, "Object is busy"), |
| 70 | PJ_BUILD_ERR(PJ_ENOTSUP, "Option/operation is not supported"), |
| 71 | PJ_BUILD_ERR(PJ_EINVALIDOP, "Invalid operation"), |
| 72 | PJ_BUILD_ERR(PJ_ECANCELLED, "Operation cancelled"), |
| 73 | PJ_BUILD_ERR(PJ_EEXISTS, "Object already exists" ), |
| 74 | PJ_BUILD_ERR(PJ_EEOF, "End of file" ), |
| 75 | PJ_BUILD_ERR(PJ_ETOOBIG, "Size is too big"), |
| 76 | PJ_BUILD_ERR(PJ_ERESOLVE, "gethostbyname() has returned error"), |
| 77 | PJ_BUILD_ERR(PJ_ETOOSMALL, "Size is too short"), |
| 78 | PJ_BUILD_ERR(PJ_EIGNORED, "Ignored"), |
| 79 | PJ_BUILD_ERR(PJ_EIPV6NOTSUP, "IPv6 is not supported"), |
| 80 | PJ_BUILD_ERR(PJ_EAFNOTSUP, "Unsupported address family"), |
| 81 | PJ_BUILD_ERR(PJ_EGONE, "Object no longer exists"), |
| 82 | PJ_BUILD_ERR(PJ_ESOCKETSTOP, "Socket is in bad state") |
| 83 | }; |
| 84 | #endif /* PJ_HAS_ERROR_STRING */ |
| 85 | |
| 86 | |
| 87 | /* |
| 88 | * pjlib_error() |
| 89 | * |
| 90 | * Retrieve message string for PJLIB's own error code. |
| 91 | */ |
| 92 | static int pjlib_error(pj_status_t code, char *buf, pj_size_t size) |
| 93 | { |
| 94 | #if defined(PJ_HAS_ERROR_STRING) && PJ_HAS_ERROR_STRING!=0 |
| 95 | unsigned i; |
| 96 | |
| 97 | for (i=0; i<sizeof(err_str)/sizeof(err_str[0]); ++i) { |
| 98 | if (err_str[i].code == code) { |
| 99 | pj_size_t len = strlen(err_str[i].msg); |
| 100 | if (len >= size) len = size-1; |
| 101 | pj_memcpy(buf, err_str[i].msg, len); |
| 102 | buf[len] = '\0'; |
| 103 | return (int)len; |
| 104 | } |
| 105 | } |
| 106 | #endif |
| 107 | |
| 108 | return pj_ansi_snprintf( buf, size, "Unknown pjlib error %d", code); |
| 109 | } |
| 110 | |
| 111 | #define IN_RANGE(val,start,end) ((val)>=(start) && (val)<(end)) |
| 112 | |
| 113 | /* Register strerror handle. */ |
| 114 | PJ_DEF(pj_status_t) pj_register_strerror( pj_status_t start, |
| 115 | pj_status_t space, |
| 116 | pj_error_callback f) |
| 117 | { |
| 118 | unsigned i; |
| 119 | |
| 120 | /* Check arguments. */ |
| 121 | PJ_ASSERT_RETURN(start && space && f, PJ_EINVAL); |
| 122 | |
| 123 | /* Check if there aren't too many handlers registered. */ |
| 124 | PJ_ASSERT_RETURN(err_msg_hnd_cnt < PJ_ARRAY_SIZE(err_msg_hnd), |
| 125 | PJ_ETOOMANY); |
| 126 | |
| 127 | /* Start error must be greater than PJ_ERRNO_START_USER */ |
| 128 | PJ_ASSERT_RETURN(start >= PJ_ERRNO_START_USER, PJ_EEXISTS); |
| 129 | |
| 130 | /* Check that no existing handler has covered the specified range. */ |
| 131 | for (i=0; i<err_msg_hnd_cnt; ++i) { |
| 132 | if (IN_RANGE(start, err_msg_hnd[i].begin, err_msg_hnd[i].end) || |
| 133 | IN_RANGE(start+space-1, err_msg_hnd[i].begin, err_msg_hnd[i].end)) |
| 134 | { |
| 135 | if (err_msg_hnd[i].begin == start && |
| 136 | err_msg_hnd[i].end == (start+space) && |
| 137 | err_msg_hnd[i].strerror == f) |
| 138 | { |
| 139 | /* The same range and handler has already been registered */ |
| 140 | return PJ_SUCCESS; |
| 141 | } |
| 142 | |
| 143 | return PJ_EEXISTS; |
| 144 | } |
| 145 | } |
| 146 | |
| 147 | /* Register the handler. */ |
| 148 | err_msg_hnd[err_msg_hnd_cnt].begin = start; |
| 149 | err_msg_hnd[err_msg_hnd_cnt].end = start + space; |
| 150 | err_msg_hnd[err_msg_hnd_cnt].strerror = f; |
| 151 | |
| 152 | ++err_msg_hnd_cnt; |
| 153 | |
| 154 | return PJ_SUCCESS; |
| 155 | } |
| 156 | |
| 157 | /* Internal PJLIB function called by pj_shutdown() to clear error handlers */ |
| 158 | void pj_errno_clear_handlers(void) |
| 159 | { |
| 160 | err_msg_hnd_cnt = 0; |
| 161 | pj_bzero(err_msg_hnd, sizeof(err_msg_hnd)); |
| 162 | } |
| 163 | |
| 164 | |
| 165 | /* |
| 166 | * pj_strerror() |
| 167 | */ |
| 168 | PJ_DEF(pj_str_t) pj_strerror( pj_status_t statcode, |
| 169 | char *buf, pj_size_t bufsize ) |
| 170 | { |
| 171 | int len = -1; |
| 172 | pj_str_t errstr; |
| 173 | |
| 174 | pj_assert(buf && bufsize); |
| 175 | |
| 176 | if (statcode == PJ_SUCCESS) { |
| 177 | len = pj_ansi_snprintf( buf, bufsize, "Success"); |
| 178 | |
| 179 | } else if (statcode < PJ_ERRNO_START + PJ_ERRNO_SPACE_SIZE) { |
| 180 | len = pj_ansi_snprintf( buf, bufsize, "Unknown error %d", statcode); |
| 181 | |
| 182 | } else if (statcode < PJ_ERRNO_START_STATUS + PJ_ERRNO_SPACE_SIZE) { |
| 183 | len = pjlib_error(statcode, buf, bufsize); |
| 184 | |
| 185 | } else if (statcode < PJ_ERRNO_START_SYS + PJ_ERRNO_SPACE_SIZE) { |
| 186 | len = platform_strerror(PJ_STATUS_TO_OS(statcode), buf, bufsize); |
| 187 | |
| 188 | } else { |
| 189 | unsigned i; |
| 190 | |
| 191 | /* Find user handler to get the error message. */ |
| 192 | for (i=0; i<err_msg_hnd_cnt; ++i) { |
| 193 | if (IN_RANGE(statcode, err_msg_hnd[i].begin, err_msg_hnd[i].end)) { |
| 194 | return (*err_msg_hnd[i].strerror)(statcode, buf, bufsize); |
| 195 | } |
| 196 | } |
| 197 | |
| 198 | /* Handler not found! */ |
| 199 | len = pj_ansi_snprintf( buf, bufsize, "Unknown error %d", statcode); |
| 200 | } |
| 201 | |
| 202 | if (len < 1) { |
| 203 | *buf = '\0'; |
| 204 | len = 0; |
| 205 | } |
| 206 | |
| 207 | errstr.ptr = buf; |
| 208 | errstr.slen = len; |
| 209 | |
| 210 | return errstr; |
| 211 | } |
| 212 | |
| 213 | #if PJ_LOG_MAX_LEVEL >= 1 |
| 214 | static void invoke_log(const char *sender, int level, const char *format, ...) |
| 215 | { |
| 216 | va_list arg; |
| 217 | va_start(arg, format); |
| 218 | pj_log(sender, level, format, arg); |
| 219 | va_end(arg); |
| 220 | } |
| 221 | |
| 222 | static void pj_perror_imp(int log_level, const char *sender, |
| 223 | pj_status_t status, |
| 224 | const char *title_fmt, va_list marker) |
| 225 | { |
| 226 | char titlebuf[PJ_PERROR_TITLE_BUF_SIZE]; |
| 227 | char errmsg[PJ_ERR_MSG_SIZE]; |
| 228 | int len; |
| 229 | |
| 230 | /* Build the title */ |
| 231 | len = pj_ansi_vsnprintf(titlebuf, sizeof(titlebuf), title_fmt, marker); |
| 232 | if (len < 0 || len >= (int)sizeof(titlebuf)) |
| 233 | pj_ansi_strcpy(titlebuf, "Error"); |
| 234 | |
| 235 | /* Get the error */ |
| 236 | pj_strerror(status, errmsg, sizeof(errmsg)); |
| 237 | |
| 238 | /* Send to log */ |
| 239 | invoke_log(sender, log_level, "%s: %s", titlebuf, errmsg); |
| 240 | } |
| 241 | |
| 242 | PJ_DEF(void) pj_perror(int log_level, const char *sender, pj_status_t status, |
| 243 | const char *title_fmt, ...) |
| 244 | { |
| 245 | va_list marker; |
| 246 | va_start(marker, title_fmt); |
| 247 | pj_perror_imp(log_level, sender, status, title_fmt, marker); |
| 248 | va_end(marker); |
| 249 | } |
| 250 | |
| 251 | PJ_DEF(void) pj_perror_1(const char *sender, pj_status_t status, |
| 252 | const char *title_fmt, ...) |
| 253 | { |
| 254 | va_list marker; |
| 255 | va_start(marker, title_fmt); |
| 256 | pj_perror_imp(1, sender, status, title_fmt, marker); |
| 257 | va_end(marker); |
| 258 | } |
| 259 | |
| 260 | #else /* #if PJ_LOG_MAX_LEVEL >= 1 */ |
| 261 | PJ_DEF(void) pj_perror(int log_level, const char *sender, pj_status_t status, |
| 262 | const char *title_fmt, ...) |
| 263 | { |
| 264 | } |
| 265 | #endif /* #if PJ_LOG_MAX_LEVEL >= 1 */ |
| 266 | |
| 267 | |
| 268 | #if PJ_LOG_MAX_LEVEL >= 2 |
| 269 | PJ_DEF(void) pj_perror_2(const char *sender, pj_status_t status, |
| 270 | const char *title_fmt, ...) |
| 271 | { |
| 272 | va_list marker; |
| 273 | va_start(marker, title_fmt); |
| 274 | pj_perror_imp(2, sender, status, title_fmt, marker); |
| 275 | va_end(marker); |
| 276 | } |
| 277 | #endif |
| 278 | |
| 279 | #if PJ_LOG_MAX_LEVEL >= 3 |
| 280 | PJ_DEF(void) pj_perror_3(const char *sender, pj_status_t status, |
| 281 | const char *title_fmt, ...) |
| 282 | { |
| 283 | va_list marker; |
| 284 | va_start(marker, title_fmt); |
| 285 | pj_perror_imp(3, sender, status, title_fmt, marker); |
| 286 | va_end(marker); |
| 287 | } |
| 288 | #endif |
| 289 | |
| 290 | #if PJ_LOG_MAX_LEVEL >= 4 |
| 291 | PJ_DEF(void) pj_perror_4(const char *sender, pj_status_t status, |
| 292 | const char *title_fmt, ...) |
| 293 | { |
| 294 | va_list marker; |
| 295 | va_start(marker, title_fmt); |
| 296 | pj_perror_imp(4, sender, status, title_fmt, marker); |
| 297 | va_end(marker); |
| 298 | } |
| 299 | #endif |
| 300 | |
| 301 | #if PJ_LOG_MAX_LEVEL >= 5 |
| 302 | PJ_DEF(void) pj_perror_5(const char *sender, pj_status_t status, |
| 303 | const char *title_fmt, ...) |
| 304 | { |
| 305 | va_list marker; |
| 306 | va_start(marker, title_fmt); |
| 307 | pj_perror_imp(5, sender, status, title_fmt, marker); |
| 308 | va_end(marker); |
| 309 | } |
| 310 | #endif |
| 311 | |
| 312 | #if PJ_LOG_MAX_LEVEL >= 6 |
| 313 | PJ_DEF(void) pj_perror_6(const char *sender, pj_status_t status, |
| 314 | const char *title_fmt, ...) |
| 315 | { |
| 316 | va_list marker; |
| 317 | va_start(marker, title_fmt); |
| 318 | pj_perror_imp(6, sender, status, title_fmt, marker); |
| 319 | va_end(marker); |
| 320 | } |
| 321 | #endif |
| 322 | |