2003-08-22 Roland McGrath <roland@redhat.com>
[kopensolaris-gnu/glibc.git] / nptl_db / thread_dbP.h
index 4407143..4546d24 100644 (file)
@@ -1,30 +1,54 @@
-/* Private header for thread debug library.  */
+/* Private header for thread debug library
+   Copyright (C) 2003 Free Software Foundation, Inc.
+   This file is part of the GNU C Library.
+
+   The GNU C Library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
+
+   The GNU C Library 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.  See the GNU
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, write to the Free
+   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+   02111-1307 USA.  */
+
 #ifndef _THREAD_DBP_H
 #define _THREAD_DBP_H  1
 
 #include <stdbool.h>
+#include <stdint.h>
 #include <string.h>
+#include <stdlib.h>
 #include <unistd.h>
+#include <assert.h>
 #include "proc_service.h"
 #include "thread_db.h"
-#include "../nptl/pthreadP.h"
-#include <list.h>
-
+#include "../nptl/pthreadP.h"          /* This is for *_BITMASK only.  */
 
 /* Indeces for the symbol names.  */
 enum
   {
-    SYM_PTHREAD_THREADS_EVENTS = 0,
-    SYM_PTHREAD_LAST_EVENT,
-    SYM_PTHREAD_NTHREADS,
-    SYM_PTHREAD_STACK_USED,
-    SYM_PTHREAD_STACK_USER,
-    SYM_PTHREAD_KEYS,
-    SYM_PTHREAD_KEYS_MAX,
-    SYM_PTHREAD_SIZEOF_DESCR,
-    SYM_PTHREAD_CREATE_EVENT,
-    SYM_PTHREAD_DEATH_EVENT,
-    SYM_PTHREAD_VERSION,
+# define DB_STRUCT(type)               SYM_SIZEOF_##type,
+# define DB_STRUCT_FIELD(type, field)  SYM_##type##_FIELD_##field,
+# define DB_SYMBOL(name)               SYM_##name,
+# define DB_VARIABLE(name)             SYM_##name, SYM_DESC_##name,
+# include "structs.def"
+# undef DB_STRUCT
+# undef DB_STRUCT_FIELD
+# undef DB_SYMBOL
+# undef DB_VARIABLE
+
+    SYM_TH_UNIQUE_CONST_THREAD_AREA,
+    SYM_TH_UNIQUE_REGISTER64,
+    SYM_TH_UNIQUE_REGISTER32,
+    SYM_TH_UNIQUE_REGISTER64_THREAD_AREA,
+    SYM_TH_UNIQUE_REGISTER32_THREAD_AREA,
+
     SYM_NUM_MESSAGES
   };
 
@@ -32,50 +56,68 @@ enum
 /* Comment out the following for less verbose output.  */
 #ifndef NDEBUG
 # define LOG(c) if (__td_debug) __libc_write (2, c "\n", strlen (c "\n"))
-extern int __td_debug;
+extern int __td_debug attribute_hidden;
 #else
 # define LOG(c)
 #endif
 
 
+#define DB_DESC_SIZE(desc)     ((desc)[0])
+#define DB_DESC_NELEM(desc)    ((desc)[1])
+#define DB_DESC_OFFSET(desc)   ((int32_t) (desc)[2])
+#define DB_SIZEOF_DESC         (3 * sizeof (uint32_t))
+#define DB_DEFINE_DESC(name, size, nelem, offset) \
+  const uint32_t name[3] = { (size), (nelem), (offset) }
+typedef uint32_t db_desc_t[3];
+
+
 /* Handle for a process.  This type is opaque.  */
 struct td_thragent
 {
+  /* Chain on the list of all agent structures.  */
+  list_t list;
+
   /* Delivered by the debugger and we have to pass it back in the
      proc callbacks.  */
   struct ps_prochandle *ph;
 
-  /* Some cached information.  */
-
-  /* Lists of running threads.  */
-  psaddr_t stack_used;
-  psaddr_t stack_user;
-
-  /* Address of the `pthread_keys' array.  */
-  struct pthread_key_struct *keys;
-
-  /* Maximum number of thread-local data keys.  */
-  int pthread_keys_max;
-
-  /* Size of 2nd level array for thread-local data keys.  */
-  int pthread_key_2ndlevel_size;
-
-  /* Sizeof struct _pthread_descr_struct.  */
-  int sizeof_descr;
-
-  /* Pointer to the `__pthread_threads_events' variable in the target.  */
-  psaddr_t pthread_threads_eventsp;
-
-  /* Pointer to the `__pthread_last_event' variable in the target.  */
-  psaddr_t pthread_last_event;
-
-  /* List head the queue agent structures.  */
-  list_t list;
+  /* Cached values read from the inferior.  */
+# define DB_STRUCT(type) \
+  uint32_t ta_sizeof_##type;
+# define DB_STRUCT_FIELD(type, field) \
+  db_desc_t ta_field_##type##_##field;
+# define DB_SYMBOL(name) \
+  psaddr_t ta_addr_##name;
+# define DB_VARIABLE(name) \
+  psaddr_t ta_addr_##name; \
+  db_desc_t ta_var_##name;
+# include "structs.def"
+# undef DB_STRUCT
+# undef DB_STRUCT_FIELD
+# undef DB_SYMBOL
+# undef DB_VARIABLE
+
+  /* The method of locating a thread's th_unique value.  */
+  enum
+    {
+      ta_howto_unknown,
+      ta_howto_reg,
+      ta_howto_reg_thread_area,
+      ta_howto_const_thread_area
+    } ta_howto;
+  union
+  {
+    uint32_t const_thread_area;        /* Constant argument to ps_get_thread_area.  */
+    /* These are as if the descriptor of the field in prregset_t,
+       but DB_DESC_NELEM is overloaded as follows: */
+    db_desc_t reg;             /* Signed bias applied to register value.  */
+    db_desc_t reg_thread_area; /* Bits to scale down register value.  */
+  } ta_howto_data;
 };
 
 
 /* List of all known descriptors.  */
-extern list_t __td_agent_list;
+extern list_t __td_agent_list attribute_hidden;
 
 
 /* Function used to test for correct thread agent pointer.  */
@@ -93,6 +135,115 @@ ta_ok (const td_thragent_t *ta)
 
 
 /* Internal wrapper around ps_pglobal_lookup.  */
-extern int td_lookup (struct ps_prochandle *ps, int idx, psaddr_t *sym_addr);
+extern ps_err_e td_lookup (struct ps_prochandle *ps,
+                          int idx, psaddr_t *sym_addr) attribute_hidden;
+
+
+
+
+/* Store in psaddr_t VAR the address of inferior's symbol NAME.  */
+#define DB_GET_SYMBOL(var, ta, name)                                         \
+  (((ta)->ta_addr_##name == 0                                                \
+    && td_lookup ((ta)->ph, SYM_##name, &(ta)->ta_addr_##name) != PS_OK)      \
+   ? TD_ERR : ((var) = (ta)->ta_addr_##name, TD_OK))
+
+/* Store in psaddr_t VAR the value of ((TYPE) PTR)->FIELD[IDX] in the inferior.
+   A target field smaller than psaddr_t is zero-extended.  */
+#define DB_GET_FIELD(var, ta, ptr, type, field, idx) \
+  _td_fetch_value ((ta), (ta)->ta_field_##type##_##field, \
+                  SYM_##type##_FIELD_##field, \
+                  (psaddr_t) 0 + (idx), (ptr), &(var))
+
+#define DB_GET_FIELD_ADDRESS(var, ta, ptr, type, field, idx) \
+  ((var) = (ptr), _td_locate_field ((ta), (ta)->ta_field_##type##_##field, \
+                                   SYM_##type##_FIELD_##field, \
+                                   (psaddr_t) 0 + (idx), &(var)))
+
+extern td_err_e _td_locate_field (td_thragent_t *ta,
+                                 db_desc_t desc, int descriptor_name,
+                                 psaddr_t idx,
+                                 psaddr_t *address) attribute_hidden;
+
+
+/* Like DB_GET_FIELD, but PTR is a local pointer to a structure that
+   has already been copied in from the inferior.  */
+#define DB_GET_FIELD_LOCAL(var, ta, ptr, type, field, idx) \
+  _td_fetch_value_local ((ta), (ta)->ta_field_##type##_##field, \
+                        SYM_##type##_FIELD_##field, \
+                        (psaddr_t) 0 + (idx), (ptr), &(var))
+
+/* Store in psaddr_t VAR the value of variable NAME[IDX] in the inferior.
+   A target value smaller than psaddr_t is zero-extended.  */
+#define DB_GET_VALUE(var, ta, name, idx)                                     \
+  (((ta)->ta_addr_##name == 0                                                \
+    && td_lookup ((ta)->ph, SYM_##name, &(ta)->ta_addr_##name) != PS_OK)      \
+   ? TD_ERR                                                                  \
+   : _td_fetch_value ((ta), (ta)->ta_var_##name, SYM_DESC_##name,            \
+                     (psaddr_t) 0 + (idx), (ta)->ta_addr_##name, &(var)))
+
+/* Helper functions for those.  */
+extern td_err_e _td_fetch_value (td_thragent_t *ta,
+                                db_desc_t field, int descriptor_name,
+                                psaddr_t idx, psaddr_t address,
+                                psaddr_t *result) attribute_hidden;
+extern td_err_e _td_fetch_value_local (td_thragent_t *ta,
+                                      db_desc_t field,
+                                      int descriptor_name,
+                                      psaddr_t idx, void *address,
+                                      psaddr_t *result) attribute_hidden;
+
+/* Store psaddr_t VALUE in ((TYPE) PTR)->FIELD[IDX] in the inferior.
+   A target field smaller than psaddr_t is zero-extended.  */
+#define DB_PUT_FIELD(ta, ptr, type, field, idx, value) \
+  _td_store_value ((ta), (ta)->ta_field_##type##_##field, \
+                  SYM_##type##_FIELD_##field, \
+                  (psaddr_t) 0 + (idx), (ptr), (value))
+
+#define DB_PUT_FIELD_LOCAL(ta, ptr, type, field, idx, value) \
+  _td_store_value_local ((ta), (ta)->ta_field_##type##_##field, \
+                        SYM_##type##_FIELD_##field, \
+                        (psaddr_t) 0 + (idx), (ptr), (value))
+
+/* Store psaddr_t VALUE in variable NAME[IDX] in the inferior.
+   A target field smaller than psaddr_t is zero-extended.  */
+#define DB_PUT_VALUE(ta, name, idx, value)                                   \
+  (((ta)->ta_addr_##name == 0                                                \
+    && td_lookup ((ta)->ph, SYM_##name, &(ta)->ta_addr_##name) != PS_OK)      \
+   ? TD_ERR                                                                  \
+   : _td_store_value ((ta), (ta)->ta_var_##name, SYM_DESC_##name,            \
+                     (psaddr_t) 0 + (idx), (ta)->ta_addr_##name, (value)))
+
+/* Helper functions for those.  */
+extern td_err_e _td_store_value (td_thragent_t *ta,
+                                db_desc_t field, int descriptor_name,
+                                psaddr_t idx, psaddr_t address,
+                                psaddr_t value) attribute_hidden;
+extern td_err_e _td_store_value_local (td_thragent_t *ta,
+                                      db_desc_t field, int descriptor_name,
+                                      psaddr_t idx, void *address,
+                                      psaddr_t value) attribute_hidden;
+
+#define DB_GET_STRUCT(var, ta, ptr, type)                                    \
+  ({ td_err_e _err = TD_OK;                                                  \
+     if ((ta)->ta_sizeof_##type == 0)                                        \
+       _err = _td_check_sizeof ((ta), &(ta)->ta_sizeof_##type,               \
+                                     SYM_SIZEOF_##type);                     \
+     if (_err == TD_OK)                                                              \
+       _err = ps_pdread ((ta)->ph, (ptr),                                    \
+                        (var) = __alloca ((ta)->ta_sizeof_##type),           \
+                        (ta)->ta_sizeof_##type)                              \
+        == PS_OK ? TD_OK : TD_ERR;                                           \
+     else                                                                    \
+       (var) = NULL;                                                         \
+     _err;                                                                   \
+  })
+#define DB_PUT_STRUCT(ta, ptr, type, copy)                                   \
+  ({ assert ((ta)->ta_sizeof_##type != 0);                                   \
+     ps_pdwrite ((ta)->ph, (ptr), (copy), (ta)->ta_sizeof_##type)            \
+       == PS_OK ? TD_OK : TD_ERR;                                            \
+  })
+
+extern td_err_e _td_check_sizeof (td_thragent_t *ta, uint32_t *sizep,
+                                 int sizep_name) attribute_hidden;
 
 #endif /* thread_dbP.h */