debug.cpp

Go to the documentation of this file.
00001 /* $Id: debug.cpp 26058 2013-11-23 13:15:07Z rubidium $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
00008  */
00009 
00012 #include "stdafx.h"
00013 #include <stdarg.h>
00014 #include "console_func.h"
00015 #include "debug.h"
00016 #include "string_func.h"
00017 #include "fileio_func.h"
00018 #include "settings_type.h"
00019 
00020 #include <time.h>
00021 
00022 #if defined(ENABLE_NETWORK)
00023 #include "network/network_admin.h"
00024 SOCKET _debug_socket = INVALID_SOCKET;
00025 #endif /* ENABLE_NETWORK */
00026 
00027 int _debug_driver_level;
00028 int _debug_grf_level;
00029 int _debug_map_level;
00030 int _debug_misc_level;
00031 int _debug_net_level;
00032 int _debug_sprite_level;
00033 int _debug_oldloader_level;
00034 int _debug_npf_level;
00035 int _debug_yapf_level;
00036 int _debug_freetype_level;
00037 int _debug_script_level;
00038 int _debug_sl_level;
00039 int _debug_gamelog_level;
00040 int _debug_desync_level;
00041 int _debug_console_level;
00042 #ifdef RANDOM_DEBUG
00043 int _debug_random_level;
00044 #endif
00045 
00046 uint32 _realtime_tick = 0;
00047 
00048 struct DebugLevel {
00049   const char *name;
00050   int *level;
00051 };
00052 
00053 #define DEBUG_LEVEL(x) { #x, &_debug_##x##_level }
00054   static const DebugLevel debug_level[] = {
00055   DEBUG_LEVEL(driver),
00056   DEBUG_LEVEL(grf),
00057   DEBUG_LEVEL(map),
00058   DEBUG_LEVEL(misc),
00059   DEBUG_LEVEL(net),
00060   DEBUG_LEVEL(sprite),
00061   DEBUG_LEVEL(oldloader),
00062   DEBUG_LEVEL(npf),
00063   DEBUG_LEVEL(yapf),
00064   DEBUG_LEVEL(freetype),
00065   DEBUG_LEVEL(script),
00066   DEBUG_LEVEL(sl),
00067   DEBUG_LEVEL(gamelog),
00068   DEBUG_LEVEL(desync),
00069   DEBUG_LEVEL(console),
00070 #ifdef RANDOM_DEBUG
00071   DEBUG_LEVEL(random),
00072 #endif
00073   };
00074 #undef DEBUG_LEVEL
00075 
00082 char *DumpDebugFacilityNames(char *buf, char *last)
00083 {
00084   size_t length = 0;
00085   for (const DebugLevel *i = debug_level; i != endof(debug_level); ++i) {
00086     if (length == 0) {
00087       buf = strecpy(buf, "List of debug facility names:\n", last);
00088     } else {
00089       buf = strecpy(buf, ", ", last);
00090       length += 2;
00091     }
00092     buf = strecpy(buf, i->name, last);
00093     length += strlen(i->name);
00094   }
00095   if (length > 0) {
00096     buf = strecpy(buf, "\n\n", last);
00097   }
00098   return buf;
00099 }
00100 
00101 #if !defined(NO_DEBUG_MESSAGES)
00102 
00108 static void debug_print(const char *dbg, const char *buf)
00109 {
00110 #if defined(ENABLE_NETWORK)
00111   if (_debug_socket != INVALID_SOCKET) {
00112     char buf2[1024 + 32];
00113 
00114     snprintf(buf2, lengthof(buf2), "%sdbg: [%s] %s\n", GetLogPrefix(), dbg, buf);
00115     /* Sending out an error when this fails would be nice, however... the error
00116      * would have to be send over this failing socket which won't work. */
00117     send(_debug_socket, buf2, (int)strlen(buf2), 0);
00118     return;
00119   }
00120 #endif /* ENABLE_NETWORK */
00121   if (strcmp(dbg, "desync") == 0) {
00122     static FILE *f = FioFOpenFile("commands-out.log", "wb", AUTOSAVE_DIR);
00123     if (f == NULL) return;
00124 
00125     fprintf(f, "%s%s\n", GetLogPrefix(), buf);
00126     fflush(f);
00127 #ifdef RANDOM_DEBUG
00128   } else if (strcmp(dbg, "random") == 0) {
00129     static FILE *f = FioFOpenFile("random-out.log", "wb", AUTOSAVE_DIR);
00130     if (f == NULL) return;
00131 
00132     fprintf(f, "%s\n", buf);
00133     fflush(f);
00134 #endif
00135   } else {
00136     char buffer[512];
00137     seprintf(buffer, lastof(buffer), "%sdbg: [%s] %s\n", GetLogPrefix(), dbg, buf);
00138 #if defined(WINCE)
00139     NKDbgPrintfW(OTTD2FS(buffer));
00140 #elif defined(WIN32) || defined(WIN64)
00141     _fputts(OTTD2FS(buffer, true), stderr);
00142 #else
00143     fputs(buffer, stderr);
00144 #endif
00145 #ifdef ENABLE_NETWORK
00146     NetworkAdminConsole(dbg, buf);
00147 #endif /* ENABLE_NETWORK */
00148     IConsoleDebug(dbg, buf);
00149   }
00150 }
00151 
00158 void CDECL debug(const char *dbg, const char *format, ...)
00159 {
00160   char buf[1024];
00161 
00162   va_list va;
00163   va_start(va, format);
00164   vsnprintf(buf, lengthof(buf), format, va);
00165   va_end(va);
00166 
00167   debug_print(dbg, buf);
00168 }
00169 #endif /* NO_DEBUG_MESSAGES */
00170 
00177 void SetDebugString(const char *s)
00178 {
00179   int v;
00180   char *end;
00181   const char *t;
00182 
00183   /* global debugging level? */
00184   if (*s >= '0' && *s <= '9') {
00185     const DebugLevel *i;
00186 
00187     v = strtoul(s, &end, 0);
00188     s = end;
00189 
00190     for (i = debug_level; i != endof(debug_level); ++i) *i->level = v;
00191   }
00192 
00193   /* individual levels */
00194   for (;;) {
00195     const DebugLevel *i;
00196     int *p;
00197 
00198     /* skip delimiters */
00199     while (*s == ' ' || *s == ',' || *s == '\t') s++;
00200     if (*s == '\0') break;
00201 
00202     t = s;
00203     while (*s >= 'a' && *s <= 'z') s++;
00204 
00205     /* check debugging levels */
00206     p = NULL;
00207     for (i = debug_level; i != endof(debug_level); ++i) {
00208       if (s == t + strlen(i->name) && strncmp(t, i->name, s - t) == 0) {
00209         p = i->level;
00210         break;
00211       }
00212     }
00213 
00214     if (*s == '=') s++;
00215     v = strtoul(s, &end, 0);
00216     s = end;
00217     if (p != NULL) {
00218       *p = v;
00219     } else {
00220       ShowInfoF("Unknown debug level '%.*s'", (int)(s - t), t);
00221       return;
00222     }
00223   }
00224 }
00225 
00231 const char *GetDebugString()
00232 {
00233   const DebugLevel *i;
00234   static char dbgstr[150];
00235   char dbgval[20];
00236 
00237   memset(dbgstr, 0, sizeof(dbgstr));
00238   i = debug_level;
00239   snprintf(dbgstr, sizeof(dbgstr), "%s=%d", i->name, *i->level);
00240 
00241   for (i++; i != endof(debug_level); i++) {
00242     snprintf(dbgval, sizeof(dbgval), ", %s=%d", i->name, *i->level);
00243     strecat(dbgstr, dbgval, lastof(dbgstr));
00244   }
00245 
00246   return dbgstr;
00247 }
00248 
00254 const char *GetLogPrefix()
00255 {
00256   static char _log_prefix[24];
00257   if (_settings_client.gui.show_date_in_logs) {
00258     time_t cur_time = time(NULL);
00259     strftime(_log_prefix, sizeof(_log_prefix), "[%Y-%m-%d %H:%M:%S] ", localtime(&cur_time));
00260   } else {
00261     *_log_prefix = '\0';
00262   }
00263   return _log_prefix;
00264 }
00265