gdb/windows-tdep.c

   1 /* Copyright (C) 2008, 2009, 2010 Free Software Foundation, Inc.
   2
   3    This file is part of GDB.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 #include "defs.h"
  19 #include "windows-tdep.h"
  20 #include "gdb_obstack.h"
  21 #include "xml-support.h"
  22 #include "gdbarch.h"
  23 #include "target.h"
  24 #include "value.h"
  25 #include "inferior.h"
  26 #include "command.h"
  27 #include "gdbcmd.h"
  28 #include "gdbthread.h"
  29
  30 struct cmd_list_element *info_w32_cmdlist;
  31
  32 typedef struct thread_information_block_32
  33   {
  34     uint32_t current_seh;                       /* %fs:0x0000 */
  35     uint32_t current_top_of_stack;              /* %fs:0x0004 */
  36     uint32_t current_bottom_of_stack;           /* %fs:0x0008 */
  37     uint32_t sub_system_tib;                    /* %fs:0x000c */
  38     uint32_t fiber_data;                        /* %fs:0x0010 */
  39     uint32_t arbitrary_data_slot;               /* %fs:0x0014 */
  40     uint32_t linear_address_tib;                /* %fs:0x0018 */
  41     uint32_t environment_pointer;               /* %fs:0x001c */
  42     uint32_t process_id;                        /* %fs:0x0020 */
  43     uint32_t current_thread_id;                 /* %fs:0x0024 */
  44     uint32_t active_rpc_handle;                 /* %fs:0x0028 */
  45     uint32_t thread_local_storage;              /* %fs:0x002c */
  46     uint32_t process_environment_block;         /* %fs:0x0030 */
  47     uint32_t last_error_number;                 /* %fs:0x0034 */
  48   }
  49 thread_information_32;
  50
  51 typedef struct thread_information_block_64
  52   {
  53     uint64_t current_seh;                       /* %gs:0x0000 */
  54     uint64_t current_top_of_stack;              /* %gs:0x0008 */
  55     uint64_t current_bottom_of_stack;           /* %gs:0x0010 */
  56     uint64_t sub_system_tib;                    /* %gs:0x0018 */
  57     uint64_t fiber_data;                        /* %gs:0x0020 */
  58     uint64_t arbitrary_data_slot;               /* %gs:0x0028 */
  59     uint64_t linear_address_tib;                /* %gs:0x0030 */
  60     uint64_t environment_pointer;               /* %gs:0x0038 */
  61     uint64_t process_id;                        /* %gs:0x0040 */
  62     uint64_t current_thread_id;                 /* %gs:0x0048 */
  63     uint64_t active_rpc_handle;                 /* %gs:0x0050 */
  64     uint64_t thread_local_storage;              /* %gs:0x0058 */
  65     uint64_t process_environment_block;         /* %gs:0x0060 */
  66     uint64_t last_error_number;                 /* %gs:0x0068 */
  67   }
  68 thread_information_64;
  69
  70
  71 static const char* TIB_NAME[] =
  72   {
  73     " current_seh                 ",    /* %fs:0x0000 */
  74     " current_top_of_stack        ",    /* %fs:0x0004 */
  75     " current_bottom_of_stack     ",    /* %fs:0x0008 */
  76     " sub_system_tib              ",    /* %fs:0x000c */
  77     " fiber_data                  ",    /* %fs:0x0010 */
  78     " arbitrary_data_slot         ",    /* %fs:0x0014 */
  79     " linear_address_tib          ",    /* %fs:0x0018 */
  80     " environment_pointer         ",    /* %fs:0x001c */
  81     " process_id                  ",    /* %fs:0x0020 */
  82     " current_thread_id           ",    /* %fs:0x0024 */
  83     " active_rpc_handle           ",    /* %fs:0x0028 */
  84     " thread_local_storage        ",    /* %fs:0x002c */
  85     " process_environment_block   ",    /* %fs:0x0030 */
  86     " last_error_number           "     /* %fs:0x0034 */
  87   };
  88
  89 static const int MAX_TIB32 = sizeof (thread_information_32) / sizeof (uint32_t);
  90 static const int MAX_TIB64 = sizeof (thread_information_64) / sizeof (uint64_t);
  91 static const int FULL_TIB_SIZE = 0x1000;
  92
  93 static int maint_display_all_tib = 0;
  94
  95 /* Define Thread Local Base pointer type.  */
  96
  97 static struct type *
  98 windows_get_tlb_type (struct gdbarch *gdbarch)
  99 {
 100   struct type *dword_ptr_type, *dword32_type, *void_ptr_type;
 101   struct type *peb_ldr_type, *peb_ldr_ptr_type;
 102   struct type *peb_type, *peb_ptr_type, *list_type, *list_ptr_type;
 103   struct type *module_list_ptr_type;
 104   struct type *tib_type, *seh_type, *tib_ptr_type, *seh_ptr_type;
 105
 106   dword_ptr_type = arch_integer_type (gdbarch, gdbarch_ptr_bit (gdbarch),
 107                                  1, "DWORD_PTR");
 108   dword32_type = arch_integer_type (gdbarch, 32,
 109                                  1, "DWORD32");
 110   void_ptr_type = lookup_pointer_type (builtin_type (gdbarch)->builtin_void);
 111
 112   /* list entry */
 113
 114   list_type = arch_composite_type (gdbarch, NULL, TYPE_CODE_STRUCT);
 115   TYPE_NAME (list_type) = xstrdup ("list");
 116
 117   list_ptr_type = arch_type (gdbarch, TYPE_CODE_PTR,
 118                             TYPE_LENGTH (void_ptr_type), NULL);
 119
 120   module_list_ptr_type = void_ptr_type;
 121
 122   append_composite_type_field (list_type, "forward_list", module_list_ptr_type);
 123   append_composite_type_field (list_type, "backward_list",
 124                                module_list_ptr_type);
 125
 126   /* Structured Exception Handler */
 127
 128   seh_type = arch_composite_type (gdbarch, NULL, TYPE_CODE_STRUCT);
 129   TYPE_NAME (seh_type) = xstrdup ("seh");
 130
 131   seh_ptr_type = arch_type (gdbarch, TYPE_CODE_PTR,
 132                             TYPE_LENGTH (void_ptr_type), NULL);
 133   TYPE_TARGET_TYPE (seh_ptr_type) = seh_type;
 134
 135   append_composite_type_field (seh_type, "next_seh", seh_ptr_type);
 136   append_composite_type_field (seh_type, "handler",
 137                                builtin_type (gdbarch)->builtin_func_ptr);
 138
 139   /* struct _PEB_LDR_DATA */
 140   peb_ldr_type = arch_composite_type (gdbarch, NULL, TYPE_CODE_STRUCT);
 141   TYPE_NAME (peb_ldr_type) = xstrdup ("peb_ldr_data");
 142
 143   append_composite_type_field (peb_ldr_type, "length", dword32_type);
 144   append_composite_type_field (peb_ldr_type, "initialized", dword32_type);
 145   append_composite_type_field (peb_ldr_type, "ss_handle", void_ptr_type);
 146   append_composite_type_field (peb_ldr_type, "in_load_order", list_type);
 147   append_composite_type_field (peb_ldr_type, "in_memory_order", list_type);
 148   append_composite_type_field (peb_ldr_type, "in_init_order", list_type);
 149   append_composite_type_field (peb_ldr_type, "entry_in_progress",
 150                                void_ptr_type);
 151   peb_ldr_ptr_type = arch_type (gdbarch, TYPE_CODE_PTR,
 152                             TYPE_LENGTH (void_ptr_type), NULL);
 153   TYPE_TARGET_TYPE (peb_ldr_ptr_type) = peb_ldr_type;
 154
 155
 156   /* struct process environment block */
 157   peb_type = arch_composite_type (gdbarch, NULL, TYPE_CODE_STRUCT);
 158   TYPE_NAME (peb_type) = xstrdup ("peb");
 159
 160   /* First bytes contain several flags.  */
 161   append_composite_type_field (peb_type, "flags", dword_ptr_type);
 162   append_composite_type_field (peb_type, "mutant", void_ptr_type);
 163   append_composite_type_field (peb_type, "image_base_address", void_ptr_type);
 164   append_composite_type_field (peb_type, "ldr", peb_ldr_ptr_type);
 165   append_composite_type_field (peb_type, "process_parameters", void_ptr_type);
 166   append_composite_type_field (peb_type, "sub_system_data", void_ptr_type);
 167   append_composite_type_field (peb_type, "process_heap", void_ptr_type);
 168   append_composite_type_field (peb_type, "fast_peb_lock", void_ptr_type);
 169   peb_ptr_type = arch_type (gdbarch, TYPE_CODE_PTR,
 170                             TYPE_LENGTH (void_ptr_type), NULL);
 171   TYPE_TARGET_TYPE (peb_ptr_type) = peb_type;
 172
 173
 174   /* struct thread information block */
 175   tib_type = arch_composite_type (gdbarch, NULL, TYPE_CODE_STRUCT);
 176   TYPE_NAME (tib_type) = xstrdup ("tib");
 177
 178   /* uint32_t current_seh;                      %fs:0x0000 */
 179   append_composite_type_field (tib_type, "current_seh", seh_ptr_type);
 180   /* uint32_t current_top_of_stack;             %fs:0x0004 */
 181   append_composite_type_field (tib_type, "current_top_of_stack", void_ptr_type);
 182   /* uint32_t current_bottom_of_stack;          %fs:0x0008 */
 183   append_composite_type_field (tib_type, "current_bottom_of_stack",
 184                                void_ptr_type);
 185   /* uint32_t sub_system_tib;                   %fs:0x000c */
 186   append_composite_type_field (tib_type, "sub_system_tib", void_ptr_type);
 187
 188   /* uint32_t fiber_data;                       %fs:0x0010 */
 189   append_composite_type_field (tib_type, "fiber_data", void_ptr_type);
 190   /* uint32_t arbitrary_data_slot;              %fs:0x0014 */
 191   append_composite_type_field (tib_type, "arbitrary_data_slot", void_ptr_type);
 192   /* uint32_t linear_address_tib;               %fs:0x0018 */
 193   append_composite_type_field (tib_type, "linear_address_tib", void_ptr_type);
 194   /* uint32_t environment_pointer;              %fs:0x001c */
 195   append_composite_type_field (tib_type, "environment_pointer", void_ptr_type);
 196   /* uint32_t process_id;                       %fs:0x0020 */
 197   append_composite_type_field (tib_type, "process_id", dword_ptr_type);
 198   /* uint32_t current_thread_id;                %fs:0x0024 */
 199   append_composite_type_field (tib_type, "thread_id", dword_ptr_type);
 200   /* uint32_t active_rpc_handle;                %fs:0x0028 */
 201   append_composite_type_field (tib_type, "active_rpc_handle", dword_ptr_type);
 202   /* uint32_t thread_local_storage;             %fs:0x002c */
 203   append_composite_type_field (tib_type, "thread_local_storage", void_ptr_type);
 204   /* uint32_t process_environment_block;        %fs:0x0030 */
 205   append_composite_type_field (tib_type, "process_environment_block",
 206                                peb_ptr_type);
 207   /* uint32_t last_error_number;                %fs:0x0034 */
 208   append_composite_type_field (tib_type, "last_error_number", dword_ptr_type);
 209
 210   tib_ptr_type = arch_type (gdbarch, TYPE_CODE_PTR,
 211                             TYPE_LENGTH (void_ptr_type), NULL);
 212   TYPE_TARGET_TYPE (tib_ptr_type) = tib_type;
 213
 214   return tib_ptr_type;
 215 }
 216
 217 /* The $_tlb convenience variable is a bit special.  We don't know
 218    for sure the type of the value until we actually have a chance to
 219    fetch the data.  The type can change depending on gdbarch, so it is
 220    also dependent on which thread you have selected.  */
 221
 222 /* This function implements the lval_computed support for reading a
 223    $_tlb value.  */
 224
 225 static void
 226 tlb_value_read (struct value *val)
 227 {
 228   CORE_ADDR tlb;
 229   struct type *type = check_typedef (value_type (val));
 230
 231   if (!target_get_tib_address (inferior_ptid, &tlb))
 232     error (_("Unable to read tlb"));
 233   store_typed_address (value_contents_raw (val), type, tlb);
 234 }
 235
 236 /* This function implements the lval_computed support for writing a
 237    $_tlb value.  */
 238
 239 static void
 240 tlb_value_write (struct value *v, struct value *fromval)
 241 {
 242   error (_("Impossible to change the Thread Local Base"));
 243 }
 244
 245 static struct lval_funcs tlb_value_funcs =
 246   {
 247     tlb_value_read,
 248     tlb_value_write
 249   };
 250
 251
 252 /* Return a new value with the correct type for the tlb object of
 253    the current thread using architecture GDBARCH.  Return a void value
 254    if there's no object available.  */
 255
 256 static struct value *
 257 tlb_make_value (struct gdbarch *gdbarch, struct internalvar *var)
 258 {
 259   if (target_has_stack && !ptid_equal (inferior_ptid, null_ptid))
 260     {
 261       struct type *type = windows_get_tlb_type (gdbarch);
 262       return allocate_computed_value (type, &tlb_value_funcs, NULL);
 263     }
 264
 265   return allocate_value (builtin_type (gdbarch)->builtin_void);
 266 }
 267
 268
 269 /* Display thread information block of a given thread.  */
 270
 271 static int
 272 display_one_tib (ptid_t ptid)
 273 {
 274   gdb_byte *tib = NULL;
 275   gdb_byte *index;
 276   CORE_ADDR thread_local_base;
 277   ULONGEST i, val, max, max_name, size, tib_size;
 278   ULONGEST sizeof_ptr = gdbarch_ptr_bit (target_gdbarch);
 279   enum bfd_endian byte_order = gdbarch_byte_order (target_gdbarch);
 280
 281   if (sizeof_ptr == 64)
 282     {
 283       size = sizeof (uint64_t);
 284       tib_size = sizeof (thread_information_64);
 285       max = MAX_TIB64;
 286     }
 287   else
 288     {
 289       size = sizeof (uint32_t);
 290       tib_size = sizeof (thread_information_32);
 291       max = MAX_TIB32;
 292     }
 293
 294   max_name = max;
 295
 296   if (maint_display_all_tib)
 297     {
 298       tib_size = FULL_TIB_SIZE;
 299       max = tib_size / size;
 300     }
 301
 302   tib = alloca (tib_size);
 303
 304   if (target_get_tib_address (ptid, &thread_local_base) == 0)
 305     {
 306       printf_filtered (_("Unable to get thread local base for %s\n"),
 307         target_pid_to_str (ptid));
 308       return -1;
 309     }
 310
 311   if (target_read (&current_target, TARGET_OBJECT_MEMORY,
 312                    NULL, tib, thread_local_base, tib_size) != tib_size)
 313     {
 314       printf_filtered (_("Unable to read thread information block for %s at \
 315 address %s\n"),
 316         target_pid_to_str (ptid),
 317         paddress (target_gdbarch, thread_local_base));
 318       return -1;
 319     }
 320
 321   printf_filtered (_("Thread Information Block %s at %s\n"),
 322                    target_pid_to_str (ptid),
 323                    paddress (target_gdbarch, thread_local_base));
 324
 325   index = (gdb_byte *) tib;
 326
 327   /* All fields have the size of a pointer, this allows to iterate
 328      using the same for loop for both layouts.  */
 329   for (i = 0; i < max; i++)
 330     {
 331       val = extract_unsigned_integer (index, size, byte_order);
 332       if (i < max_name)
 333         printf_filtered (_("%s is 0x%s\n"), TIB_NAME[i], phex (val, size));
 334       else if (val != 0)
 335         printf_filtered (_("TIB[0x%s] is 0x%s\n"), phex (i * size, 2),
 336                          phex (val, size));
 337       index += size;
 338     }
 339   return 1;
 340 }
 341
 342 /* Display thread information block of a thread specified by ARGS.
 343    If ARGS is empty, display thread information block of current_thread
 344    if current_thread is non NULL.
 345    Otherwise ARGS is parsed and converted to a integer that should
 346    be the windows ThreadID (not the internal GDB thread ID).  */
 347
 348 static void
 349 display_tib (char * args, int from_tty)
 350 {
 351   if (args)
 352     {
 353       struct thread_info *tp;
 354       int gdb_id = value_as_long (parse_and_eval (args));
 355
 356       tp = find_thread_id (gdb_id);
 357
 358       if (!tp)
 359         error (_("Thread ID %d not known."), gdb_id);
 360
 361       if (!target_thread_alive (tp->ptid))
 362         error (_("Thread ID %d has terminated."), gdb_id);
 363
 364       display_one_tib (tp->ptid);
 365     }
 366   else if (!ptid_equal (inferior_ptid, null_ptid))
 367     display_one_tib (inferior_ptid);
 368 }
 369
 370 void
 371 windows_xfer_shared_library (const char* so_name, CORE_ADDR load_addr,
 372                              struct gdbarch *gdbarch, struct obstack *obstack)
 373 {
 374   char *p;
 375   obstack_grow_str (obstack, "<library name=\"");
 376   p = xml_escape_text (so_name);
 377   obstack_grow_str (obstack, p);
 378   xfree (p);
 379   obstack_grow_str (obstack, "\"><segment address=\"");
 380   /* The symbols in a dll are offset by 0x1000, which is the the
 381      offset from 0 of the first byte in an image - because of the file
 382      header and the section alignment. */
 383   obstack_grow_str (obstack, paddress (gdbarch, load_addr + 0x1000));
 384   obstack_grow_str (obstack, "\"/></library>");
 385 }
 386
 387 static void
 388 show_maint_show_all_tib (struct ui_file *file, int from_tty,
 389                 struct cmd_list_element *c, const char *value)
 390 {
 391   fprintf_filtered (file, _("Show all non-zero elements of Thread Information \
 392 Block is %s.\n"), value);
 393 }
 394
 395 static void
 396 info_w32_command (char *args, int from_tty)
 397 {
 398   help_list (info_w32_cmdlist, "info w32 ", class_info, gdb_stdout);
 399 }
 400
 401 static int w32_prefix_command_valid = 0;
 402 void
 403 init_w32_command_list (void)
 404 {
 405   if (!w32_prefix_command_valid)
 406     {
 407       add_prefix_cmd ("w32", class_info, info_w32_command,
 408                       _("Print information specific to Win32 debugging."),
 409                       &info_w32_cmdlist, "info w32 ", 0, &infolist);
 410       w32_prefix_command_valid = 1;
 411     }
 412 }
 413
 414 void
 415 _initialize_windows_tdep (void)
 416 {
 417   init_w32_command_list ();
 418   add_cmd ("thread-information-block", class_info, display_tib,
 419            _("Display thread information block."),
 420            &info_w32_cmdlist);
 421   add_alias_cmd ("tib", "thread-information-block", class_info, 1,
 422                  &info_w32_cmdlist);
 423
 424   add_setshow_boolean_cmd ("show-all-tib", class_maintenance,
 425                            &maint_display_all_tib, _("\
 426 Set whether to display all non-zero fields of thread information block."), _("\
 427 Show whether to display all non-zero fields of thread information block."), _("\
 428 Use \"on\" to enable, \"off\" to disable.\n\
 429 If enabled, all non-zero fields of thread information block are displayed,\n\
 430 even if their meaning is unknown."),
 431                            NULL,
 432                            show_maint_show_all_tib,
 433                            &maintenance_set_cmdlist,
 434                            &maintenance_show_cmdlist);
 435
 436   /* Explicitly create without lookup, since that tries to create a
 437      value with a void typed value, and when we get here, gdbarch
 438      isn't initialized yet.  At this point, we're quite sure there
 439      isn't another convenience variable of the same name.  */
 440   create_internalvar_type_lazy ("_tlb", tlb_make_value);
 441 }