tools/winedump/dump.c

   1 /*
   2  *      File dumping utility
   3  *
   4  *      Copyright 2001,2007 Eric Pouech
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include "config.h"
  22
  23 #include <stdlib.h>
  24 #include <stdarg.h>
  25 #include <stdio.h>
  26 #include <time.h>
  27
  28 #include "../tools.h"
  29 #include "windef.h"
  30 #include "winbase.h"
  31 #include "winedump.h"
  32
  33 void *dump_base = NULL;
  34 size_t dump_total_len = 0;
  35
  36 void dump_data( const unsigned char *ptr, unsigned int size, const char *prefix )
  37 {
  38     unsigned int i, j;
  39
  40     printf( "%s%08x: ", prefix, 0 );
  41     if (!ptr)
  42     {
  43         printf("NULL\n");
  44         return;
  45     }
  46     for (i = 0; i < size; i++)
  47     {
  48         printf( "%02x%c", ptr[i], (i % 16 == 7) ? '-' : ' ' );
  49         if ((i % 16) == 15)
  50         {
  51             printf( " " );
  52             for (j = 0; j < 16; j++)
  53                 printf( "%c", isprint(ptr[i-15+j]) ? ptr[i-15+j] : '.' );
  54             if (i < size-1) printf( "\n%s%08x: ", prefix, i + 1 );
  55         }
  56     }
  57     if (i % 16)
  58     {
  59         printf( "%*s ", 3 * (16-(i%16)), "" );
  60         for (j = 0; j < i % 16; j++)
  61             printf( "%c", isprint(ptr[i-(i%16)+j]) ? ptr[i-(i%16)+j] : '.' );
  62     }
  63     printf( "\n" );
  64 }
  65
  66 static char* dump_want_n(unsigned sz)
  67 {
  68     static char         buffer[4 * 1024];
  69     static unsigned     idx;
  70     char*               ret;
  71
  72     assert(sz < sizeof(buffer));
  73     if (idx + sz >= sizeof(buffer)) idx = 0;
  74     ret = &buffer[idx];
  75     idx += sz;
  76     return ret;
  77 }
  78
  79 const char *get_time_str(unsigned long _t)
  80 {
  81     const time_t    t = (const time_t)_t;
  82     const char      *str = ctime(&t);
  83     size_t          len;
  84     char*           buf;
  85
  86     if (!str) return "not valid time";
  87
  88     len = strlen(str);
  89     /* FIXME: I don't get the same values from MS' pedump running under Wine...
  90      * I wonder if Wine isn't broken wrt to GMT settings...
  91      */
  92     if (len && str[len-1] == '\n') len--;
  93     buf = dump_want_n(len + 1);
  94     if (buf)
  95     {
  96         memcpy( buf, str, len );
  97         buf[len] = 0;
  98     }
  99     return buf;
 100 }
 101
 102 unsigned int strlenW( const WCHAR *str )
 103 {
 104     const WCHAR *s = str;
 105     while (*s) s++;
 106     return s - str;
 107 }
 108
 109 void dump_unicode_str( const WCHAR *str, int len )
 110 {
 111     if (len == -1) len = strlenW( str );
 112     printf( "L\"");
 113     while (len-- > 0 && *str)
 114     {
 115         WCHAR c = *str++;
 116         switch (c)
 117         {
 118         case '\n': printf( "\\n" ); break;
 119         case '\r': printf( "\\r" ); break;
 120         case '\t': printf( "\\t" ); break;
 121         case '"':  printf( "\\\"" ); break;
 122         case '\\': printf( "\\\\" ); break;
 123         default:
 124             if (c >= ' ' && c <= 126) putchar(c);
 125             else printf( "\\u%04x",c);
 126         }
 127     }
 128     printf( "\"" );
 129 }
 130
 131 const char* get_symbol_str(const char* symname)
 132 {
 133     char*       tmp;
 134     const char* ret;
 135
 136     if (!symname) return "(nil)";
 137     if (globals.do_demangle)
 138     {
 139         parsed_symbol   symbol;
 140
 141         symbol_init(&symbol, symname);
 142         if (!symbol_demangle(&symbol))
 143             ret = symname;
 144         else if (symbol.flags & SYM_DATA)
 145         {
 146             ret = tmp = dump_want_n(strlen(symbol.arg_text[0]) + 1);
 147             if (tmp) strcpy(tmp, symbol.arg_text[0]);
 148         }
 149         else
 150         {
 151             unsigned int i, len, start = symbol.flags & SYM_THISCALL ? 1 : 0;
 152
 153             len = strlen(symbol.return_text) + 3 /* ' __' */ +
 154                 strlen(symbol_get_call_convention(&symbol)) + 1 /* ' ' */+
 155                 strlen(symbol.function_name) + 1 /* ')' */;
 156             if (!symbol.argc || (symbol.argc == 1 && symbol.flags & SYM_THISCALL))
 157                 len += 4 /* "void" */;
 158             else for (i = start; i < symbol.argc; i++)
 159                 len += (i > start ? 2 /* ", " */ : 0 /* "" */) + strlen(symbol.arg_text[i]);
 160             if (symbol.varargs) len += 5 /* ", ..." */;
 161             len += 2; /* ")\0" */
 162
 163             ret = tmp = dump_want_n(len);
 164             if (tmp)
 165             {
 166                 sprintf(tmp, "%s __%s %s(",
 167                         symbol.return_text,
 168                         symbol_get_call_convention(&symbol),
 169                         symbol.function_name);
 170                 if (!symbol.argc || (symbol.argc == 1 && symbol.flags & SYM_THISCALL))
 171                     strcat(tmp, "void");
 172                 else for (i = start; i < symbol.argc; i++)
 173                 {
 174                     if (i > start) strcat(tmp, ", ");
 175                     strcat(tmp, symbol.arg_text[i]);
 176                 }
 177                 if (symbol.varargs) strcat(tmp, ", ...");
 178                 strcat(tmp, ")");
 179             }
 180         }
 181         symbol_clear(&symbol);
 182     }
 183     else ret = symname;
 184     return ret;
 185 }
 186
 187 const char* get_guid_str(const GUID* guid)
 188 {
 189     char* str;
 190
 191     str = dump_want_n(39);
 192     if (str)
 193         sprintf(str, "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
 194                 (unsigned int)guid->Data1, guid->Data2, guid->Data3,
 195                 guid->Data4[0], guid->Data4[1], guid->Data4[2], guid->Data4[3],
 196                 guid->Data4[4], guid->Data4[5], guid->Data4[6], guid->Data4[7]);
 197     return str;
 198 }
 199
 200 const char *get_unicode_str( const WCHAR *str, int len )
 201 {
 202     char *buffer;
 203     int i = 0;
 204
 205     if (len == -1) len = strlenW( str );
 206     buffer = dump_want_n( len * 6 + 3);
 207     buffer[i++] = '"';
 208     while (len-- > 0 && *str)
 209     {
 210         WCHAR c = *str++;
 211         switch (c)
 212         {
 213         case '\n': strcpy( buffer + i, "\\n" );  i += 2; break;
 214         case '\r': strcpy( buffer + i, "\\r" );  i += 2; break;
 215         case '\t': strcpy( buffer + i, "\\t" );  i += 2; break;
 216         case '"':  strcpy( buffer + i, "\\\"" ); i += 2; break;
 217         case '\\': strcpy( buffer + i, "\\\\" ); i += 2; break;
 218         default:
 219             if (c >= ' ' && c <= 126) buffer[i++] = c;
 220             else i += sprintf( buffer + i, "\\u%04x",c);
 221         }
 222     }
 223     buffer[i++] = '"';
 224     buffer[i] = 0;
 225     return buffer;
 226 }
 227
 228 const void*     PRD(unsigned long prd, unsigned long len)
 229 {
 230     return (prd + len > dump_total_len) ? NULL : (const char*)dump_base + prd;
 231 }
 232
 233 unsigned long Offset(const void* ptr)
 234 {
 235     if (ptr < dump_base) {printf("<<<<<ptr below\n");return 0;}
 236     if ((const char *)ptr >= (const char*)dump_base + dump_total_len) {printf("<<<<<ptr above\n");return 0;}
 237     return (const char *)ptr - (const char *)dump_base;
 238 }
 239
 240 static const struct dumper
 241 {
 242     enum FileSig        kind;
 243     enum FileSig        (*get_kind)(void);
 244     file_dumper         dumper; /* default dump tool */
 245 }
 246 dumpers[] =
 247 {
 248     {SIG_DOS,           get_kind_exec,  dos_dump},
 249     {SIG_PE,            get_kind_exec,  pe_dump},
 250     {SIG_DBG,           get_kind_dbg,   dbg_dump},
 251     {SIG_PDB,           get_kind_pdb,   pdb_dump},
 252     {SIG_NE,            get_kind_exec,  ne_dump},
 253     {SIG_LE,            get_kind_exec,  le_dump},
 254     {SIG_COFFLIB,       get_kind_lib,   lib_dump},
 255     {SIG_MDMP,          get_kind_mdmp,  mdmp_dump},
 256     {SIG_LNK,           get_kind_lnk,   lnk_dump},
 257     {SIG_EMF,           get_kind_emf,   emf_dump},
 258     {SIG_MF,            get_kind_mf,    mf_dump},
 259     {SIG_FNT,           get_kind_fnt,   fnt_dump},
 260     {SIG_TLB,           get_kind_tlb,   tlb_dump},
 261     {SIG_NLS,           get_kind_nls,   nls_dump},
 262     {SIG_UNKNOWN,       NULL,           NULL} /* sentinel */
 263 };
 264
 265 BOOL dump_analysis(const char *name, file_dumper fn, enum FileSig wanted_sig)
 266 {
 267     BOOL                ret = TRUE;
 268     const struct dumper *dpr;
 269
 270     setbuf(stdout, NULL);
 271
 272     if (!(dump_base = read_file( name, &dump_total_len ))) fatal( "Cannot read file" );
 273
 274     printf("Contents of %s: %zu bytes\n\n", name, dump_total_len);
 275
 276     for (dpr = dumpers; dpr->kind != SIG_UNKNOWN; dpr++)
 277     {
 278         if (dpr->get_kind() == dpr->kind &&
 279             (wanted_sig == SIG_UNKNOWN || wanted_sig == dpr->kind))
 280         {
 281             if (fn) fn(); else dpr->dumper();
 282             break;
 283         }
 284     }
 285     if (dpr->kind == SIG_UNKNOWN)
 286     {
 287         printf("Can't get a suitable file signature, aborting\n");
 288         ret = FALSE;
 289     }
 290
 291     if (ret) printf("Done dumping %s\n", name);
 292     free( dump_base );
 293
 294     return ret;
 295 }
 296
 297 void    dump_file(const char* name)
 298 {
 299     dump_analysis(name, NULL, SIG_UNKNOWN);
 300 }