tools/winedump/main.c

   1 /*
   2  *  Option processing and main()
   3  *
   4  *  Copyright 2000 Jon Griffiths
   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 "winedump.h"
  24
  25 _globals globals; /* All global variables */
  26
  27
  28 static void do_include (const char *arg)
  29 {
  30   if (!globals.directory)
  31     globals.directory = xstrdup(arg);
  32   else
  33     globals.directory = strmake( "%s %s", globals.directory, arg );
  34   globals.do_code = TRUE;
  35 }
  36
  37
  38 static inline const char* strip_ext (const char *str)
  39 {
  40   int len = strlen(str);
  41   if (len>4 && strcmp(str+len-4,".dll") == 0)
  42     return str_substring (str, str+len-4);
  43   else
  44     return xstrdup (str);
  45 }
  46
  47
  48 static void do_name (const char *arg)
  49 {
  50   globals.dll_name = strip_ext (arg);
  51 }
  52
  53
  54 static void do_spec (const char *arg)
  55 {
  56     if (globals.mode != NONE) fatal("Only one mode can be specified\n");
  57     globals.mode = SPEC;
  58 }
  59
  60
  61 static void do_demangle (const char *arg)
  62 {
  63     if (globals.mode != NONE) fatal("Only one mode can be specified\n");
  64     globals.mode = DMGL;
  65     globals.do_code = TRUE;
  66     globals.do_demangle = TRUE;
  67 }
  68
  69
  70 static void do_dump (const char *arg)
  71 {
  72     if (globals.mode != NONE) fatal("Only one mode can be specified\n");
  73     globals.mode = DUMP;
  74     globals.do_code = TRUE;
  75 }
  76
  77
  78 static void do_code (const char *arg)
  79 {
  80   globals.do_code = TRUE;
  81 }
  82
  83
  84 static void do_trace (const char *arg)
  85 {
  86   globals.do_trace = TRUE;
  87   globals.do_code = TRUE;
  88 }
  89
  90
  91 static void do_forward (const char *arg)
  92 {
  93   globals.forward_dll = arg;
  94   globals.do_trace = TRUE;
  95   globals.do_code = TRUE;
  96 }
  97
  98 static void do_document (const char *arg)
  99 {
 100   globals.do_documentation = TRUE;
 101 }
 102
 103 static void do_cdecl (const char *arg)
 104 {
 105   globals.do_cdecl = TRUE;
 106 }
 107
 108
 109 static void do_quiet (const char *arg)
 110 {
 111   globals.do_quiet = TRUE;
 112 }
 113
 114
 115 static void do_start (const char *arg)
 116 {
 117   globals.start_ordinal = atoi (arg);
 118   if (!globals.start_ordinal)
 119     fatal ("Invalid -s option (must be numeric)");
 120 }
 121
 122
 123 static void do_end (const char *arg)
 124 {
 125   globals.end_ordinal = atoi (arg);
 126   if (!globals.end_ordinal)
 127     fatal ("Invalid -e option (must be numeric)");
 128 }
 129
 130
 131 static void do_symfile (const char *arg)
 132 {
 133   FILE *f;
 134   char symstring[256];    /* keep count with "%<width>s" below */
 135   search_symbol *symbolp,**symbolptail = &globals.search_symbol;
 136
 137   if (!(f = fopen(arg, "rt")))
 138     fatal ("Cannot open <symfile>");
 139   while (1 == fscanf(f, "%255s", symstring))    /* keep count with [<width>] above */
 140   {
 141     symstring[sizeof(symstring)-1] = '\0';
 142     symbolp = xmalloc(sizeof(*symbolp) + strlen(symstring));
 143     strcpy(symbolp->symbolname, symstring);
 144     symbolp->found = FALSE;
 145     symbolp->next = NULL;
 146     *symbolptail = symbolp;
 147     symbolptail = &symbolp->next;
 148   }
 149   if (fclose(f))
 150     fatal ("Cannot close <symfile>");
 151 }
 152
 153
 154 static void do_verbose (const char *arg)
 155 {
 156   globals.do_verbose = TRUE;
 157 }
 158
 159
 160 static void do_symdmngl (const char *arg)
 161 {
 162     globals.do_demangle = TRUE;
 163 }
 164
 165 static void do_dumphead (const char *arg)
 166 {
 167     globals.do_dumpheader = TRUE;
 168 }
 169
 170 static void do_dumpsect (const char* arg)
 171 {
 172     globals.dumpsect = arg;
 173 }
 174
 175 static void do_rawdebug (const char *arg)
 176 {
 177     globals.do_debug = TRUE;
 178 }
 179
 180 static void do_dumpall(const char *arg)
 181 {
 182     globals.do_dumpheader = TRUE;
 183     globals.do_dump_rawdata = TRUE;
 184     globals.do_symbol_table = TRUE;
 185     globals.dumpsect = "ALL";
 186 }
 187
 188 static void do_symtable(const char* arg)
 189 {
 190     globals.do_symbol_table = TRUE;
 191 }
 192
 193 struct my_option
 194 {
 195   const char *name;
 196   Mode mode;
 197   int   has_arg;
 198   void  (*func)(const char *arg);
 199   const char *usage;
 200 };
 201
 202 static const struct my_option option_table[] = {
 203   {"--help",NONE, 0, do_usage,    "--help          Display this help message"},
 204   {"-h",    NONE, 0, do_usage,    "-h              Synonym for --help"},
 205   {"-?",    NONE, 0, do_usage,    "-?              Synonym for --help"},
 206   {"dump",  DUMP, 0, do_dump,     "dump <file>     Dump the contents of 'file' (dll, exe, lib...)"},
 207   {"-C",    DUMP, 0, do_symdmngl, "-C              Turn on symbol demangling"},
 208   {"-f",    DUMP, 0, do_dumphead, "-f              Dump file header information"},
 209   {"-G",    DUMP, 0, do_rawdebug, "-G              Dump raw debug information"},
 210   {"-j",    DUMP, 1, do_dumpsect, "-j <sect_name>  Dump only the content of section 'sect_name' (import, export, debug, resource, tls, loadcfg, clr, reloc, except)"},
 211   {"-t",    DUMP, 0, do_symtable, "-t              Dump symbol table"},
 212   {"-x",    DUMP, 0, do_dumpall,  "-x              Dump everything"},
 213   {"sym",   DMGL, 0, do_demangle, "sym <sym>       Demangle C++ symbol <sym> and exit"},
 214   {"spec",  SPEC, 0, do_spec,     "spec <dll>      Use 'dll' for input file and generate implementation code"},
 215   {"-I",    SPEC, 1, do_include,  "-I <dir>        Look for prototypes in 'dir' (implies -c)"},
 216   {"-c",    SPEC, 0, do_code,     "-c              Generate skeleton code (requires -I)"},
 217   {"-t",    SPEC, 0, do_trace,    "-t              TRACE arguments (implies -c)"},
 218   {"-f",    SPEC, 1, do_forward,  "-f <dll>        Forward calls to 'dll' (implies -t)"},
 219   {"-D",    SPEC, 0, do_document, "-D              Generate documentation"},
 220   {"-o",    SPEC, 1, do_name,     "-o <name>       Set the output dll name (default: dll). Note: strips .dll extensions"},
 221   {"-C",    SPEC, 0, do_cdecl,    "-C              Assume __cdecl calls (default: __stdcall)"},
 222   {"-s",    SPEC, 1, do_start,    "-s <num>        Start prototype search after symbol 'num'"},
 223   {"-e",    SPEC, 1, do_end,      "-e <num>        End prototype search after symbol 'num'"},
 224   {"-S",    SPEC, 1, do_symfile,  "-S <symfile>    Search only prototype names found in 'symfile'"},
 225   {"-q",    SPEC, 0, do_quiet,    "-q              Don't show progress (quiet)."},
 226   {"-v",    SPEC, 0, do_verbose,  "-v              Show lots of detail while working (verbose)."},
 227   {NULL,    NONE, 0, NULL,        NULL}
 228 };
 229
 230 void do_usage (const char *arg)
 231 {
 232     const struct my_option *opt;
 233     printf ("Usage: winedump [-h | sym <sym> | spec <dll> | dump <file>]\n");
 234     printf ("Mode options (can be put as the mode (sym/spec/dump...) is declared):\n");
 235     printf ("\tWhen used in --help mode\n");
 236     for (opt = option_table; opt->name; opt++)
 237         if (opt->mode == NONE)
 238             printf ("\t   %s\n", opt->usage);
 239     printf ("\tWhen used in sym mode\n");
 240     for (opt = option_table; opt->name; opt++)
 241         if (opt->mode == DMGL)
 242             printf ("\t   %s\n", opt->usage);
 243     printf ("\tWhen used in spec mode\n");
 244     for (opt = option_table; opt->name; opt++)
 245         if (opt->mode == SPEC)
 246             printf ("\t   %s\n", opt->usage);
 247     printf ("\tWhen used in dump mode\n");
 248     for (opt = option_table; opt->name; opt++)
 249         if (opt->mode == DUMP)
 250             printf ("\t   %s\n", opt->usage);
 251
 252     puts ("");
 253     exit (1);
 254 }
 255
 256
 257 /*******************************************************************
 258  *          parse_cmdline
 259  *
 260  * Parse options from the argv array
 261  */
 262 static void parse_cmdline (char *argv[])
 263 {
 264   const struct my_option *opt;
 265   char *const *ptr;
 266   const char *arg = NULL;
 267
 268   ptr = argv + 1;
 269
 270   while (*ptr != NULL)
 271   {
 272     for (opt = option_table; opt->name; opt++)
 273     {
 274      if (globals.mode != NONE && opt->mode != NONE && globals.mode != opt->mode)
 275        continue;
 276      if (((opt->has_arg == 1) && !strncmp (*ptr, opt->name, strlen (opt->name))) ||
 277          ((opt->has_arg == 2) && !strcmp (*ptr, opt->name)))
 278       {
 279         arg = *ptr + strlen (opt->name);
 280         if (*arg == '\0') arg = *++ptr;
 281         break;
 282       }
 283       if (!strcmp (*ptr, opt->name))
 284       {
 285         arg = NULL;
 286         break;
 287       }
 288     }
 289
 290     if (!opt->name)
 291     {
 292         if ((*ptr)[0] == '-')
 293             fatal ("Unrecognized option");
 294         if (globals.input_name != NULL)
 295             fatal ("Only one file can be treated at once");
 296         globals.input_name = *ptr;
 297     }
 298     else if (opt->has_arg && arg != NULL)
 299         opt->func (arg);
 300     else
 301         opt->func ("");
 302
 303     ptr++;
 304   }
 305
 306   if (globals.mode == SPEC && globals.do_code && !globals.directory)
 307     fatal ("-I must be used if generating code");
 308
 309   if (VERBOSE && QUIET)
 310     fatal ("Options -v and -q are mutually exclusive");
 311
 312   if (globals.mode == NONE)
 313       do_dump("");
 314 }
 315
 316 static void set_module_name(BOOL setUC)
 317 {
 318     /* FIXME: we shouldn't assume all module extensions are .dll in winedump
 319      * in some cases, we could have some .drv for example
 320      */
 321     globals.input_module = replace_extension( get_basename( globals.input_name ), ".dll", "" );
 322     OUTPUT_UC_DLL_NAME = (setUC) ? str_toupper( xstrdup (OUTPUT_DLL_NAME)) : "";
 323 }
 324
 325 /* Marks the symbol as 'found'! */
 326 /* return: perform-search */
 327 static BOOL symbol_searched(int count, const char *symbolname)
 328 {
 329     search_symbol *search_symbol;
 330
 331     if (!(count >= globals.start_ordinal
 332           && (!globals.end_ordinal || count <= globals.end_ordinal)))
 333         return FALSE;
 334     if (!globals.search_symbol)
 335         return TRUE;
 336     for (search_symbol = globals.search_symbol;
 337          search_symbol;
 338          search_symbol = search_symbol->next)
 339     {
 340         if (!strcmp(symbolname, search_symbol->symbolname))
 341         {
 342             search_symbol->found = TRUE;
 343             return TRUE;
 344         }
 345     }
 346     return FALSE;
 347 }
 348
 349 /* return: some symbols weren't found */
 350 static BOOL symbol_finish(void)
 351 {
 352     const search_symbol *search_symbol;
 353     BOOL started = FALSE;
 354
 355     for (search_symbol = globals.search_symbol;
 356          search_symbol;
 357          search_symbol = search_symbol->next)
 358     {
 359         if (search_symbol->found)
 360             continue;
 361         if (!started)
 362         {
 363             /* stderr? not a practice here */
 364             puts("These requested <symfile> symbols weren't found:");
 365             started = TRUE;
 366         }
 367         printf("\t%s\n",search_symbol->symbolname);
 368     }
 369     return started;
 370 }
 371
 372 /*******************************************************************
 373  *         main
 374  */
 375 #ifdef __GNUC__
 376 int   main (int argc __attribute__((unused)), char *argv[])
 377 #else
 378 int   main (int argc, char *argv[])
 379 #endif
 380 {
 381     parsed_symbol symbol;
 382     int count = 0;
 383
 384     globals.mode = NONE;
 385     globals.forward_dll = NULL;
 386     globals.input_name = NULL;
 387     globals.dumpsect = NULL;
 388
 389     parse_cmdline (argv);
 390
 391     memset (&symbol, 0, sizeof (parsed_symbol));
 392
 393     switch (globals.mode)
 394     {
 395     case DMGL:
 396         VERBOSE = TRUE;
 397
 398         if (globals.input_name == NULL)
 399             fatal("No symbol name has been given\n");
 400         printf("%s\n", get_symbol_str(globals.input_name));
 401         break;
 402
 403     case SPEC:
 404         if (globals.input_name == NULL)
 405             fatal("No file name has been given\n");
 406         set_module_name(TRUE);
 407         if (!dll_open (globals.input_name))
 408             break;
 409
 410         output_spec_preamble ();
 411         output_header_preamble ();
 412         output_c_preamble ();
 413
 414         while (dll_next_symbol (&symbol))
 415         {
 416             count++;
 417
 418             if (NORMAL)
 419                 printf ("Export %3d - '%s' ...%c", count, symbol.symbol,
 420                         VERBOSE ? '\n' : ' ');
 421
 422             if (globals.do_code && symbol_searched(count, symbol.symbol))
 423             {
 424                 /* Attempt to get information about the symbol */
 425                 BOOL result = symbol_demangle (&symbol) || symbol_search(&symbol);
 426
 427                 if (result && symbol.function_name)
 428                     /* Clean up the prototype */
 429                     symbol_clean_string (symbol.function_name);
 430
 431                 if (NORMAL)
 432                     puts (result ? "[OK]" : "[Not Found]");
 433             }
 434             else if (NORMAL)
 435                 puts ("[Ignoring]");
 436
 437             output_spec_symbol (&symbol);
 438             output_header_symbol (&symbol);
 439             output_c_symbol (&symbol);
 440
 441             symbol_clear (&symbol);
 442         }
 443
 444         output_makefile ();
 445
 446         if (VERBOSE)
 447             puts ("Finished, Cleaning up...");
 448         if (symbol_finish())
 449             return 1;
 450         break;
 451     case NONE:
 452         do_usage(0);
 453         break;
 454     case DUMP:
 455         if (globals.input_name == NULL)
 456             fatal("No file name has been given\n");
 457         set_module_name(FALSE);
 458         dump_file(globals.input_name);
 459         break;
 460     }
 461
 462     return 0;
 463 }