1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/errlog.c,v $
5 * Purpose : Log errors to a designated destination in an elegant,
8 * Copyright : Written by and Copyright (C) 2001-2014 the
9 * Privoxy team. https://www.privoxy.org/
11 * Based on the Internet Junkbuster originally written
12 * by and Copyright (C) 1997 Anonymous Coders and
13 * Junkbusters Corporation. http://www.junkbusters.com
15 * This program is free software; you can redistribute it
16 * and/or modify it under the terms of the GNU General
17 * Public License as published by the Free Software
18 * Foundation; either version 2 of the License, or (at
19 * your option) any later version.
21 * This program is distributed in the hope that it will
22 * be useful, but WITHOUT ANY WARRANTY; without even the
23 * implied warranty of MERCHANTABILITY or FITNESS FOR A
24 * PARTICULAR PURPOSE. See the GNU General Public
25 * License for more details.
27 * The GNU General Public License should be included with
28 * this file. If not, you can view it at
29 * http://www.gnu.org/copyleft/gpl.html
30 * or write to the Free Software Foundation, Inc., 59
31 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
33 *********************************************************************/
45 /* For gettimeofday() */
48 #if !defined(_WIN32) && !defined(__OS2__)
50 #endif /* !defined(_WIN32) && !defined(__OS2__) */
62 #endif /* ndef _WIN_CONSOLE */
63 #endif /* def _WIN32 */
65 #define inline __inline
66 #endif /* def _MSC_VER */
69 #include <sys/socket.h> /* For sock_errno */
77 #ifdef FEATURE_EXTERNAL_FILTERS
78 #include "jbsockets.h"
82 * LOG_LEVEL_FATAL cannot be turned off. (There are
83 * some exceptional situations where we need to get a
84 * message to the user).
86 #define LOG_LEVEL_MINIMUM LOG_LEVEL_FATAL
88 /* where to log (default: stderr) */
89 static FILE *logfp = NULL;
91 /* logging detail level. XXX: stupid name. */
92 static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR);
94 /* static functions */
95 static void fatal_error(const char * error_message);
97 static char *w32_socket_strerr(int errcode, char *tmp_buf);
100 static char *os2_socket_strerr(int errcode, char *tmp_buf);
103 #ifdef MUTEX_LOCKS_AVAILABLE
104 static inline void lock_logfile(void)
106 privoxy_mutex_lock(&log_mutex);
108 static inline void unlock_logfile(void)
110 privoxy_mutex_unlock(&log_mutex);
112 static inline void lock_loginit(void)
114 privoxy_mutex_lock(&log_init_mutex);
116 static inline void unlock_loginit(void)
118 privoxy_mutex_unlock(&log_init_mutex);
120 #else /* ! MUTEX_LOCKS_AVAILABLE */
122 * FIXME we need a cross-platform locking mechanism.
123 * The locking/unlocking functions below should be
124 * fleshed out for non-pthread implementations.
126 static inline void lock_logfile() {}
127 static inline void unlock_logfile() {}
128 static inline void lock_loginit() {}
129 static inline void unlock_loginit() {}
132 /*********************************************************************
134 * Function : fatal_error
136 * Description : Displays a fatal error to standard error (or, on
137 * a WIN32 GUI, to a dialog box), and exits Privoxy
138 * with status code 1.
141 * 1 : error_message = The error message to display.
143 * Returns : Does not return.
145 *********************************************************************/
146 static void fatal_error(const char *error_message)
150 fputs(error_message, logfp);
153 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
155 /* Skip timestamp and thread id for the message box. */
156 const char *box_message = strstr(error_message, "Fatal error");
157 if (NULL == box_message)
159 /* Shouldn't happen but ... */
160 box_message = error_message;
162 MessageBox(g_hwndLogFrame, box_message, "Privoxy Error",
163 MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
165 /* Cleanup - remove taskbar icon etc. */
168 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
181 /*********************************************************************
183 * Function : show_version
185 * Description : Logs the Privoxy version and the program name.
188 * 1 : prog_name = The program name.
192 *********************************************************************/
193 void show_version(const char *prog_name)
195 log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
196 if (prog_name != NULL)
198 log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
203 /*********************************************************************
205 * Function : init_log_module
207 * Description : Initializes the logging module to log to stderr.
208 * Can only be called while stderr hasn't been closed
209 * yet and is only supposed to be called once.
212 * 1 : prog_name = The program name.
216 *********************************************************************/
217 void init_log_module(void)
222 set_debug_level(debug);
226 /*********************************************************************
228 * Function : set_debug_level
230 * Description : Sets the debug level to the provided value
231 * plus LOG_LEVEL_MINIMUM.
233 * XXX: we should only use the LOG_LEVEL_MINIMUM
234 * until the first time the configuration file has
237 * Parameters : 1: debug_level = The debug level to set.
241 *********************************************************************/
242 void set_debug_level(int debug_level)
245 if (LOG_LEVEL_STFU == debug_level)
247 debug = LOG_LEVEL_STFU;
249 if (LOG_LEVEL_STFU == debug)
255 debug = debug_level | LOG_LEVEL_MINIMUM;
259 /*********************************************************************
261 * Function : debug_level_is_enabled
263 * Description : Checks if a certain debug level is enabled.
265 * Parameters : 1: debug_level = The debug level to check.
269 *********************************************************************/
270 int debug_level_is_enabled(int debug_level)
272 return (0 != (debug & debug_level));
276 /*********************************************************************
278 * Function : disable_logging
280 * Description : Disables logging.
286 *********************************************************************/
287 void disable_logging(void)
291 log_error(LOG_LEVEL_INFO,
292 "No logfile configured. Please enable it before reporting any problems.");
301 /*********************************************************************
303 * Function : init_error_log
305 * Description : Initializes the logging module to log to a file.
307 * XXX: should be renamed.
310 * 1 : prog_name = The program name.
311 * 2 : logfname = The logfile to (re)open.
315 *********************************************************************/
316 void init_error_log(const char *prog_name, const char *logfname)
320 assert(NULL != logfname);
324 if ((logfp != NULL) && (logfp != stderr))
326 log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
329 /* set the designated log file */
330 fp = fopen(logfname, "a");
331 if ((NULL == fp) && (logfp != NULL))
334 * Some platforms (like OS/2) don't allow us to open
335 * the same file twice, therefore we give it another
336 * shot after closing the old file descriptor first.
338 * We don't do it right away because it prevents us
339 * from logging the "can't open logfile" message to
342 * XXX: this is a lame workaround and once the next
343 * release is out we should stop bothering reopening
344 * the logfile unless we have to.
346 * Currently we reopen it every time the config file
347 * has been reloaded, but actually we only have to
348 * reopen it if the file name changed or if the
349 * configuration reload was caused by a SIGHUP.
351 log_error(LOG_LEVEL_INFO, "Failed to reopen logfile: \'%s\'. "
352 "Retrying after closing the old file descriptor first. If that "
353 "doesn't work, Privoxy will exit without being able to log a message.",
359 fp = fopen(logfname, "a");
364 log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
367 #ifdef FEATURE_EXTERNAL_FILTERS
368 mark_socket_for_close_on_execute(3);
371 /* set logging to be completely unbuffered */
380 if (daemon_mode && (logfp == stderr))
382 if (dup2(1, 2) == -1)
385 * We only use fatal_error() to clear the pid
386 * file and to exit. Given that stderr has just
387 * been closed, the user will not see the error
390 fatal_error("Failed to reserve fd 2.");
397 show_version(prog_name);
401 } /* init_error_log */
404 /*********************************************************************
406 * Function : get_thread_id
408 * Description : Returns a number that is different for each thread.
410 * XXX: Should be moved elsewhere (miscutil.c?)
414 * Returns : thread_id
416 *********************************************************************/
417 static long get_thread_id(void)
423 APIRET ulrc; /* XXX: I have no clue what this does */
426 /* FIXME get current thread id */
427 #ifdef FEATURE_PTHREAD
428 this_thread = (long)pthread_self();
431 * Mac OSX (and perhaps other Mach instances) doesn't have a unique
432 * value at the lowest order 4 bytes of pthread_self()'s return value, a pthread_t,
433 * so trim the three lowest-order bytes from the value (16^3).
435 this_thread = this_thread / 4096;
436 #endif /* def __MACH__ */
437 #elif defined(_WIN32)
438 this_thread = GetCurrentThreadId();
439 #elif defined(__OS2__)
440 ulrc = DosGetInfoBlocks(&ptib, NULL);
442 this_thread = ptib -> tib_ptib2 -> tib2_ultid;
444 /* Forking instead of threading. */
446 #endif /* def FEATURE_PTHREAD */
452 /*********************************************************************
454 * Function : get_log_timestamp
456 * Description : Generates the time stamp for the log message prefix.
459 * 1 : buffer = Storage buffer
460 * 2 : buffer_size = Size of storage buffer
462 * Returns : Number of written characters or 0 for error.
464 *********************************************************************/
465 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
470 struct timeval tv_now; /* XXX: stupid name */
472 int msecs_length = 0;
474 gettimeofday(&tv_now, NULL);
475 msecs = tv_now.tv_usec / 1000;
478 #ifdef HAVE_LOCALTIME_R
479 tm_now = *localtime_r(&now, &tm_now);
480 #elif defined(MUTEX_LOCKS_AVAILABLE)
481 privoxy_mutex_lock(&localtime_mutex);
482 tm_now = *localtime(&now);
483 privoxy_mutex_unlock(&localtime_mutex);
485 tm_now = *localtime(&now);
488 length = strftime(buffer, buffer_size, "%Y-%m-%d %H:%M:%S", &tm_now);
489 if (length > (size_t)0)
491 msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);
493 if (msecs_length > 0)
495 length += (size_t)msecs_length;
506 /*********************************************************************
508 * Function : get_clf_timestamp
510 * Description : Generates a Common Log Format time string.
513 * 1 : buffer = Storage buffer
514 * 2 : buffer_size = Size of storage buffer
516 * Returns : Number of written characters or 0 for error.
518 *********************************************************************/
519 static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
522 * Complex because not all OSs have tm_gmtoff or
523 * the %z field in strftime()
528 #ifdef HAVE_LOCALTIME_R
536 gmt = *privoxy_gmtime_r(&now, &gmt);
537 #ifdef HAVE_LOCALTIME_R
538 tm_now = localtime_r(&now, &dummy);
539 #elif defined(MUTEX_LOCKS_AVAILABLE)
540 privoxy_mutex_lock(&localtime_mutex);
541 tm_now = localtime(&now);
543 tm_now = localtime(&now);
545 days = tm_now->tm_yday - gmt.tm_yday;
546 hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
547 mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
549 length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
550 #if !defined(HAVE_LOCALTIME_R) && defined(MUTEX_LOCKS_AVAILABLE)
551 privoxy_mutex_unlock(&localtime_mutex);
554 if (length > (size_t)0)
556 tz_length = snprintf(buffer+length, buffer_size-length,
557 "%+03d%02d", mins / 60, abs(mins) % 60);
561 length += (size_t)tz_length;
572 /*********************************************************************
574 * Function : get_log_level_string
576 * Description : Translates a numerical loglevel into a string.
579 * 1 : loglevel = LOG_LEVEL_FOO
581 * Returns : Log level string.
583 *********************************************************************/
584 static inline const char *get_log_level_string(int loglevel)
586 char *log_level_string = NULL;
588 assert(0 < loglevel);
592 case LOG_LEVEL_ERROR:
593 log_level_string = "Error";
595 case LOG_LEVEL_FATAL:
596 log_level_string = "Fatal error";
598 case LOG_LEVEL_REQUEST:
599 log_level_string = "Request";
601 case LOG_LEVEL_CONNECT:
602 log_level_string = "Connect";
604 case LOG_LEVEL_WRITING:
605 log_level_string = "Writing";
607 case LOG_LEVEL_RECEIVED:
608 log_level_string = "Received";
610 case LOG_LEVEL_HEADER:
611 log_level_string = "Header";
614 log_level_string = "Info";
616 case LOG_LEVEL_RE_FILTER:
617 log_level_string = "Re-Filter";
619 #ifdef FEATURE_FORCE_LOAD
620 case LOG_LEVEL_FORCE:
621 log_level_string = "Force";
623 #endif /* def FEATURE_FORCE_LOAD */
624 case LOG_LEVEL_REDIRECTS:
625 log_level_string = "Redirect";
627 case LOG_LEVEL_DEANIMATE:
628 log_level_string = "Gif-Deanimate";
630 case LOG_LEVEL_CRUNCH:
631 log_level_string = "Crunch";
634 log_level_string = "CGI";
636 case LOG_LEVEL_ACTIONS:
637 log_level_string = "Actions";
640 log_level_string = "Unknown log level";
643 assert(NULL != log_level_string);
645 return log_level_string;
649 #define LOG_BUFFER_SIZE BUFFER_SIZE
650 /*********************************************************************
652 * Function : log_error
654 * Description : This is the error-reporting and logging function.
657 * 1 : loglevel = the type of message to be logged
658 * 2 : fmt = the main string we want logged, printf-like
659 * 3 : ... = arguments to be inserted in fmt (printf-like).
663 *********************************************************************/
664 void log_error(int loglevel, const char *fmt, ...)
667 char outbuf[LOG_BUFFER_SIZE+1];
668 char tempbuf[LOG_BUFFER_SIZE];
670 const char * src = fmt;
673 const size_t log_buffer_size = LOG_BUFFER_SIZE;
675 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
677 * Irrespective of debug setting, a GET/POST/CONNECT makes
678 * the taskbar icon animate. (There is an option to disable
679 * this but checking that is handled inside LogShowActivity()).
681 if ((loglevel == LOG_LEVEL_REQUEST) || (loglevel == LOG_LEVEL_CRUNCH))
685 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
688 * verify that the loglevel applies to current
689 * settings and that logging is enabled.
690 * Bail out otherwise.
692 if ((0 == (loglevel & debug))
699 if (debug == LOG_LEVEL_STFU)
704 if (loglevel == LOG_LEVEL_FATAL)
706 fatal_error("Fatal error. You're not supposed to"
707 "see this message. Please file a bug report.");
712 thread_id = get_thread_id();
713 get_log_timestamp(timestamp, sizeof(timestamp));
716 * Memsetting the whole buffer to zero (in theory)
717 * makes things easier later on.
719 memset(outbuf, 0, sizeof(outbuf));
721 /* Add prefix for everything but Common Log Format messages */
722 if (loglevel != LOG_LEVEL_CLF)
724 length = (size_t)snprintf(outbuf, log_buffer_size, "%s %08lx %s: ",
725 timestamp, thread_id, get_log_level_string(loglevel));
728 /* get ready to scan var. args. */
731 /* build formatted message from fmt and var-args */
732 while ((*src) && (length < log_buffer_size-2))
734 const char *sval = NULL; /* %N string */
735 int ival; /* %N string length or an error code */
736 unsigned uval; /* %u value */
737 long lval; /* %l value */
738 unsigned long ulval; /* %ul value */
740 const char *format_string = tempbuf;
745 outbuf[length++] = ch;
747 * XXX: Only necessary on platforms where multiple threads
748 * can write to the buffer at the same time because we
749 * don't support mutexes (OS/2 for example).
751 outbuf[length] = '\0';
754 outbuf[length] = '\0';
762 ival = va_arg(ap, int);
763 snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
766 uval = va_arg(ap, unsigned);
767 snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
770 /* this is a modifier that must be followed by u, lu, or d */
774 lval = va_arg(ap, long);
775 snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
779 ulval = va_arg(ap, unsigned long);
780 snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
782 else if ((ch == 'l') && (*src == 'u'))
784 unsigned long long lluval = va_arg(ap, unsigned long long);
785 snprintf(tempbuf, sizeof(tempbuf), "%llu", lluval);
790 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
791 loglevel = LOG_LEVEL_FATAL;
796 * Note that char parameters are converted to int, so we need to
797 * pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
799 tempbuf[0] = (char) va_arg(ap, int);
803 format_string = va_arg(ap, char *);
804 if (format_string == NULL)
806 format_string = "[null]";
811 * Non-standard: Print a counted unterminated string,
812 * replacing unprintable bytes with their hex value.
813 * Takes 2 parameters: int length, const char * string.
815 ival = va_arg(ap, int);
817 sval = va_arg(ap, char *);
818 assert(sval != NULL);
820 while ((ival-- > 0) && (length < log_buffer_size - 6))
822 if (isprint((int)*sval) && (*sval != '\\'))
824 outbuf[length++] = *sval;
825 outbuf[length] = '\0';
829 int ret = snprintf(outbuf + length,
830 log_buffer_size - length - 2, "\\x%.2x", (unsigned char)*sval);
837 * XXX: In case of printable characters at the end of
838 * the %N string, we're not using the whole buffer.
840 format_string = (length < log_buffer_size - 6) ? "" : "[too long]";
843 /* Non-standard: Print error code from errno */
845 ival = WSAGetLastError();
846 format_string = w32_socket_strerr(ival, tempbuf);
851 format_string = os2_socket_strerr(ival, tempbuf);
856 format_string = strerror(ival);
858 #else /* ifndef _WIN32 */
861 format_string = strerror(ival);
862 #else /* ifndef HAVE_STRERROR */
863 format_string = NULL;
864 #endif /* ndef HAVE_STRERROR */
867 snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
869 #endif /* ndef _WIN32 */
872 /* Non-standard: Print a Common Log File timestamp */
873 get_clf_timestamp(tempbuf, sizeof(tempbuf));
876 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
877 loglevel = LOG_LEVEL_FATAL;
881 assert(length < log_buffer_size);
882 length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
884 if (length >= log_buffer_size-2)
886 static const char warning[] = "... [too long, truncated]";
888 length = log_buffer_size - sizeof(warning) - 1;
889 length += strlcpy(outbuf + length, warning, log_buffer_size - length);
890 assert(length < log_buffer_size);
896 /* done with var. args */
899 assert(length < log_buffer_size);
900 length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
902 /* Some sanity checks */
903 if ((length >= log_buffer_size)
904 || (outbuf[log_buffer_size-1] != '\0')
905 || (outbuf[log_buffer_size] != '\0')
908 /* Repeat as assertions */
909 assert(length < log_buffer_size);
910 assert(outbuf[log_buffer_size-1] == '\0');
912 * outbuf's real size is log_buffer_size+1,
913 * so while this looks like an off-by-one,
914 * we're only checking our paranoia byte.
916 assert(outbuf[log_buffer_size] == '\0');
918 snprintf(outbuf, log_buffer_size,
919 "%s %08lx Fatal error: log_error()'s sanity checks failed."
920 "length: %d. Exiting.",
921 timestamp, thread_id, (int)length);
922 loglevel = LOG_LEVEL_FATAL;
927 * On Windows this is acceptable in case
928 * we are logging to the GUI window only.
930 assert(NULL != logfp);
935 if (loglevel == LOG_LEVEL_FATAL)
942 fputs(outbuf, logfp);
945 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
946 /* Write to display */
947 LogPutString(outbuf);
948 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
955 /*********************************************************************
957 * Function : jb_err_to_string
959 * Description : Translates JB_ERR_FOO codes into strings.
962 * 1 : jb_error = a valid jb_err code
964 * Returns : A string with the jb_err translation
966 *********************************************************************/
967 const char *jb_err_to_string(jb_err jb_error)
972 return "Success, no error";
974 return "Out of memory";
975 case JB_ERR_CGI_PARAMS:
976 return "Missing or corrupt CGI parameters";
978 return "Error opening, reading or writing a file";
980 return "Parse error";
981 case JB_ERR_MODIFIED:
982 return "File has been modified outside of the CGI actions editor.";
983 case JB_ERR_COMPRESS:
984 return "(De)compression failure";
987 return "Internal error";
991 /*********************************************************************
993 * Function : w32_socket_strerr
995 * Description : Translate the return value from WSAGetLastError()
999 * 1 : errcode = The return value from WSAGetLastError().
1000 * 2 : tmp_buf = A temporary buffer that might be used to
1003 * Returns : String representing the error code. This may be
1004 * a global string constant or a string stored in
1007 *********************************************************************/
1008 static char *w32_socket_strerr(int errcode, char *tmp_buf)
1010 #define TEXT_FOR_ERROR(code,text) \
1011 if (errcode == code) \
1013 return #code " - " text; \
1016 TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
1017 TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1018 TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1019 TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1020 TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1021 TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1022 TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1023 TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1024 TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1025 TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1026 TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1027 TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1028 TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1029 TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1030 TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1031 TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1032 TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1033 TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1034 TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1035 TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1036 TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1037 TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1038 TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1039 TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1040 TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1041 TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1042 TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1043 TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1044 TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1045 TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1046 TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1047 TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1048 TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1049 TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1050 TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1051 TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1052 TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1053 TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1054 TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1055 TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1056 TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1057 TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1059 * The following error codes are documented in the Microsoft WinSock
1060 * reference guide, but don't actually exist.
1062 * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1063 * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1064 * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1065 * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1066 * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1067 * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1068 * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1069 * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1070 * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1071 * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1074 sprintf(tmp_buf, "(error number %d)", errcode);
1077 #endif /* def _WIN32 */
1081 /*********************************************************************
1083 * Function : os2_socket_strerr
1085 * Description : Translate the return value from sock_errno()
1089 * 1 : errcode = The return value from sock_errno().
1090 * 2 : tmp_buf = A temporary buffer that might be used to
1093 * Returns : String representing the error code. This may be
1094 * a global string constant or a string stored in
1097 *********************************************************************/
1098 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1100 #define TEXT_FOR_ERROR(code,text) \
1101 if (errcode == code) \
1103 return #code " - " text; \
1106 TEXT_FOR_ERROR(SOCEPERM , "Not owner.")
1107 TEXT_FOR_ERROR(SOCESRCH , "No such process.")
1108 TEXT_FOR_ERROR(SOCEINTR , "Interrupted system call.")
1109 TEXT_FOR_ERROR(SOCENXIO , "No such device or address.")
1110 TEXT_FOR_ERROR(SOCEBADF , "Bad file number.")
1111 TEXT_FOR_ERROR(SOCEACCES , "Permission denied.")
1112 TEXT_FOR_ERROR(SOCEFAULT , "Bad address.")
1113 TEXT_FOR_ERROR(SOCEINVAL , "Invalid argument.")
1114 TEXT_FOR_ERROR(SOCEMFILE , "Too many open files.")
1115 TEXT_FOR_ERROR(SOCEPIPE , "Broken pipe.")
1116 TEXT_FOR_ERROR(SOCEWOULDBLOCK , "Operation would block.")
1117 TEXT_FOR_ERROR(SOCEINPROGRESS , "Operation now in progress.")
1118 TEXT_FOR_ERROR(SOCEALREADY , "Operation already in progress.")
1119 TEXT_FOR_ERROR(SOCENOTSOCK , "Socket operation on non-socket.")
1120 TEXT_FOR_ERROR(SOCEDESTADDRREQ , "Destination address required.")
1121 TEXT_FOR_ERROR(SOCEMSGSIZE , "Message too long.")
1122 TEXT_FOR_ERROR(SOCEPROTOTYPE , "Protocol wrong type for socket.")
1123 TEXT_FOR_ERROR(SOCENOPROTOOPT , "Protocol not available.")
1124 TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1125 TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1126 TEXT_FOR_ERROR(SOCEOPNOTSUPP , "Operation not supported.")
1127 TEXT_FOR_ERROR(SOCEPFNOSUPPORT , "Protocol family not supported.")
1128 TEXT_FOR_ERROR(SOCEAFNOSUPPORT , "Address family not supported by protocol family.")
1129 TEXT_FOR_ERROR(SOCEADDRINUSE , "Address already in use.")
1130 TEXT_FOR_ERROR(SOCEADDRNOTAVAIL , "Can't assign requested address.")
1131 TEXT_FOR_ERROR(SOCENETDOWN , "Network is down.")
1132 TEXT_FOR_ERROR(SOCENETUNREACH , "Network is unreachable.")
1133 TEXT_FOR_ERROR(SOCENETRESET , "Network dropped connection on reset.")
1134 TEXT_FOR_ERROR(SOCECONNABORTED , "Software caused connection abort.")
1135 TEXT_FOR_ERROR(SOCECONNRESET , "Connection reset by peer.")
1136 TEXT_FOR_ERROR(SOCENOBUFS , "No buffer space available.")
1137 TEXT_FOR_ERROR(SOCEISCONN , "Socket is already connected.")
1138 TEXT_FOR_ERROR(SOCENOTCONN , "Socket is not connected.")
1139 TEXT_FOR_ERROR(SOCESHUTDOWN , "Can't send after socket shutdown.")
1140 TEXT_FOR_ERROR(SOCETOOMANYREFS , "Too many references: can't splice.")
1141 TEXT_FOR_ERROR(SOCETIMEDOUT , "Operation timed out.")
1142 TEXT_FOR_ERROR(SOCECONNREFUSED , "Connection refused.")
1143 TEXT_FOR_ERROR(SOCELOOP , "Too many levels of symbolic links.")
1144 TEXT_FOR_ERROR(SOCENAMETOOLONG , "File name too long.")
1145 TEXT_FOR_ERROR(SOCEHOSTDOWN , "Host is down.")
1146 TEXT_FOR_ERROR(SOCEHOSTUNREACH , "No route to host.")
1147 TEXT_FOR_ERROR(SOCENOTEMPTY , "Directory not empty.")
1148 TEXT_FOR_ERROR(SOCEOS2ERR , "OS/2 Error.")
1150 sprintf(tmp_buf, "(error number %d)", errcode);
1153 #endif /* def __OS2__ */