errlog.c

   1 const char errlog_rcs[] = "$Id: errlog.c,v 1.59 2007/11/01 12:50:56 fabiankeil Exp $";
   2 /*********************************************************************
   3  *
   4  * File        :  $Source: /cvsroot/ijbswa/current/errlog.c,v $
   5  *
   6  * Purpose     :  Log errors to a designated destination in an elegant,
   7  *                printf-like fashion.
   8  *
   9  * Copyright   :  Written by and Copyright (C) 2001-2007 the SourceForge
  10  *                Privoxy team. http://www.privoxy.org/
  11  *
  12  *                Based on the Internet Junkbuster originally written
  13  *                by and Copyright (C) 1997 Anonymous Coders and
  14  *                Junkbusters Corporation.  http://www.junkbusters.com
  15  *
  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.
  21  *
  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.
  27  *
  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.
  33  *
  34  * Revisions   :
  35  *    $Log: errlog.c,v $
  36  *    Revision 1.59  2007/11/01 12:50:56  fabiankeil
  37  *    Here's looking at you, deadlock.
  38  *
  39  *    Revision 1.58  2007/10/28 19:04:21  fabiankeil
  40  *    Don't mention daemon mode in "Logging disabled" message. Some
  41  *    platforms call it differently and it's not really relevant anyway.
  42  *
  43  *    Revision 1.57  2007/10/27 13:02:26  fabiankeil
  44  *    Relocate daemon-mode-related log messages to make sure
  45  *    they aren't shown again in case of configuration reloads.
  46  *
  47  *    Revision 1.56  2007/10/14 14:26:56  fabiankeil
  48  *    Remove the old log_error() version.
  49  *
  50  *    Revision 1.55  2007/10/14 14:12:41  fabiankeil
  51  *    When in daemon mode, close stderr after the configuration file has been
  52  *    parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
  53  *
  54  *    Revision 1.54  2007/09/22 16:15:34  fabiankeil
  55  *    - Let it compile with pcc.
  56  *    - Move our includes below system includes to prevent macro conflicts.
  57  *
  58  *    Revision 1.53  2007/08/05 13:53:14  fabiankeil
  59  *    #1763173 from Stefan Huehner: declare some more functions
  60  *    static and use void instead of empty parameter lists.
  61  *
  62  *    Revision 1.52  2007/07/14 07:28:47  fabiankeil
  63  *    Add translation function for JB_ERR_FOO codes.
  64  *
  65  *    Revision 1.51  2007/05/11 11:51:34  fabiankeil
  66  *    Fix a type mismatch warning.
  67  *
  68  *    Revision 1.50  2007/04/11 10:55:44  fabiankeil
  69  *    Enforce some assertions that could be triggered
  70  *    on mingw32 and other systems where we use threads
  71  *    but no locks.
  72  *
  73  *    Revision 1.49  2007/04/08 16:44:15  fabiankeil
  74  *    We need <sys/time.h> for gettimeofday(), not <time.h>.
  75  *
  76  *    Revision 1.48  2007/03/31 13:33:28  fabiankeil
  77  *    Add alternative log_error() with timestamps
  78  *    that contain milliseconds and without using
  79  *    strcpy(), strcat() or sprintf().
  80  *
  81  *    Revision 1.47  2006/11/28 15:25:15  fabiankeil
  82  *    Only unlink the pidfile if it's actually used.
  83  *
  84  *    Revision 1.46  2006/11/13 19:05:51  fabiankeil
  85  *    Make pthread mutex locking more generic. Instead of
  86  *    checking for OSX and OpenBSD, check for FEATURE_PTHREAD
  87  *    and use mutex locking unless there is an _r function
  88  *    available. Better safe than sorry.
  89  *
  90  *    Fixes "./configure --disable-pthread" and should result
  91  *    in less threading-related problems on pthread-using platforms,
  92  *    but it still doesn't fix BR#1122404.
  93  *
  94  *    Revision 1.45  2006/08/21 11:15:54  david__schmidt
  95  *    MS Visual C++ build updates
  96  *
  97  *    Revision 1.44  2006/08/18 16:03:16  david__schmidt
  98  *    Tweak for OS/2 build happiness.
  99  *
 100  *    Revision 1.43  2006/08/03 02:46:41  david__schmidt
 101  *    Incorporate Fabian Keil's patch work:
 102  *    http://www.fabiankeil.de/sourcecode/privoxy/
 103  *
 104  *    Revision 1.42  2006/07/18 14:48:46  david__schmidt
 105  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
 106  *    with what was really the latest development (the v_3_0_branch branch)
 107  *
 108  *    Revision 1.40.2.4  2005/04/03 20:10:50  david__schmidt
 109  *    Thanks to Jindrich Makovicka for a race condition fix for the log
 110  *    file.  The race condition remains for non-pthread implementations.
 111  *    Reference patch #1175720.
 112  *
 113  *    Revision 1.40.2.3  2003/03/07 03:41:04  david__schmidt
 114  *    Wrapping all *_r functions (the non-_r versions of them) with mutex
 115  *    semaphores for OSX.  Hopefully this will take care of all of those pesky
 116  *    crash reports.
 117  *
 118  *    Revision 1.40.2.2  2002/09/28 00:30:57  david__schmidt
 119  *    Update error logging to give sane values for thread IDs on Mach kernels.
 120  *    It's still a hack, but at least it looks farily normal.  We print the
 121  *    absolute value of the first 4 bytes of the pthread_t modded with 1000.
 122  *
 123  *    Revision 1.40.2.1  2002/09/25 12:47:42  oes
 124  *    Make log_error safe against NULL string arguments
 125  *
 126  *    Revision 1.40  2002/05/22 01:27:27  david__schmidt
 127  *
 128  *    Add os2_socket_strerr mirroring w32_socket_strerr.
 129  *
 130  *    Revision 1.39  2002/04/03 17:15:27  gliptak
 131  *    zero padding thread ids in log
 132  *
 133  *    Revision 1.38  2002/03/31 17:18:59  jongfoster
 134  *    Win32 only: Enabling STRICT to fix a VC++ compile warning.
 135  *
 136  *    Revision 1.37  2002/03/27 14:32:43  david__schmidt
 137  *    More compiler warning message maintenance
 138  *
 139  *    Revision 1.36  2002/03/26 22:29:54  swa
 140  *    we have a new homepage!
 141  *
 142  *    Revision 1.35  2002/03/24 15:23:33  jongfoster
 143  *    Name changes
 144  *
 145  *    Revision 1.34  2002/03/24 13:25:43  swa
 146  *    name change related issues
 147  *
 148  *    Revision 1.33  2002/03/13 00:27:04  jongfoster
 149  *    Killing warnings
 150  *
 151  *    Revision 1.32  2002/03/07 03:46:17  oes
 152  *    Fixed compiler warnings
 153  *
 154  *    Revision 1.31  2002/03/06 23:02:57  jongfoster
 155  *    Removing tabs
 156  *
 157  *    Revision 1.30  2002/03/05 22:43:45  david__schmidt
 158  *    - Better error reporting on OS/2
 159  *    - Fix double-slash comment (oops)
 160  *
 161  *    Revision 1.29  2002/03/04 23:45:13  jongfoster
 162  *    Printing thread ID if using Win32 native threads
 163  *
 164  *    Revision 1.28  2002/03/04 17:59:59  oes
 165  *    Deleted deletePidFile(), cosmetics
 166  *
 167  *    Revision 1.27  2002/03/04 02:08:01  david__schmidt
 168  *    Enable web editing of actions file on OS/2 (it had been broken all this time!)
 169  *
 170  *    Revision 1.26  2002/01/09 19:05:45  steudten
 171  *    Fix big memory leak.
 172  *
 173  *    Revision 1.25  2002/01/09 14:32:08  oes
 174  *    Added support for gmtime_r and localtime_r.
 175  *
 176  *    Revision 1.24  2001/12/30 14:07:32  steudten
 177  *    - Add signal handling (unix)
 178  *    - Add SIGHUP handler (unix)
 179  *    - Add creation of pidfile (unix)
 180  *    - Add action 'top' in rc file (RH)
 181  *    - Add entry 'SIGNALS' to manpage
 182  *    - Add exit message to logfile (unix)
 183  *
 184  *    Revision 1.23  2001/11/07 00:02:13  steudten
 185  *    Add line number in error output for lineparsing for
 186  *    actionsfile and configfile.
 187  *    Special handling for CLF added.
 188  *
 189  *    Revision 1.22  2001/11/05 23:43:05  steudten
 190  *    Add time+date to log files.
 191  *
 192  *    Revision 1.21  2001/10/25 03:40:47  david__schmidt
 193  *    Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
 194  *    threads to call select() simultaneously.  So, it's time to do a real, live,
 195  *    native OS/2 port.  See defines for __EMX__ (the porting layer) vs. __OS2__
 196  *    (native). Both versions will work, but using __OS2__ offers multi-threading.
 197  *
 198  *    Revision 1.20  2001/09/16 23:04:34  jongfoster
 199  *    Fixing a warning
 200  *
 201  *    Revision 1.19  2001/09/13 20:08:06  jongfoster
 202  *    Adding support for LOG_LEVEL_CGI
 203  *
 204  *    Revision 1.18  2001/09/10 11:27:24  oes
 205  *    Declaration of w32_socket_strerr now conditional
 206  *
 207  *    Revision 1.17  2001/09/10 10:17:13  oes
 208  *    Removed unused variable; Fixed sprintf format
 209  *
 210  *    Revision 1.16  2001/07/30 22:08:36  jongfoster
 211  *    Tidying up #defines:
 212  *    - All feature #defines are now of the form FEATURE_xxx
 213  *    - Permanently turned off WIN_GUI_EDIT
 214  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
 215  *
 216  *    Revision 1.15  2001/07/29 17:41:10  jongfoster
 217  *    Now prints thread ID for each message (pthreads only)
 218  *
 219  *    Revision 1.14  2001/07/19 19:03:48  haroon
 220  *    - Added case for LOG_LEVEL_POPUPS
 221  *
 222  *    Revision 1.13  2001/07/13 13:58:58  oes
 223  *     - Added case for LOG_LEVEL_DEANIMATE
 224  *     - Removed all #ifdef PCRS
 225  *
 226  *    Revision 1.12  2001/06/09 10:55:28  jongfoster
 227  *    Changing BUFSIZ ==> BUFFER_SIZE
 228  *
 229  *    Revision 1.11  2001/06/01 18:14:49  jongfoster
 230  *    Changing the calls to strerr() to check HAVE_STRERR (which is defined
 231  *    in config.h if appropriate) rather than the NO_STRERR macro.
 232  *
 233  *    Revision 1.10  2001/05/29 11:52:21  oes
 234  *    Conditional compilation of w32_socket_error
 235  *
 236  *    Revision 1.9  2001/05/28 16:15:17  jongfoster
 237  *    Improved reporting of errors under Win32.
 238  *
 239  *    Revision 1.8  2001/05/26 17:25:14  jongfoster
 240  *    Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
 241  *
 242  *    Revision 1.7  2001/05/26 15:21:28  jongfoster
 243  *    Activity animation in Win32 GUI now works even if debug==0
 244  *
 245  *    Revision 1.6  2001/05/25 21:55:08  jongfoster
 246  *    Now cleans up properly on FATAL (removes taskbar icon etc)
 247  *
 248  *    Revision 1.5  2001/05/22 18:46:04  oes
 249  *
 250  *    - Enabled filtering banners by size rather than URL
 251  *      by adding patterns that replace all standard banner
 252  *      sizes with the "Junkbuster" gif to the re_filterfile
 253  *
 254  *    - Enabled filtering WebBugs by providing a pattern
 255  *      which kills all 1x1 images
 256  *
 257  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
 258  *      which is selected by the (nonstandard and therefore
 259  *      capital) letter 'U' in the option string.
 260  *      It causes the quantifiers to be ungreedy by default.
 261  *      Appending a ? turns back to greedy (!).
 262  *
 263  *    - Added a new interceptor ijb-send-banner, which
 264  *      sends back the "Junkbuster" gif. Without imagelist or
 265  *      MSIE detection support, or if tinygif = 1, or the
 266  *      URL isn't recognized as an imageurl, a lame HTML
 267  *      explanation is sent instead.
 268  *
 269  *    - Added new feature, which permits blocking remote
 270  *      script redirects and firing back a local redirect
 271  *      to the browser.
 272  *      The feature is conditionally compiled, i.e. it
 273  *      can be disabled with --disable-fast-redirects,
 274  *      plus it must be activated by a "fast-redirects"
 275  *      line in the config file, has its own log level
 276  *      and of course wants to be displayed by show-proxy-args
 277  *      Note: Boy, all the #ifdefs in 1001 locations and
 278  *      all the fumbling with configure.in and acconfig.h
 279  *      were *way* more work than the feature itself :-(
 280  *
 281  *    - Because a generic redirect template was needed for
 282  *      this, tinygif = 3 now uses the same.
 283  *
 284  *    - Moved GIFs, and other static HTTP response templates
 285  *      to project.h
 286  *
 287  *    - Some minor fixes
 288  *
 289  *    - Removed some >400 CRs again (Jon, you really worked
 290  *      a lot! ;-)
 291  *
 292  *    Revision 1.4  2001/05/21 19:32:54  jongfoster
 293  *    Added another #ifdef _WIN_CONSOLE
 294  *
 295  *    Revision 1.3  2001/05/20 01:11:40  jongfoster
 296  *    Added support for LOG_LEVEL_FATAL
 297  *    Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
 298  *    and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
 299  *
 300  *    Revision 1.2  2001/05/17 22:42:01  oes
 301  *     - Cleaned CRLF's from the sources and related files
 302  *     - Repaired logging for REF and FRC
 303  *
 304  *    Revision 1.1.1.1  2001/05/15 13:58:51  oes
 305  *    Initial import of version 2.9.3 source tree
 306  *
 307  *
 308  *********************************************************************/
 309 \f
 310
 311 #include <stdlib.h>
 312 #include <stdio.h>
 313 #include <stdarg.h>
 314 #include <string.h>
 315
 316 #include "config.h"
 317 #include "miscutil.h"
 318
 319 /* For gettimeofday() */
 320 #include <sys/time.h>
 321
 322 #if !defined(_WIN32) && !defined(__OS2__)
 323 #include <unistd.h>
 324 #endif /* !defined(_WIN32) && !defined(__OS2__) */
 325
 326 #include <errno.h>
 327 #include <assert.h>
 328
 329 #ifdef _WIN32
 330 #ifndef STRICT
 331 #define STRICT
 332 #endif
 333 #include <windows.h>
 334 #ifndef _WIN_CONSOLE
 335 #include "w32log.h"
 336 #endif /* ndef _WIN_CONSOLE */
 337 #endif /* def _WIN32 */
 338 #ifdef _MSC_VER
 339 #define inline __inline
 340 #endif /* def _MSC_VER */
 341
 342 #ifdef __OS2__
 343 #include <sys/socket.h> /* For sock_errno */
 344 #define INCL_DOS
 345 #include <os2.h>
 346 #endif
 347
 348 #include "errlog.h"
 349 #include "project.h"
 350 #include "jcc.h"
 351
 352 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
 353
 354
 355 /*
 356  * LOG_LEVEL_FATAL cannot be turned off.  (There are
 357  * some exceptional situations where we need to get a
 358  * message to the user).
 359  */
 360 #define LOG_LEVEL_MINIMUM  LOG_LEVEL_FATAL
 361
 362 /* where to log (default: stderr) */
 363 static FILE *logfp = NULL;
 364
 365 /* logging detail level.  */
 366 int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
 367
 368 /* static functions */
 369 static void fatal_error(const char * error_message);
 370 #ifdef _WIN32
 371 static char *w32_socket_strerr(int errcode, char *tmp_buf);
 372 #endif
 373 #ifdef __OS2__
 374 static char *os2_socket_strerr(int errcode, char *tmp_buf);
 375 #endif
 376
 377 #ifdef FEATURE_PTHREAD
 378 static inline void lock_logfile(void)
 379 {
 380    pthread_mutex_lock(&log_mutex);
 381 }
 382 static inline void unlock_logfile(void)
 383 {
 384    pthread_mutex_unlock(&log_mutex);
 385 }
 386 static inline void lock_loginit(void)
 387 {
 388    pthread_mutex_lock(&log_init_mutex);
 389 }
 390 static inline void unlock_loginit(void)
 391 {
 392    pthread_mutex_unlock(&log_init_mutex);
 393 }
 394 #else /* ! FEATURE_PTHREAD */
 395 /*
 396  * FIXME we need a cross-platform locking mechanism.
 397  * The locking/unlocking functions below should be
 398  * fleshed out for non-pthread implementations.
 399  */
 400 static inline void lock_logfile() {}
 401 static inline void unlock_logfile() {}
 402 static inline void lock_loginit() {}
 403 static inline void unlock_loginit() {}
 404 #endif
 405
 406 /*********************************************************************
 407  *
 408  * Function    :  fatal_error
 409  *
 410  * Description :  Displays a fatal error to standard error (or, on
 411  *                a WIN32 GUI, to a dialog box), and exits
 412  *                JunkBuster with status code 1.
 413  *
 414  * Parameters  :
 415  *          1  :  error_message = The error message to display.
 416  *
 417  * Returns     :  Does not return.
 418  *
 419  *********************************************************************/
 420 static void fatal_error(const char * error_message)
 421 {
 422 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
 423    MessageBox(g_hwndLogFrame, error_message, "Privoxy Error",
 424       MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
 425
 426    /* Cleanup - remove taskbar icon etc. */
 427    TermLogWindow();
 428
 429 #else /* if !defined(_WIN32) || defined(_WIN_CONSOLE) */
 430    fputs(error_message, logfp);
 431 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
 432
 433 #if defined(unix)
 434    if (pidfile)
 435    {
 436       unlink(pidfile);
 437    }
 438 #endif /* unix */
 439
 440    exit(1);
 441 }
 442
 443
 444 /*********************************************************************
 445  *
 446  * Function    :  show_version
 447  *
 448  * Description :  Logs the Privoxy version and the program name.
 449  *
 450  * Parameters  :
 451  *          1  :  prog_name = The program name.
 452  *
 453  * Returns     :  Nothing.
 454  *
 455  *********************************************************************/
 456 static void show_version(const char *prog_name)
 457 {
 458    log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
 459    if (prog_name != NULL)
 460    {
 461       log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
 462    }
 463 }
 464
 465
 466 /*********************************************************************
 467  *
 468  * Function    :  init_log_module
 469  *
 470  * Description :  Initializes the logging module to log to stderr.
 471  *                Can only be called while stderr hasn't been closed
 472  *                yet and is only supposed to be called once.
 473  *
 474  * Parameters  :
 475  *          1  :  prog_name = The program name.
 476  *
 477  * Returns     :  Nothing.
 478  *
 479  *********************************************************************/
 480 void init_log_module(const char *prog_name)
 481 {
 482    lock_logfile();
 483    logfp = stderr;
 484    unlock_logfile();
 485    set_debug_level(debug);
 486    show_version(prog_name);
 487 }
 488
 489
 490 /*********************************************************************
 491  *
 492  * Function    :  set_debug_level
 493  *
 494  * Description :  Sets the debug level to the provided value
 495  *                plus LOG_LEVEL_MINIMUM.
 496  *
 497  *                XXX: we should only use the LOG_LEVEL_MINIMUM
 498  *                until the frist time the configuration file has
 499  *                been parsed.
 500  *
 501  * Parameters  :  1: debug_level = The debug level to set.
 502  *
 503  * Returns     :  Nothing.
 504  *
 505  *********************************************************************/
 506 void set_debug_level(int debug_level)
 507 {
 508    debug = debug_level | LOG_LEVEL_MINIMUM;
 509 }
 510
 511
 512 /*********************************************************************
 513  *
 514  * Function    :  disable_logging
 515  *
 516  * Description :  Disables logging.
 517  *
 518  * Parameters  :  None.
 519  *
 520  * Returns     :  Nothing.
 521  *
 522  *********************************************************************/
 523 void disable_logging(void)
 524 {
 525    lock_logfile();
 526    if (logfp != NULL)
 527    {
 528       log_error(LOG_LEVEL_INFO, "No logfile configured. Logging disabled.");
 529       fclose(logfp);
 530       logfp = NULL;
 531    }
 532    unlock_logfile();
 533 }
 534
 535
 536 /*********************************************************************
 537  *
 538  * Function    :  init_error_log
 539  *
 540  * Description :  Initializes the logging module to log to a file.
 541  *
 542  *                XXX: should be renamed.
 543  *
 544  * Parameters  :
 545  *          1  :  prog_name  = The program name.
 546  *          2  :  logfname   = The logfile name, or NULL for stderr.
 547  *          3  :  debuglevel = The debugging level.
 548  *
 549  * Returns     :  N/A
 550  *
 551  *********************************************************************/
 552 void init_error_log(const char *prog_name, const char *logfname)
 553 {
 554    FILE *fp;
 555
 556    assert(NULL != logfname);
 557
 558    lock_loginit();
 559
 560    if (logfp != NULL)
 561    {
 562       log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
 563    }
 564
 565    /* set the designated log file */
 566    fp = fopen(logfname, "a");
 567    if (NULL == fp)
 568    {
 569       log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
 570    }
 571
 572    /* set logging to be completely unbuffered */
 573    setbuf(fp, NULL);
 574
 575    lock_logfile();
 576    if (logfp != NULL)
 577    {
 578       fclose(logfp);
 579    }
 580    logfp = fp;
 581    unlock_logfile();
 582
 583 #if !defined(_WIN32)
 584    /*
 585     * Prevent the Windows GUI from showing the version two
 586     * times in a row on startup. It already displayed the show_version()
 587     * call from init_log_module() that other systems write to stderr.
 588     *
 589     * This means mingw32 users will never see the version in their
 590     * log file, but I assume they wouldn't look for it there anyway
 591     * and simply use the "Help/About Privoxy" menu.
 592     */
 593    show_version(prog_name);
 594 #endif /* def unix */
 595
 596    unlock_loginit();
 597
 598 } /* init_error_log */
 599
 600
 601 /*********************************************************************
 602  *
 603  * Function    :  get_thread_id
 604  *
 605  * Description :  Returns a number that is different for each thread.
 606  *
 607  *                XXX: Should be moved elsewhere (miscutil.c?)
 608  *
 609  * Parameters  :  None
 610  *
 611  * Returns     :  thread_id
 612  *
 613  *********************************************************************/
 614 static long get_thread_id(void)
 615 {
 616    long this_thread = 1;  /* was: pthread_t this_thread;*/
 617
 618 #ifdef __OS2__
 619    PTIB     ptib;
 620    APIRET   ulrc; /* XXX: I have no clue what this does */
 621 #endif /* __OS2__ */
 622
 623    /* FIXME get current thread id */
 624 #ifdef FEATURE_PTHREAD
 625    this_thread = (long)pthread_self();
 626 #ifdef __MACH__
 627    /*
 628     * Mac OSX (and perhaps other Mach instances) doesn't have a debuggable
 629     * value at the first 4 bytes of pthread_self()'s return value, a pthread_t.
 630     * pthread_t is supposed to be opaque... but it's fairly random, though, so
 631     * we make it mostly presentable.
 632     */
 633    this_thread = abs(this_thread % 1000);
 634 #endif /* def __MACH__ */
 635 #elif defined(_WIN32)
 636    this_thread = GetCurrentThreadId();
 637 #elif defined(__OS2__)
 638    ulrc = DosGetInfoBlocks(&ptib, NULL);
 639    if (ulrc == 0)
 640      this_thread = ptib -> tib_ptib2 -> tib2_ultid;
 641 #endif /* def FEATURE_PTHREAD */
 642
 643    return this_thread;
 644 }
 645
 646
 647 /*********************************************************************
 648  *
 649  * Function    :  get_log_timestamp
 650  *
 651  * Description :  Generates the time stamp for the log message prefix.
 652  *
 653  * Parameters  :
 654  *          1  :  buffer = Storage buffer
 655  *          2  :  buffer_size = Size of storage buffer
 656  *
 657  * Returns     :  Number of written characters or 0 for error.
 658  *
 659  *********************************************************************/
 660 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
 661 {
 662    size_t length;
 663    time_t now;
 664    struct tm tm_now;
 665    struct timeval tv_now; /* XXX: stupid name */
 666    long msecs;
 667    int msecs_length = 0;
 668
 669    gettimeofday(&tv_now, NULL);
 670    msecs = tv_now.tv_usec / 1000;
 671
 672    time(&now);
 673
 674 #ifdef HAVE_LOCALTIME_R
 675    tm_now = *localtime_r(&now, &tm_now);
 676 #elif FEATURE_PTHREAD
 677    pthread_mutex_lock(&localtime_mutex);
 678    tm_now = *localtime(&now);
 679    pthread_mutex_unlock(&localtime_mutex);
 680 #else
 681    tm_now = *localtime(&now);
 682 #endif
 683
 684    length = strftime(buffer, buffer_size, "%b %d %H:%M:%S", &tm_now);
 685    if (length > 0);
 686    {
 687       msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);
 688    }
 689    if (msecs_length > 0)
 690    {
 691       length += (size_t)msecs_length;
 692    }
 693    else
 694    {
 695       length = 0;
 696    }
 697
 698    return length;
 699 }
 700
 701
 702 /*********************************************************************
 703  *
 704  * Function    :  get_clf_timestamp
 705  *
 706  * Description :  Generates a Common Log Format time string.
 707  *
 708  * Parameters  :
 709  *          1  :  buffer = Storage buffer
 710  *          2  :  buffer_size = Size of storage buffer
 711  *
 712  * Returns     :  Number of written characters or 0 for error.
 713  *
 714  *********************************************************************/
 715 static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
 716 {
 717    /*
 718     * Complex because not all OSs have tm_gmtoff or
 719     * the %z field in strftime()
 720     */
 721    time_t now;
 722    struct tm *tm_now;
 723    struct tm gmt;
 724 #ifdef HAVE_LOCALTIME_R
 725    struct tm dummy;
 726 #endif
 727    int days, hrs, mins;
 728    size_t length;
 729    int tz_length = 0;
 730
 731    time (&now);
 732 #ifdef HAVE_GMTIME_R
 733    gmt = *gmtime_r(&now, &gmt);
 734 #elif FEATURE_PTHREAD
 735    pthread_mutex_lock(&gmtime_mutex);
 736    gmt = *gmtime(&now);
 737    pthread_mutex_unlock(&gmtime_mutex);
 738 #else
 739    gmt = *gmtime(&now);
 740 #endif
 741 #ifdef HAVE_LOCALTIME_R
 742    tm_now = localtime_r(&now, &dummy);
 743 #elif FEATURE_PTHREAD
 744    pthread_mutex_lock(&localtime_mutex);
 745    tm_now = localtime(&now);
 746    pthread_mutex_unlock(&localtime_mutex);
 747 #else
 748    tm_now = localtime(&now);
 749 #endif
 750    days = tm_now->tm_yday - gmt.tm_yday;
 751    hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
 752    mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
 753
 754    length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
 755
 756    if (length > 0);
 757    {
 758       tz_length = snprintf(buffer+length, buffer_size-length,
 759                      "%+03d%02d", mins / 60, abs(mins) % 60);
 760    }
 761    if (tz_length > 0)
 762    {
 763       length += (size_t)tz_length;
 764    }
 765    else
 766    {
 767       length = 0;
 768    }
 769
 770    return length;
 771 }
 772
 773
 774 /*********************************************************************
 775  *
 776  * Function    :  get_log_level_string
 777  *
 778  * Description :  Translates a numerical loglevel into a string.
 779  *
 780  * Parameters  :
 781  *          1  :  loglevel = LOG_LEVEL_FOO
 782  *
 783  * Returns     :  Log level string.
 784  *
 785  *********************************************************************/
 786 static inline const char *get_log_level_string(int loglevel)
 787 {
 788    char *log_level_string = NULL;
 789
 790    assert(0 < loglevel);
 791
 792    switch (loglevel)
 793    {
 794       case LOG_LEVEL_ERROR:
 795          log_level_string = "Error";
 796          break;
 797       case LOG_LEVEL_FATAL:
 798          log_level_string = "Fatal error";
 799          break;
 800       case LOG_LEVEL_GPC:
 801          log_level_string = "Request";
 802          break;
 803       case LOG_LEVEL_CONNECT:
 804          log_level_string = "Connect";
 805          break;
 806       case LOG_LEVEL_LOG:
 807          log_level_string = "Writing";
 808          break;
 809       case LOG_LEVEL_HEADER:
 810          log_level_string = "Header";
 811          break;
 812       case LOG_LEVEL_INFO:
 813          log_level_string = "Info";
 814          break;
 815       case LOG_LEVEL_RE_FILTER:
 816          log_level_string = "Re-Filter";
 817          break;
 818 #ifdef FEATURE_FORCE_LOAD
 819       case LOG_LEVEL_FORCE:
 820          log_level_string = "Force";
 821          break;
 822 #endif /* def FEATURE_FORCE_LOAD */
 823 #ifdef FEATURE_FAST_REDIRECTS
 824       case LOG_LEVEL_REDIRECTS:
 825          log_level_string = "Redirect";
 826          break;
 827 #endif /* def FEATURE_FAST_REDIRECTS */
 828       case LOG_LEVEL_DEANIMATE:
 829          log_level_string = "Gif-Deanimate";
 830          break;
 831 #ifdef FEATURE_KILL_POPUPS
 832       case LOG_LEVEL_POPUPS:
 833          log_level_string = "Kill-Popups";
 834          break;
 835 #endif /* def FEATURE_KILL_POPUPS */
 836       case LOG_LEVEL_CGI:
 837          log_level_string = "CGI";
 838          break;
 839       default:
 840          log_level_string = "Unknown log level";
 841          break;
 842    }
 843    assert(NULL != log_level_string);
 844
 845    return log_level_string;
 846 }
 847
 848
 849 /*********************************************************************
 850  *
 851  * Function    :  log_error
 852  *
 853  * Description :  This is the error-reporting and logging function.
 854  *
 855  * Parameters  :
 856  *          1  :  loglevel  = the type of message to be logged
 857  *          2  :  fmt       = the main string we want logged, printf-like
 858  *          3  :  ...       = arguments to be inserted in fmt (printf-like).
 859  *
 860  * Returns     :  N/A
 861  *
 862  *********************************************************************/
 863 void log_error(int loglevel, const char *fmt, ...)
 864 {
 865    va_list ap;
 866    char *outbuf = NULL;
 867    static char *outbuf_save = NULL;
 868    char tempbuf[BUFFER_SIZE];
 869    size_t length = 0;
 870    const char * src = fmt;
 871    long thread_id;
 872    char timestamp[30];
 873    /*
 874     * XXX: Make this a config option,
 875     * why else do we allocate instead of using
 876     * an array?
 877     */
 878    size_t log_buffer_size = BUFFER_SIZE;
 879
 880 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
 881    /*
 882     * Irrespective of debug setting, a GET/POST/CONNECT makes
 883     * the taskbar icon animate.  (There is an option to disable
 884     * this but checking that is handled inside LogShowActivity()).
 885     */
 886    if (loglevel == LOG_LEVEL_GPC)
 887    {
 888       LogShowActivity();
 889    }
 890 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
 891
 892    /*
 893     * verify that the loglevel applies to current
 894     * settings and that logging is enabled.
 895     * Bail out otherwise.
 896     */
 897    if ((0 == (loglevel & debug)) || (logfp == NULL))
 898    {
 899       return;
 900    }
 901
 902    thread_id = get_thread_id();
 903    get_log_timestamp(timestamp, sizeof(timestamp));
 904
 905    /* protect the whole function because of the static buffer (outbuf) */
 906    lock_logfile();
 907
 908    if (NULL == outbuf_save)
 909    {
 910       outbuf_save = (char*)zalloc(log_buffer_size + 1); /* +1 for paranoia */
 911       if (NULL == outbuf_save)
 912       {
 913          snprintf(tempbuf, sizeof(tempbuf),
 914             "%s Privoxy(%08lx) Fatal error: log_error() failed to allocate buffer memory.\n"
 915             "\nExiting.", timestamp, thread_id);
 916          assert(NULL != logfp);
 917          fputs(tempbuf, logfp);
 918          unlock_logfile();
 919          fatal_error(tempbuf); /* Exit */
 920       }
 921    }
 922    outbuf = outbuf_save;
 923
 924    /*
 925     * Memsetting the whole buffer to zero (in theory)
 926     * makes things easier later on.
 927     */
 928    memset(outbuf, 0, log_buffer_size);
 929
 930    /* Add prefix for everything but Common Log Format messages */
 931    if (loglevel != LOG_LEVEL_CLF)
 932    {
 933       length = (size_t)snprintf(outbuf, log_buffer_size, "%s Privoxy(%08lx) %s: ",
 934                                 timestamp, thread_id, get_log_level_string(loglevel));
 935    }
 936
 937    /* get ready to scan var. args. */
 938    va_start(ap, fmt);
 939
 940    /* build formatted message from fmt and var-args */
 941    while ((*src) && (length < log_buffer_size-2))
 942    {
 943       const char *sval = NULL; /* %N string  */
 944       int ival;                /* %N string length or an error code */
 945       unsigned uval;           /* %u value */
 946       long lval;               /* %l value */
 947       unsigned long ulval;     /* %ul value */
 948       char ch;
 949       const char *format_string = tempbuf;
 950
 951       ch = *src++;
 952       if (ch != '%')
 953       {
 954          outbuf[length++] = ch;
 955          /*
 956           * XXX: Only necessary on platforms which don't use pthread
 957           * mutexes (mingw32 for example), where multiple threads can
 958           * write to the buffer at the same time.
 959           */
 960          outbuf[length] = '\0';
 961          continue;
 962       }
 963       outbuf[length] = '\0';
 964       ch = *src++;
 965       switch (ch) {
 966          case '%':
 967             tempbuf[0] = '%';
 968             tempbuf[1] = '\0';
 969             break;
 970          case 'd':
 971             ival = va_arg( ap, int );
 972             snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
 973             break;
 974          case 'u':
 975             uval = va_arg( ap, unsigned );
 976             snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
 977             break;
 978          case 'l':
 979             /* this is a modifier that must be followed by u or d */
 980             ch = *src++;
 981             if (ch == 'd')
 982             {
 983                lval = va_arg( ap, long );
 984                snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
 985             }
 986             else if (ch == 'u')
 987             {
 988                ulval = va_arg( ap, unsigned long );
 989                snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
 990             }
 991             else
 992             {
 993                snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
 994                loglevel = LOG_LEVEL_FATAL;
 995             }
 996             break;
 997          case 'c':
 998             /*
 999              * Note that char paramaters are converted to int, so we need to
1000              * pass "int" to va_arg.  (See K&R, 2nd ed, section A7.3.2, page 202)
1001              */
1002             tempbuf[0] = (char) va_arg(ap, int);
1003             tempbuf[1] = '\0';
1004             break;
1005          case 's':
1006             format_string = va_arg(ap, char *);
1007             if (format_string == NULL)
1008             {
1009                format_string = "[null]";
1010             }
1011             break;
1012          case 'N':
1013             /*
1014              * Non-standard: Print a counted unterminated string.
1015              * Takes 2 parameters: int length, const char * string.
1016              */
1017             ival = va_arg(ap, int);
1018             sval = va_arg(ap, char *);
1019             if (sval == NULL)
1020             {
1021                format_string = "[null]";
1022             }
1023             else if (ival <= 0)
1024             {
1025                if (0 == ival)
1026                {
1027                   /* That's ok (but stupid) */
1028                   tempbuf[0] = '\0';
1029                }
1030                else
1031                {
1032                   /*
1033                    * That's not ok (and even more stupid)
1034                    */
1035                   assert(ival >= 0);
1036                   format_string = "[counted string lenght < 0]";
1037                }
1038             }
1039             else if (ival >= sizeof(tempbuf))
1040             {
1041                /*
1042                 * String is too long, copy as much as possible.
1043                 * It will be further truncated later.
1044                 */
1045                memcpy(tempbuf, sval, sizeof(tempbuf)-1);
1046                tempbuf[sizeof(tempbuf)-1] = '\0';
1047             }
1048             else
1049             {
1050                memcpy(tempbuf, sval, (size_t) ival);
1051                tempbuf[ival] = '\0';
1052             }
1053             break;
1054          case 'E':
1055             /* Non-standard: Print error code from errno */
1056 #ifdef _WIN32
1057             ival = WSAGetLastError();
1058             format_string = w32_socket_strerr(ival, tempbuf);
1059 #elif __OS2__
1060             ival = sock_errno();
1061             if (ival != 0)
1062             {
1063                format_string = os2_socket_strerr(ival, tempbuf);
1064             }
1065             else
1066             {
1067                ival = errno;
1068                format_string = strerror(ival);
1069             }
1070 #else /* ifndef _WIN32 */
1071             ival = errno;
1072 #ifdef HAVE_STRERROR
1073             format_string = strerror(ival);
1074 #else /* ifndef HAVE_STRERROR */
1075             format_string = NULL;
1076 #endif /* ndef HAVE_STRERROR */
1077             if (sval == NULL)
1078             {
1079                snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
1080             }
1081 #endif /* ndef _WIN32 */
1082             break;
1083          case 'T':
1084             /* Non-standard: Print a Common Log File timestamp */
1085             get_clf_timestamp(tempbuf, sizeof(tempbuf));
1086             break;
1087          default:
1088             snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1089             loglevel = LOG_LEVEL_FATAL;
1090             break;
1091       } /* switch( p ) */
1092
1093       assert(length < log_buffer_size);
1094       length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
1095
1096       if (length >= log_buffer_size-2)
1097       {
1098          static char warning[] = "... [too long, truncated]";
1099
1100          length = log_buffer_size - sizeof(warning) - 1;
1101          length += strlcpy(outbuf + length, warning, log_buffer_size - length);
1102          assert(length < log_buffer_size);
1103
1104          break;
1105       }
1106    } /* for( p ... ) */
1107
1108    /* done with var. args */
1109    va_end(ap);
1110
1111    assert(length < log_buffer_size);
1112    length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
1113
1114    /* Some sanity checks */
1115    if (!(length < log_buffer_size)
1116     || !(outbuf[log_buffer_size-1] == '\0')
1117     || !(outbuf[log_buffer_size] == '\0')
1118       )
1119    {
1120       /* Repeat as assertions */
1121       assert(length < log_buffer_size);
1122       assert(outbuf[log_buffer_size-1] == '\0');
1123       /*
1124        * outbuf's real size is log_buffer_size+1,
1125        * so while this looks like an off-by-one,
1126        * we're only checking our paranoia byte.
1127        */
1128       assert(outbuf[log_buffer_size] == '\0');
1129
1130       snprintf(outbuf, log_buffer_size,
1131          "%s Privoxy(%08lx) Fatal error: log_error()'s sanity checks failed. length: %d\n"
1132          "Exiting.", timestamp, thread_id, (int)length);
1133       loglevel = LOG_LEVEL_FATAL;
1134    }
1135
1136    assert(NULL != logfp);
1137
1138    if (loglevel == LOG_LEVEL_FATAL)
1139    {
1140       fatal_error(outbuf_save);
1141       /* Never get here */
1142    }
1143    fputs(outbuf_save, logfp);
1144
1145    unlock_logfile();
1146
1147 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
1148    /* Write to display */
1149    LogPutString(outbuf_save);
1150 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1151
1152 }
1153
1154
1155 /*********************************************************************
1156  *
1157  * Function    :  jb_err_to_string
1158  *
1159  * Description :  Translates JB_ERR_FOO codes into strings.
1160  *
1161  *                XXX: the type of error codes is jb_err
1162  *                but the typedef'inition is currently not
1163  *                visible to all files that include errlog.h.
1164  *
1165  * Parameters  :
1166  *          1  :  error = a valid jb_err code
1167  *
1168  * Returns     :  A string with the jb_err translation
1169  *
1170  *********************************************************************/
1171 const char *jb_err_to_string(int error)
1172 {
1173    switch (error)
1174    {
1175       case JB_ERR_OK:
1176          return "Success, no error";
1177       case JB_ERR_MEMORY:
1178          return "Out of memory";
1179       case JB_ERR_CGI_PARAMS:
1180          return "Missing or corrupt CGI parameters";
1181       case JB_ERR_FILE:
1182          return "Error opening, reading or writing a file";
1183       case JB_ERR_PARSE:
1184          return "Parse error";
1185       case JB_ERR_MODIFIED:
1186          return "File has been modified outside of the CGI actions editor.";
1187       case JB_ERR_COMPRESS:
1188          return "(De)compression failure";
1189       default:
1190          assert(0);
1191          return "Unknown error";
1192    }
1193    assert(0);
1194    return "Internal error";
1195 }
1196
1197 #ifdef _WIN32
1198 /*********************************************************************
1199  *
1200  * Function    :  w32_socket_strerr
1201  *
1202  * Description :  Translate the return value from WSAGetLastError()
1203  *                into a string.
1204  *
1205  * Parameters  :
1206  *          1  :  errcode = The return value from WSAGetLastError().
1207  *          2  :  tmp_buf = A temporary buffer that might be used to
1208  *                          store the string.
1209  *
1210  * Returns     :  String representing the error code.  This may be
1211  *                a global string constant or a string stored in
1212  *                tmp_buf.
1213  *
1214  *********************************************************************/
1215 static char *w32_socket_strerr(int errcode, char *tmp_buf)
1216 {
1217 #define TEXT_FOR_ERROR(code,text) \
1218    if (errcode == code)           \
1219    {                              \
1220       return #code " - " text;    \
1221    }
1222
1223    TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
1224    TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1225    TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1226    TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1227    TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1228    TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1229    TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1230    TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1231    TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1232    TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1233    TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1234    TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1235    TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1236    TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1237    TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1238    TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1239    TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1240    TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1241    TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1242    TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1243    TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1244    TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1245    TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1246    TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1247    TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1248    TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1249    TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1250    TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1251    TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1252    TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1253    TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1254    TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1255    TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1256    TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1257    TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1258    TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1259    TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1260    TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1261    TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1262    TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1263    TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1264    TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1265    /*
1266     * The following error codes are documented in the Microsoft WinSock
1267     * reference guide, but don't actually exist.
1268     *
1269     * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1270     * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1271     * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1272     * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1273     * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1274     * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1275     * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1276     * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1277     * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1278     * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1279     */
1280
1281    sprintf(tmp_buf, "(error number %d)", errcode);
1282    return tmp_buf;
1283 }
1284 #endif /* def _WIN32 */
1285
1286
1287 #ifdef __OS2__
1288 /*********************************************************************
1289  *
1290  * Function    :  os2_socket_strerr
1291  *
1292  * Description :  Translate the return value from sock_errno()
1293  *                into a string.
1294  *
1295  * Parameters  :
1296  *          1  :  errcode = The return value from sock_errno().
1297  *          2  :  tmp_buf = A temporary buffer that might be used to
1298  *                          store the string.
1299  *
1300  * Returns     :  String representing the error code.  This may be
1301  *                a global string constant or a string stored in
1302  *                tmp_buf.
1303  *
1304  *********************************************************************/
1305 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1306 {
1307 #define TEXT_FOR_ERROR(code,text) \
1308    if (errcode == code)           \
1309    {                              \
1310       return #code " - " text;    \
1311    }
1312
1313    TEXT_FOR_ERROR(SOCEPERM          , "Not owner.")
1314    TEXT_FOR_ERROR(SOCESRCH          , "No such process.")
1315    TEXT_FOR_ERROR(SOCEINTR          , "Interrupted system call.")
1316    TEXT_FOR_ERROR(SOCENXIO          , "No such device or address.")
1317    TEXT_FOR_ERROR(SOCEBADF          , "Bad file number.")
1318    TEXT_FOR_ERROR(SOCEACCES         , "Permission denied.")
1319    TEXT_FOR_ERROR(SOCEFAULT         , "Bad address.")
1320    TEXT_FOR_ERROR(SOCEINVAL         , "Invalid argument.")
1321    TEXT_FOR_ERROR(SOCEMFILE         , "Too many open files.")
1322    TEXT_FOR_ERROR(SOCEPIPE          , "Broken pipe.")
1323    TEXT_FOR_ERROR(SOCEWOULDBLOCK    , "Operation would block.")
1324    TEXT_FOR_ERROR(SOCEINPROGRESS    , "Operation now in progress.")
1325    TEXT_FOR_ERROR(SOCEALREADY       , "Operation already in progress.")
1326    TEXT_FOR_ERROR(SOCENOTSOCK       , "Socket operation on non-socket.")
1327    TEXT_FOR_ERROR(SOCEDESTADDRREQ   , "Destination address required.")
1328    TEXT_FOR_ERROR(SOCEMSGSIZE       , "Message too long.")
1329    TEXT_FOR_ERROR(SOCEPROTOTYPE     , "Protocol wrong type for socket.")
1330    TEXT_FOR_ERROR(SOCENOPROTOOPT    , "Protocol not available.")
1331    TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1332    TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1333    TEXT_FOR_ERROR(SOCEOPNOTSUPP     , "Operation not supported.")
1334    TEXT_FOR_ERROR(SOCEPFNOSUPPORT   , "Protocol family not supported.")
1335    TEXT_FOR_ERROR(SOCEAFNOSUPPORT   , "Address family not supported by protocol family.")
1336    TEXT_FOR_ERROR(SOCEADDRINUSE     , "Address already in use.")
1337    TEXT_FOR_ERROR(SOCEADDRNOTAVAIL  , "Can't assign requested address.")
1338    TEXT_FOR_ERROR(SOCENETDOWN       , "Network is down.")
1339    TEXT_FOR_ERROR(SOCENETUNREACH    , "Network is unreachable.")
1340    TEXT_FOR_ERROR(SOCENETRESET      , "Network dropped connection on reset.")
1341    TEXT_FOR_ERROR(SOCECONNABORTED   , "Software caused connection abort.")
1342    TEXT_FOR_ERROR(SOCECONNRESET     , "Connection reset by peer.")
1343    TEXT_FOR_ERROR(SOCENOBUFS        , "No buffer space available.")
1344    TEXT_FOR_ERROR(SOCEISCONN        , "Socket is already connected.")
1345    TEXT_FOR_ERROR(SOCENOTCONN       , "Socket is not connected.")
1346    TEXT_FOR_ERROR(SOCESHUTDOWN      , "Can't send after socket shutdown.")
1347    TEXT_FOR_ERROR(SOCETOOMANYREFS   , "Too many references: can't splice.")
1348    TEXT_FOR_ERROR(SOCETIMEDOUT      , "Operation timed out.")
1349    TEXT_FOR_ERROR(SOCECONNREFUSED   , "Connection refused.")
1350    TEXT_FOR_ERROR(SOCELOOP          , "Too many levels of symbolic links.")
1351    TEXT_FOR_ERROR(SOCENAMETOOLONG   , "File name too long.")
1352    TEXT_FOR_ERROR(SOCEHOSTDOWN      , "Host is down.")
1353    TEXT_FOR_ERROR(SOCEHOSTUNREACH   , "No route to host.")
1354    TEXT_FOR_ERROR(SOCENOTEMPTY      , "Directory not empty.")
1355    TEXT_FOR_ERROR(SOCEOS2ERR        , "OS/2 Error.")
1356
1357    sprintf(tmp_buf, "(error number %d)", errcode);
1358    return tmp_buf;
1359 }
1360 #endif /* def __OS2__ */
1361
1362
1363 /*
1364   Local Variables:
1365   tab-width: 3
1366   end:
1367 */