1 const char errlog_rcs[] = "$Id: errlog.c,v 1.117 2012/12/09 12:28:14 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/errlog.c,v $
6 * Purpose : Log errors to a designated destination in an elegant,
9 * Copyright : Written by and Copyright (C) 2001-2010 the
10 * Privoxy team. http://www.privoxy.org/
12 * Based on the Internet Junkbuster originally written
13 * by and Copyright (C) 1997 Anonymous Coders and
14 * Junkbusters Corporation. http://www.junkbusters.com
16 * This program is free software; you can redistribute it
17 * and/or modify it under the terms of the GNU General
18 * Public License as published by the Free Software
19 * Foundation; either version 2 of the License, or (at
20 * your option) any later version.
22 * This program is distributed in the hope that it will
23 * be useful, but WITHOUT ANY WARRANTY; without even the
24 * implied warranty of MERCHANTABILITY or FITNESS FOR A
25 * PARTICULAR PURPOSE. See the GNU General Public
26 * License for more details.
28 * The GNU General Public License should be included with
29 * this file. If not, you can view it at
30 * http://www.gnu.org/copyleft/gpl.html
31 * or write to the Free Software Foundation, Inc., 59
32 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
34 *********************************************************************/
46 /* For gettimeofday() */
49 #if !defined(_WIN32) && !defined(__OS2__)
51 #endif /* !defined(_WIN32) && !defined(__OS2__) */
63 #endif /* ndef _WIN_CONSOLE */
64 #endif /* def _WIN32 */
66 #define inline __inline
67 #endif /* def _MSC_VER */
70 #include <sys/socket.h> /* For sock_errno */
79 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
83 * LOG_LEVEL_FATAL cannot be turned off. (There are
84 * some exceptional situations where we need to get a
85 * message to the user).
87 #define LOG_LEVEL_MINIMUM LOG_LEVEL_FATAL
89 /* where to log (default: stderr) */
90 static FILE *logfp = NULL;
92 /* logging detail level. XXX: stupid name. */
93 static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR);
95 /* static functions */
96 static void fatal_error(const char * error_message);
98 static char *w32_socket_strerr(int errcode, char *tmp_buf);
101 static char *os2_socket_strerr(int errcode, char *tmp_buf);
104 #ifdef MUTEX_LOCKS_AVAILABLE
105 static inline void lock_logfile(void)
107 privoxy_mutex_lock(&log_mutex);
109 static inline void unlock_logfile(void)
111 privoxy_mutex_unlock(&log_mutex);
113 static inline void lock_loginit(void)
115 privoxy_mutex_lock(&log_init_mutex);
117 static inline void unlock_loginit(void)
119 privoxy_mutex_unlock(&log_init_mutex);
121 #else /* ! MUTEX_LOCKS_AVAILABLE */
123 * FIXME we need a cross-platform locking mechanism.
124 * The locking/unlocking functions below should be
125 * fleshed out for non-pthread implementations.
127 static inline void lock_logfile() {}
128 static inline void unlock_logfile() {}
129 static inline void lock_loginit() {}
130 static inline void unlock_loginit() {}
133 /*********************************************************************
135 * Function : fatal_error
137 * Description : Displays a fatal error to standard error (or, on
138 * a WIN32 GUI, to a dialog box), and exits Privoxy
139 * with status code 1.
142 * 1 : error_message = The error message to display.
144 * Returns : Does not return.
146 *********************************************************************/
147 static void fatal_error(const char *error_message)
151 fputs(error_message, logfp);
154 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
156 /* Skip timestamp and thread id for the message box. */
157 const char *box_message = strstr(error_message, "Fatal error");
158 if (NULL == box_message)
160 /* Shouldn't happen but ... */
161 box_message = error_message;
163 MessageBox(g_hwndLogFrame, box_message, "Privoxy Error",
164 MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
166 /* Cleanup - remove taskbar icon etc. */
169 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
182 /*********************************************************************
184 * Function : show_version
186 * Description : Logs the Privoxy version and the program name.
189 * 1 : prog_name = The program name.
193 *********************************************************************/
194 void show_version(const char *prog_name)
196 log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
197 if (prog_name != NULL)
199 log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
204 /*********************************************************************
206 * Function : init_log_module
208 * Description : Initializes the logging module to log to stderr.
209 * Can only be called while stderr hasn't been closed
210 * yet and is only supposed to be called once.
213 * 1 : prog_name = The program name.
217 *********************************************************************/
218 void init_log_module(void)
223 set_debug_level(debug);
227 /*********************************************************************
229 * Function : set_debug_level
231 * Description : Sets the debug level to the provided value
232 * plus LOG_LEVEL_MINIMUM.
234 * XXX: we should only use the LOG_LEVEL_MINIMUM
235 * until the first time the configuration file has
238 * Parameters : 1: debug_level = The debug level to set.
242 *********************************************************************/
243 void set_debug_level(int debug_level)
245 debug = debug_level | LOG_LEVEL_MINIMUM;
249 /*********************************************************************
251 * Function : debug_level_is_enabled
253 * Description : Checks if a certain debug level is enabled.
255 * Parameters : 1: debug_level = The debug level to check.
259 *********************************************************************/
260 int debug_level_is_enabled(int debug_level)
262 return (0 != (debug & debug_level));
266 /*********************************************************************
268 * Function : disable_logging
270 * Description : Disables logging.
276 *********************************************************************/
277 void disable_logging(void)
281 log_error(LOG_LEVEL_INFO,
282 "No logfile configured. Please enable it before reporting any problems.");
291 /*********************************************************************
293 * Function : init_error_log
295 * Description : Initializes the logging module to log to a file.
297 * XXX: should be renamed.
300 * 1 : prog_name = The program name.
301 * 2 : logfname = The logfile to (re)open.
305 *********************************************************************/
306 void init_error_log(const char *prog_name, const char *logfname)
310 assert(NULL != logfname);
314 if ((logfp != NULL) && (logfp != stderr))
316 log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
319 /* set the designated log file */
320 fp = fopen(logfname, "a");
321 if ((NULL == fp) && (logfp != NULL))
324 * Some platforms (like OS/2) don't allow us to open
325 * the same file twice, therefore we give it another
326 * shot after closing the old file descriptor first.
328 * We don't do it right away because it prevents us
329 * from logging the "can't open logfile" message to
332 * XXX: this is a lame workaround and once the next
333 * release is out we should stop bothering reopening
334 * the logfile unless we have to.
336 * Currently we reopen it every time the config file
337 * has been reloaded, but actually we only have to
338 * reopen it if the file name changed or if the
339 * configuration reload was caused by a SIGHUP.
341 log_error(LOG_LEVEL_INFO, "Failed to reopen logfile: \'%s\'. "
342 "Retrying after closing the old file descriptor first. If that "
343 "doesn't work, Privoxy will exit without being able to log a message.",
349 fp = fopen(logfname, "a");
354 log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
357 /* set logging to be completely unbuffered */
366 if (daemon_mode && (logfp == stderr))
368 if (dup2(1, 2) == -1)
371 * We only use fatal_error() to clear the pid
372 * file and to exit. Given that stderr has just
373 * been closed, the user will not see the error
376 fatal_error("Failed to reserve fd 2.");
383 show_version(prog_name);
387 } /* init_error_log */
390 /*********************************************************************
392 * Function : get_thread_id
394 * Description : Returns a number that is different for each thread.
396 * XXX: Should be moved elsewhere (miscutil.c?)
400 * Returns : thread_id
402 *********************************************************************/
403 static long get_thread_id(void)
405 long this_thread = 1; /* was: pthread_t this_thread;*/
409 APIRET ulrc; /* XXX: I have no clue what this does */
412 /* FIXME get current thread id */
413 #ifdef FEATURE_PTHREAD
414 this_thread = (long)pthread_self();
417 * Mac OSX (and perhaps other Mach instances) doesn't have a debuggable
418 * value at the first 4 bytes of pthread_self()'s return value, a pthread_t.
419 * pthread_t is supposed to be opaque... but it's fairly random, though, so
420 * we make it mostly presentable.
422 this_thread = abs(this_thread % 1000);
423 #endif /* def __MACH__ */
424 #elif defined(_WIN32)
425 this_thread = GetCurrentThreadId();
426 #elif defined(__OS2__)
427 ulrc = DosGetInfoBlocks(&ptib, NULL);
429 this_thread = ptib -> tib_ptib2 -> tib2_ultid;
430 #endif /* def FEATURE_PTHREAD */
436 /*********************************************************************
438 * Function : get_log_timestamp
440 * Description : Generates the time stamp for the log message prefix.
443 * 1 : buffer = Storage buffer
444 * 2 : buffer_size = Size of storage buffer
446 * Returns : Number of written characters or 0 for error.
448 *********************************************************************/
449 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
454 struct timeval tv_now; /* XXX: stupid name */
456 int msecs_length = 0;
458 gettimeofday(&tv_now, NULL);
459 msecs = tv_now.tv_usec / 1000;
462 #ifdef HAVE_LOCALTIME_R
463 tm_now = *localtime_r(&now, &tm_now);
464 #elif defined(MUTEX_LOCKS_AVAILABLE)
465 privoxy_mutex_lock(&localtime_mutex);
466 tm_now = *localtime(&now);
467 privoxy_mutex_unlock(&localtime_mutex);
469 tm_now = *localtime(&now);
472 length = strftime(buffer, buffer_size, "%Y-%m-%d %H:%M:%S", &tm_now);
473 if (length > (size_t)0)
475 msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);
477 if (msecs_length > 0)
479 length += (size_t)msecs_length;
490 /*********************************************************************
492 * Function : get_clf_timestamp
494 * Description : Generates a Common Log Format time string.
497 * 1 : buffer = Storage buffer
498 * 2 : buffer_size = Size of storage buffer
500 * Returns : Number of written characters or 0 for error.
502 *********************************************************************/
503 static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
506 * Complex because not all OSs have tm_gmtoff or
507 * the %z field in strftime()
512 #ifdef HAVE_LOCALTIME_R
521 gmt = *gmtime_r(&now, &gmt);
522 #elif defined(MUTEX_LOCKS_AVAILABLE)
523 privoxy_mutex_lock(&gmtime_mutex);
525 privoxy_mutex_unlock(&gmtime_mutex);
529 #ifdef HAVE_LOCALTIME_R
530 tm_now = localtime_r(&now, &dummy);
531 #elif defined(MUTEX_LOCKS_AVAILABLE)
532 privoxy_mutex_lock(&localtime_mutex);
533 tm_now = localtime(&now);
534 privoxy_mutex_unlock(&localtime_mutex);
536 tm_now = localtime(&now);
538 days = tm_now->tm_yday - gmt.tm_yday;
539 hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
540 mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
542 length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
544 if (length > (size_t)0)
546 tz_length = snprintf(buffer+length, buffer_size-length,
547 "%+03d%02d", mins / 60, abs(mins) % 60);
551 length += (size_t)tz_length;
562 /*********************************************************************
564 * Function : get_log_level_string
566 * Description : Translates a numerical loglevel into a string.
569 * 1 : loglevel = LOG_LEVEL_FOO
571 * Returns : Log level string.
573 *********************************************************************/
574 static inline const char *get_log_level_string(int loglevel)
576 char *log_level_string = NULL;
578 assert(0 < loglevel);
582 case LOG_LEVEL_ERROR:
583 log_level_string = "Error";
585 case LOG_LEVEL_FATAL:
586 log_level_string = "Fatal error";
589 log_level_string = "Request";
591 case LOG_LEVEL_CONNECT:
592 log_level_string = "Connect";
594 case LOG_LEVEL_WRITING:
595 log_level_string = "Writing";
597 case LOG_LEVEL_RECEIVED:
598 log_level_string = "Received";
600 case LOG_LEVEL_HEADER:
601 log_level_string = "Header";
604 log_level_string = "Info";
606 case LOG_LEVEL_RE_FILTER:
607 log_level_string = "Re-Filter";
609 #ifdef FEATURE_FORCE_LOAD
610 case LOG_LEVEL_FORCE:
611 log_level_string = "Force";
613 #endif /* def FEATURE_FORCE_LOAD */
614 case LOG_LEVEL_REDIRECTS:
615 log_level_string = "Redirect";
617 case LOG_LEVEL_DEANIMATE:
618 log_level_string = "Gif-Deanimate";
620 case LOG_LEVEL_CRUNCH:
621 log_level_string = "Crunch";
624 log_level_string = "CGI";
626 case LOG_LEVEL_ACTIONS:
627 log_level_string = "Actions";
630 log_level_string = "Unknown log level";
633 assert(NULL != log_level_string);
635 return log_level_string;
639 #define LOG_BUFFER_SIZE BUFFER_SIZE
640 /*********************************************************************
642 * Function : log_error
644 * Description : This is the error-reporting and logging function.
647 * 1 : loglevel = the type of message to be logged
648 * 2 : fmt = the main string we want logged, printf-like
649 * 3 : ... = arguments to be inserted in fmt (printf-like).
653 *********************************************************************/
654 void log_error(int loglevel, const char *fmt, ...)
658 static char *outbuf_save = NULL;
659 char tempbuf[LOG_BUFFER_SIZE];
661 const char * src = fmt;
665 * XXX: Make this a config option,
666 * why else do we allocate instead of using
669 size_t log_buffer_size = LOG_BUFFER_SIZE;
671 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
673 * Irrespective of debug setting, a GET/POST/CONNECT makes
674 * the taskbar icon animate. (There is an option to disable
675 * this but checking that is handled inside LogShowActivity()).
677 if ((loglevel == LOG_LEVEL_GPC) || (loglevel == LOG_LEVEL_CRUNCH))
681 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
684 * verify that the loglevel applies to current
685 * settings and that logging is enabled.
686 * Bail out otherwise.
688 if ((0 == (loglevel & debug))
694 if (loglevel == LOG_LEVEL_FATAL)
696 fatal_error("Fatal error. You're not supposed to"
697 "see this message. Please file a bug report.");
702 thread_id = get_thread_id();
703 get_log_timestamp(timestamp, sizeof(timestamp));
705 /* protect the whole function because of the static buffer (outbuf) */
708 if (NULL == outbuf_save)
710 outbuf_save = (char*)zalloc(log_buffer_size + 1); /* +1 for paranoia */
711 if (NULL == outbuf_save)
713 snprintf(tempbuf, sizeof(tempbuf),
714 "%s %08lx Fatal error: Out of memory in log_error().",
715 timestamp, thread_id);
716 fatal_error(tempbuf); /* Exit */
720 outbuf = outbuf_save;
723 * Memsetting the whole buffer to zero (in theory)
724 * makes things easier later on.
726 memset(outbuf, 0, log_buffer_size);
728 /* Add prefix for everything but Common Log Format messages */
729 if (loglevel != LOG_LEVEL_CLF)
731 length = (size_t)snprintf(outbuf, log_buffer_size, "%s %08lx %s: ",
732 timestamp, thread_id, get_log_level_string(loglevel));
735 /* get ready to scan var. args. */
738 /* build formatted message from fmt and var-args */
739 while ((*src) && (length < log_buffer_size-2))
741 const char *sval = NULL; /* %N string */
742 int ival; /* %N string length or an error code */
743 unsigned uval; /* %u value */
744 long lval; /* %l value */
745 unsigned long ulval; /* %ul value */
747 const char *format_string = tempbuf;
752 outbuf[length++] = ch;
754 * XXX: Only necessary on platforms where multiple threads
755 * can write to the buffer at the same time because we
756 * don't support mutexes (OS/2 for example).
758 outbuf[length] = '\0';
761 outbuf[length] = '\0';
769 ival = va_arg(ap, int);
770 snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
773 uval = va_arg(ap, unsigned);
774 snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
777 /* this is a modifier that must be followed by u, lu, or d */
781 lval = va_arg(ap, long);
782 snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
786 ulval = va_arg(ap, unsigned long);
787 snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
789 else if ((ch == 'l') && (*src == 'u'))
791 unsigned long long lluval = va_arg(ap, unsigned long long);
792 snprintf(tempbuf, sizeof(tempbuf), "%llu", lluval);
797 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
798 loglevel = LOG_LEVEL_FATAL;
803 * Note that char paramaters are converted to int, so we need to
804 * pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
806 tempbuf[0] = (char) va_arg(ap, int);
810 format_string = va_arg(ap, char *);
811 if (format_string == NULL)
813 format_string = "[null]";
818 * Non-standard: Print a counted unterminated string,
819 * replacing unprintable bytes with their hex value.
820 * Takes 2 parameters: int length, const char * string.
822 ival = va_arg(ap, int);
824 sval = va_arg(ap, char *);
825 assert(sval != NULL);
827 while ((ival-- > 0) && (length < log_buffer_size - 6))
829 if (isprint((int)*sval) && (*sval != '\\'))
831 outbuf[length++] = *sval;
832 outbuf[length] = '\0';
836 int ret = snprintf(outbuf + length,
837 log_buffer_size - length - 2, "\\x%.2x", (unsigned char)*sval);
844 * XXX: In case of printable characters at the end of
845 * the %N string, we're not using the whole buffer.
847 format_string = (length < log_buffer_size - 6) ? "" : "[too long]";
850 /* Non-standard: Print error code from errno */
852 ival = WSAGetLastError();
853 format_string = w32_socket_strerr(ival, tempbuf);
858 format_string = os2_socket_strerr(ival, tempbuf);
863 format_string = strerror(ival);
865 #else /* ifndef _WIN32 */
868 format_string = strerror(ival);
869 #else /* ifndef HAVE_STRERROR */
870 format_string = NULL;
871 #endif /* ndef HAVE_STRERROR */
874 snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
876 #endif /* ndef _WIN32 */
879 /* Non-standard: Print a Common Log File timestamp */
880 get_clf_timestamp(tempbuf, sizeof(tempbuf));
883 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
884 loglevel = LOG_LEVEL_FATAL;
888 assert(length < log_buffer_size);
889 length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
891 if (length >= log_buffer_size-2)
893 static const char warning[] = "... [too long, truncated]";
895 length = log_buffer_size - sizeof(warning) - 1;
896 length += strlcpy(outbuf + length, warning, log_buffer_size - length);
897 assert(length < log_buffer_size);
903 /* done with var. args */
906 assert(length < log_buffer_size);
907 length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
909 /* Some sanity checks */
910 if ((length >= log_buffer_size)
911 || (outbuf[log_buffer_size-1] != '\0')
912 || (outbuf[log_buffer_size] != '\0')
915 /* Repeat as assertions */
916 assert(length < log_buffer_size);
917 assert(outbuf[log_buffer_size-1] == '\0');
919 * outbuf's real size is log_buffer_size+1,
920 * so while this looks like an off-by-one,
921 * we're only checking our paranoia byte.
923 assert(outbuf[log_buffer_size] == '\0');
925 snprintf(outbuf, log_buffer_size,
926 "%s %08lx Fatal error: log_error()'s sanity checks failed."
927 "length: %d. Exiting.",
928 timestamp, thread_id, (int)length);
929 loglevel = LOG_LEVEL_FATAL;
934 * On Windows this is acceptable in case
935 * we are logging to the GUI window only.
937 assert(NULL != logfp);
940 if (loglevel == LOG_LEVEL_FATAL)
942 fatal_error(outbuf_save);
947 fputs(outbuf_save, logfp);
950 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
951 /* Write to display */
952 LogPutString(outbuf_save);
953 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
960 /*********************************************************************
962 * Function : jb_err_to_string
964 * Description : Translates JB_ERR_FOO codes into strings.
966 * XXX: the type of error codes is jb_err
967 * but the typedef'inition is currently not
968 * visible to all files that include errlog.h.
971 * 1 : jb_error = a valid jb_err code
973 * Returns : A string with the jb_err translation
975 *********************************************************************/
976 const char *jb_err_to_string(int jb_error)
981 return "Success, no error";
983 return "Out of memory";
984 case JB_ERR_CGI_PARAMS:
985 return "Missing or corrupt CGI parameters";
987 return "Error opening, reading or writing a file";
989 return "Parse error";
990 case JB_ERR_MODIFIED:
991 return "File has been modified outside of the CGI actions editor.";
992 case JB_ERR_COMPRESS:
993 return "(De)compression failure";
996 return "Unknown error";
999 return "Internal error";
1003 /*********************************************************************
1005 * Function : w32_socket_strerr
1007 * Description : Translate the return value from WSAGetLastError()
1011 * 1 : errcode = The return value from WSAGetLastError().
1012 * 2 : tmp_buf = A temporary buffer that might be used to
1015 * Returns : String representing the error code. This may be
1016 * a global string constant or a string stored in
1019 *********************************************************************/
1020 static char *w32_socket_strerr(int errcode, char *tmp_buf)
1022 #define TEXT_FOR_ERROR(code,text) \
1023 if (errcode == code) \
1025 return #code " - " text; \
1028 TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
1029 TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1030 TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1031 TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1032 TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1033 TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1034 TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1035 TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1036 TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1037 TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1038 TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1039 TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1040 TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1041 TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1042 TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1043 TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1044 TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1045 TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1046 TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1047 TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1048 TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1049 TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1050 TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1051 TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1052 TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1053 TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1054 TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1055 TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1056 TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1057 TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1058 TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1059 TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1060 TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1061 TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1062 TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1063 TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1064 TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1065 TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1066 TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1067 TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1068 TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1069 TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1071 * The following error codes are documented in the Microsoft WinSock
1072 * reference guide, but don't actually exist.
1074 * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1075 * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1076 * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1077 * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1078 * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1079 * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1080 * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1081 * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1082 * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1083 * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1086 sprintf(tmp_buf, "(error number %d)", errcode);
1089 #endif /* def _WIN32 */
1093 /*********************************************************************
1095 * Function : os2_socket_strerr
1097 * Description : Translate the return value from sock_errno()
1101 * 1 : errcode = The return value from sock_errno().
1102 * 2 : tmp_buf = A temporary buffer that might be used to
1105 * Returns : String representing the error code. This may be
1106 * a global string constant or a string stored in
1109 *********************************************************************/
1110 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1112 #define TEXT_FOR_ERROR(code,text) \
1113 if (errcode == code) \
1115 return #code " - " text; \
1118 TEXT_FOR_ERROR(SOCEPERM , "Not owner.")
1119 TEXT_FOR_ERROR(SOCESRCH , "No such process.")
1120 TEXT_FOR_ERROR(SOCEINTR , "Interrupted system call.")
1121 TEXT_FOR_ERROR(SOCENXIO , "No such device or address.")
1122 TEXT_FOR_ERROR(SOCEBADF , "Bad file number.")
1123 TEXT_FOR_ERROR(SOCEACCES , "Permission denied.")
1124 TEXT_FOR_ERROR(SOCEFAULT , "Bad address.")
1125 TEXT_FOR_ERROR(SOCEINVAL , "Invalid argument.")
1126 TEXT_FOR_ERROR(SOCEMFILE , "Too many open files.")
1127 TEXT_FOR_ERROR(SOCEPIPE , "Broken pipe.")
1128 TEXT_FOR_ERROR(SOCEWOULDBLOCK , "Operation would block.")
1129 TEXT_FOR_ERROR(SOCEINPROGRESS , "Operation now in progress.")
1130 TEXT_FOR_ERROR(SOCEALREADY , "Operation already in progress.")
1131 TEXT_FOR_ERROR(SOCENOTSOCK , "Socket operation on non-socket.")
1132 TEXT_FOR_ERROR(SOCEDESTADDRREQ , "Destination address required.")
1133 TEXT_FOR_ERROR(SOCEMSGSIZE , "Message too long.")
1134 TEXT_FOR_ERROR(SOCEPROTOTYPE , "Protocol wrong type for socket.")
1135 TEXT_FOR_ERROR(SOCENOPROTOOPT , "Protocol not available.")
1136 TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1137 TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1138 TEXT_FOR_ERROR(SOCEOPNOTSUPP , "Operation not supported.")
1139 TEXT_FOR_ERROR(SOCEPFNOSUPPORT , "Protocol family not supported.")
1140 TEXT_FOR_ERROR(SOCEAFNOSUPPORT , "Address family not supported by protocol family.")
1141 TEXT_FOR_ERROR(SOCEADDRINUSE , "Address already in use.")
1142 TEXT_FOR_ERROR(SOCEADDRNOTAVAIL , "Can't assign requested address.")
1143 TEXT_FOR_ERROR(SOCENETDOWN , "Network is down.")
1144 TEXT_FOR_ERROR(SOCENETUNREACH , "Network is unreachable.")
1145 TEXT_FOR_ERROR(SOCENETRESET , "Network dropped connection on reset.")
1146 TEXT_FOR_ERROR(SOCECONNABORTED , "Software caused connection abort.")
1147 TEXT_FOR_ERROR(SOCECONNRESET , "Connection reset by peer.")
1148 TEXT_FOR_ERROR(SOCENOBUFS , "No buffer space available.")
1149 TEXT_FOR_ERROR(SOCEISCONN , "Socket is already connected.")
1150 TEXT_FOR_ERROR(SOCENOTCONN , "Socket is not connected.")
1151 TEXT_FOR_ERROR(SOCESHUTDOWN , "Can't send after socket shutdown.")
1152 TEXT_FOR_ERROR(SOCETOOMANYREFS , "Too many references: can't splice.")
1153 TEXT_FOR_ERROR(SOCETIMEDOUT , "Operation timed out.")
1154 TEXT_FOR_ERROR(SOCECONNREFUSED , "Connection refused.")
1155 TEXT_FOR_ERROR(SOCELOOP , "Too many levels of symbolic links.")
1156 TEXT_FOR_ERROR(SOCENAMETOOLONG , "File name too long.")
1157 TEXT_FOR_ERROR(SOCEHOSTDOWN , "Host is down.")
1158 TEXT_FOR_ERROR(SOCEHOSTUNREACH , "No route to host.")
1159 TEXT_FOR_ERROR(SOCENOTEMPTY , "Directory not empty.")
1160 TEXT_FOR_ERROR(SOCEOS2ERR , "OS/2 Error.")
1162 sprintf(tmp_buf, "(error number %d)", errcode);
1165 #endif /* def __OS2__ */