]> git.ipfire.org Git - thirdparty/glibc.git/blobdiff - nptl/sysdeps/x86_64/tls.h
Compile with -Wundef.
[thirdparty/glibc.git] / nptl / sysdeps / x86_64 / tls.h
index 2daf0328d59f6dd9511f56eb6902036477450290..30bd4495280f87acacfeec1aa982a087e3423f4d 100644 (file)
@@ -1,5 +1,5 @@
 /* Definition for thread-local data handling.  nptl/x86_64 version.
-   Copyright (C) 2002 Free Software Foundation, Inc.
+   Copyright (C) 2002-2014 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
    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.  */
+   License along with the GNU C Library; if not, see
+   <http://www.gnu.org/licenses/>.  */
 
 #ifndef _TLS_H
 #define _TLS_H 1
 
 #ifndef __ASSEMBLER__
+# include <asm/prctl.h>        /* For ARCH_SET_FS.  */
+# include <stdbool.h>
 # include <stddef.h>
 # include <stdint.h>
+# include <stdlib.h>
+# include <sysdep.h>
+# include <libc-internal.h>
+# include <kernel-features.h>
+
+/* Replacement type for __m128 since this file is included by ld.so,
+   which is compiled with -mno-sse.  It must not change the alignment
+   of rtld_savespace_sse.  */
+typedef struct
+{
+  int i[4];
+} __128bits;
 
 
 /* Type for the dtv.  */
 typedef union dtv
 {
   size_t counter;
-  void *pointer;
+  struct
+  {
+    void *val;
+    bool is_static;
+  } pointer;
 } dtv_t;
 
 
 typedef struct
 {
-  void *tcb;           /* Pointer to the TCB.  Not necessary the
+  void *tcb;           /* Pointer to the TCB.  Not necessarily the
                           thread descriptor used by libpthread.  */
   dtv_t *dtv;
   void *self;          /* Pointer to the thread descriptor.  */
+  int multiple_threads;
+  int gscope_flag;
+  uintptr_t sysinfo;
+  uintptr_t stack_guard;
+  uintptr_t pointer_guard;
+  unsigned long int vgetcpu_cache[2];
+# ifndef __ASSUME_PRIVATE_FUTEX
+  int private_futex;
+# else
+  int __glibc_reserved1;
+# endif
+  int rtld_must_xmm_save;
+  /* Reservation of some values for the TM ABI.  */
+  void *__private_tm[4];
+  /* GCC split stack support.  */
+  void *__private_ss;
+  long int __glibc_reserved2;
+  /* Have space for the post-AVX register size.  */
+  __128bits rtld_savespace_sse[8][4] __attribute__ ((aligned (32)));
+
+  void *__padding[8];
 } tcbhead_t;
-#endif
-
 
-/* We require TLS support in the tools.  */
-#ifndef HAVE_TLS_SUPPORT
-# error "TLS support is required."
+#else /* __ASSEMBLER__ */
+# include <tcb-offsets.h>
 #endif
 
-/* Signal that TLS support is available.  */
-#define USE_TLS        1
 
 /* Alignment requirement for the stack.  */
 #define STACK_ALIGN    16
@@ -59,39 +92,21 @@ typedef struct
 /* Get system call information.  */
 # include <sysdep.h>
 
-/* The old way: using LDT.  */
-
-/* Structure passed to `modify_ldt', 'set_thread_area', and 'clone' calls.  */
-struct user_desc
-{
-  unsigned int entry_number;
-  unsigned long int base_addr;
-  unsigned int limit;
-  unsigned int seg_32bit:1;
-  unsigned int contents:2;
-  unsigned int read_exec_only:1;
-  unsigned int limit_in_pages:1;
-  unsigned int seg_not_present:1;
-  unsigned int useable:1;
-  unsigned int empty:25;
-};
-
-/* Initializing bit fields is slow.  We speed it up by using a union.  */
-union user_desc_init
-{
-  struct user_desc desc;
-  unsigned int vals[4];
-};
-
-
-/* Get the thread descriptor definition.  */
-# include <nptl/descr.h>
+#ifndef LOCK_PREFIX
+# ifdef UP
+#  define LOCK_PREFIX  /* nothing */
+# else
+#  define LOCK_PREFIX  "lock;"
+# endif
+#endif
 
-/* This is the size of the initial TCB.  */
-# define TLS_INIT_TCB_SIZE sizeof (tcbhead_t)
+/* This is the size of the initial TCB.  Can't be just sizeof (tcbhead_t),
+   because NPTL getpid, __libc_alloca_cutoff etc. need (almost) the whole
+   struct pthread even when not linked with -lpthread.  */
+# define TLS_INIT_TCB_SIZE sizeof (struct pthread)
 
 /* Alignment requirements for the initial TCB.  */
-# define TLS_INIT_TCB_ALIGN __alignof__ (tcbhead_t)
+# define TLS_INIT_TCB_ALIGN __alignof__ (struct pthread)
 
 /* This is the size of the TCB.  */
 # define TLS_TCB_SIZE sizeof (struct pthread)
@@ -102,56 +117,27 @@ union user_desc_init
 /* The TCB can have any size and the memory following the address the
    thread pointer points to is unspecified.  Allocate the TCB there.  */
 # define TLS_TCB_AT_TP 1
+# define TLS_DTV_AT_TP 0
+
+/* Get the thread descriptor definition.  */
+# include <nptl/descr.h>
 
 
 /* Install the dtv pointer.  The pointer passed is to the element with
    index -1 which contain the length.  */
 # define INSTALL_DTV(descr, dtvp) \
-  ((tcbhead_t *) (descr))->dtv = dtvp + 1
+  ((tcbhead_t *) (descr))->dtv = (dtvp) + 1
 
 /* Install new dtv for current thread.  */
-# define INSTALL_NEW_DTV(dtv) \
+# define INSTALL_NEW_DTV(dtvp) \
   ({ struct pthread *__pd;                                                   \
-     THREAD_SETMEM (__pd, header.data.dtvp, dtv); })
+     THREAD_SETMEM (__pd, header.dtv, (dtvp)); })
 
 /* Return dtv of given thread descriptor.  */
 # define GET_DTV(descr) \
   (((tcbhead_t *) (descr))->dtv)
 
 
-/* Macros to load from and store into segment registers.  */
-# ifndef TLS_GET_GS
-#  define TLS_GET_GS() \
-  ({ int __seg; __asm ("movw %%gs, %w0" : "=q" (__seg)); __seg & 0xffff; })
-# endif
-# ifndef TLS_SET_GS
-#  define TLS_SET_GS(val) \
-  __asm ("movw %w0, %%gs" :: "q" (val))
-# endif
-
-
-# ifndef __NR_set_thread_area
-#  define __NR_set_thread_area 243
-# endif
-# ifndef TLS_FLAG_WRITABLE
-#  define TLS_FLAG_WRITABLE            0x00000001
-# endif
-
-// XXX Enable for the real world.
-#if 0
-# ifndef __ASSUME_SET_THREAD_AREA
-#  error "we need set_thread_area"
-# endif
-#endif
-
-# ifdef __PIC__
-#  define TLS_EBX_ARG "r"
-#  define TLS_LOAD_EBX "xchgl %3, %%ebx\n\t"
-# else
-#  define TLS_EBX_ARG "b"
-#  define TLS_LOAD_EBX
-# endif
-
 /* Code to initially initialize the thread pointer.  This might need
    special attention since 'errno' is not yet available and if the
    operation can cause a failure 'errno' must not be touched.
@@ -172,42 +158,46 @@ union user_desc_init
                   : "=a" (_result)                                           \
                   : "0" ((unsigned long int) __NR_arch_prctl),               \
                     "D" ((unsigned long int) ARCH_SET_FS),                   \
-                    "S" (_descr)                                             \
+                    "S" (_thrdescr)                                          \
                   : "memory", "cc", "r11", "cx");                            \
                                                                              \
-     _result ? -1 : 0; })
+    _result ? "cannot set %fs base address for thread-local storage" : 0;     \
+  })
 
 
 /* Return the address of the dtv for the current thread.  */
 # define THREAD_DTV() \
   ({ struct pthread *__pd;                                                   \
-     THREAD_GETMEM (__pd, header.data.dtvp); })
+     THREAD_GETMEM (__pd, header.dtv); })
 
 
 /* Return the thread descriptor for the current thread.
 
    The contained asm must *not* be marked volatile since otherwise
    assignments like
-        pthread_descr self = thread_self();
+       pthread_descr self = thread_self();
    do not get optimized away.  */
 # define THREAD_SELF \
   ({ struct pthread *__self;                                                 \
-     asm ("movq %%fs:%c1,%0" : "=r" (__self)                                 \
-         : "i" (offsetof (struct pthread, header.data.self)));               \
+     asm ("mov %%fs:%c1,%0" : "=r" (__self)                                  \
+         : "i" (offsetof (struct pthread, header.self)));                    \
      __self;})
 
+/* Magic for libthread_db to know how to do THREAD_SELF.  */
+# define DB_THREAD_SELF_INCLUDE  <sys/reg.h> /* For the FS constant.  */
+# define DB_THREAD_SELF CONST_THREAD_AREA (64, FS)
 
 /* Read member of the thread descriptor directly.  */
 # define THREAD_GETMEM(descr, member) \
   ({ __typeof (descr->member) __value;                                       \
      if (sizeof (__value) == 1)                                                      \
-       asm ("movb %%fs:%P2,%b0"                                                      \
-           : "=q" (__value)                                                  \
-           : "0" (0), "i" (offsetof (struct pthread, member)));              \
+       asm volatile ("movb %%fs:%P2,%b0"                                     \
+                    : "=q" (__value)                                         \
+                    : "0" (0), "i" (offsetof (struct pthread, member)));     \
      else if (sizeof (__value) == 4)                                         \
-       asm ("movl %%fs:%P1,%0"                                               \
-           : "=r" (__value)                                                  \
-           : "i" (offsetof (struct pthread, member)));                       \
+       asm volatile ("movl %%fs:%P1,%0"                                              \
+                    : "=r" (__value)                                         \
+                    : "i" (offsetof (struct pthread, member)));              \
      else                                                                    \
        {                                                                     \
         if (sizeof (__value) != 8)                                           \
@@ -215,9 +205,9 @@ union user_desc_init
              4 or 8.  */                                                     \
           abort ();                                                          \
                                                                              \
-        asm ("movq %%fs:%P1,%0"                                              \
-             : "=r" (__value)                                                \
-             : "i" (offsetof (struct pthread, member)));                     \
+        asm volatile ("movq %%fs:%P1,%q0"                                    \
+                      : "=r" (__value)                                       \
+                      : "i" (offsetof (struct pthread, member)));            \
        }                                                                     \
      __value; })
 
@@ -226,14 +216,14 @@ union user_desc_init
 # define THREAD_GETMEM_NC(descr, member, idx) \
   ({ __typeof (descr->member[0]) __value;                                    \
      if (sizeof (__value) == 1)                                                      \
-       asm ("movb %%fs:%P2(%3),%b0"                                          \
-           : "=q" (__value)                                                  \
-           : "0" (0), "i" (offsetof (struct pthread, member[0])),            \
-             "r" (idx));                                                     \
+       asm volatile ("movb %%fs:%P2(%q3),%b0"                                \
+                    : "=q" (__value)                                         \
+                    : "0" (0), "i" (offsetof (struct pthread, member[0])),   \
+                      "r" (idx));                                            \
      else if (sizeof (__value) == 4)                                         \
-       asm ("movl %%fs:%P1(,%2,4),%0"                                        \
-           : "=r" (__value)                                                  \
-           : "i" (offsetof (struct pthread, member[0])), "r" (idx));         \
+       asm volatile ("movl %%fs:%P1(,%q2,4),%0"                                      \
+                    : "=r" (__value)                                         \
+                    : "i" (offsetof (struct pthread, member[0])), "r" (idx));\
      else                                                                    \
        {                                                                     \
         if (sizeof (__value) != 8)                                           \
@@ -241,22 +231,32 @@ union user_desc_init
              4 or 8.  */                                                     \
           abort ();                                                          \
                                                                              \
-        asm ("movq %%fs:%P1(,%2,8),%0"                                       \
-             : "=r" (__value)                                                \
-             : "i" (offsetof (struct pthread, member[0])), "r" (idx));       \
+        asm volatile ("movq %%fs:%P1(,%q2,8),%q0"                            \
+                      : "=r" (__value)                                       \
+                      : "i" (offsetof (struct pthread, member[0])),          \
+                        "r" (idx));                                          \
        }                                                                     \
      __value; })
 
 
+/* Loading addresses of objects on x86-64 needs to be treated special
+   when generating PIC code.  */
+#ifdef __pic__
+# define IMM_MODE "nr"
+#else
+# define IMM_MODE "ir"
+#endif
+
+
 /* Same as THREAD_SETMEM, but the member offset can be non-constant.  */
 # define THREAD_SETMEM(descr, member, value) \
   ({ if (sizeof (descr->member) == 1)                                        \
-       asm volatile ("movb %0,%%fs:%P1" :                                    \
+       asm volatile ("movb %b0,%%fs:%P1" :                                   \
                     : "iq" (value),                                          \
                       "i" (offsetof (struct pthread, member)));              \
      else if (sizeof (descr->member) == 4)                                   \
        asm volatile ("movl %0,%%fs:%P1" :                                    \
-                    : "ir" (value),                                          \
+                    : IMM_MODE (value),                                      \
                       "i" (offsetof (struct pthread, member)));              \
      else                                                                    \
        {                                                                     \
@@ -265,8 +265,8 @@ union user_desc_init
              4 or 8.  */                                                     \
           abort ();                                                          \
                                                                              \
-        asm volatile ("movq %0,%%fs:%P1" :                                   \
-                      : "ir" ((unsigned long int) value),                    \
+        asm volatile ("movq %q0,%%fs:%P1" :                                  \
+                      : IMM_MODE ((uint64_t) cast_to_integer (value)),       \
                         "i" (offsetof (struct pthread, member)));            \
        }})
 
@@ -274,13 +274,13 @@ union user_desc_init
 /* Set member of the thread descriptor directly.  */
 # define THREAD_SETMEM_NC(descr, member, idx, value) \
   ({ if (sizeof (descr->member[0]) == 1)                                     \
-       asm volatile ("movb %0,%%fs:%P1(%2)" :                                \
+       asm volatile ("movb %b0,%%fs:%P1(%q2)" :                                      \
                     : "iq" (value),                                          \
                       "i" (offsetof (struct pthread, member[0])),            \
                       "r" (idx));                                            \
      else if (sizeof (descr->member[0]) == 4)                                \
-       asm volatile ("movl %0,%%fs:%P1(,%2,4)" :                             \
-                    : "ir" (value),                                          \
+       asm volatile ("movl %0,%%fs:%P1(,%q2,4)" :                            \
+                    : IMM_MODE (value),                                      \
                       "i" (offsetof (struct pthread, member[0])),            \
                       "r" (idx));                                            \
      else                                                                    \
@@ -290,13 +290,133 @@ union user_desc_init
              4 or 8.  */                                                     \
           abort ();                                                          \
                                                                              \
-        asm volatile ("movq %0,%%fs:%P1(,%2,8)" :                            \
-                      : "r" ((unsigned long int) value),                     \
+        asm volatile ("movq %q0,%%fs:%P1(,%q2,8)" :                          \
+                      : IMM_MODE ((uint64_t) cast_to_integer (value)),       \
                         "i" (offsetof (struct pthread, member[0])),          \
                         "r" (idx));                                          \
        }})
 
 
+/* Atomic compare and exchange on TLS, returning old value.  */
+# define THREAD_ATOMIC_CMPXCHG_VAL(descr, member, newval, oldval) \
+  ({ __typeof (descr->member) __ret;                                         \
+     __typeof (oldval) __old = (oldval);                                     \
+     if (sizeof (descr->member) == 4)                                        \
+       asm volatile (LOCK_PREFIX "cmpxchgl %2, %%fs:%P3"                     \
+                    : "=a" (__ret)                                           \
+                    : "0" (__old), "r" (newval),                             \
+                      "i" (offsetof (struct pthread, member)));              \
+     else                                                                    \
+       /* Not necessary for other sizes in the moment.  */                   \
+       abort ();                                                             \
+     __ret; })
+
+
+/* Atomic logical and.  */
+# define THREAD_ATOMIC_AND(descr, member, val) \
+  (void) ({ if (sizeof ((descr)->member) == 4)                               \
+             asm volatile (LOCK_PREFIX "andl %1, %%fs:%P0"                   \
+                           :: "i" (offsetof (struct pthread, member)),       \
+                              "ir" (val));                                   \
+           else                                                              \
+             /* Not necessary for other sizes in the moment.  */             \
+             abort (); })
+
+
+/* Atomic set bit.  */
+# define THREAD_ATOMIC_BIT_SET(descr, member, bit) \
+  (void) ({ if (sizeof ((descr)->member) == 4)                               \
+             asm volatile (LOCK_PREFIX "orl %1, %%fs:%P0"                    \
+                           :: "i" (offsetof (struct pthread, member)),       \
+                              "ir" (1 << (bit)));                            \
+           else                                                              \
+             /* Not necessary for other sizes in the moment.  */             \
+             abort (); })
+
+
+# define CALL_THREAD_FCT(descr) \
+  ({ void *__res;                                                            \
+     asm volatile ("movq %%fs:%P2, %%rdi\n\t"                                \
+                  "callq *%%fs:%P1"                                          \
+                  : "=a" (__res)                                             \
+                  : "i" (offsetof (struct pthread, start_routine)),          \
+                    "i" (offsetof (struct pthread, arg))                     \
+                  : "di", "si", "cx", "dx", "r8", "r9", "r10", "r11",        \
+                    "memory", "cc");                                         \
+     __res; })
+
+
+/* Set the stack guard field in TCB head.  */
+# define THREAD_SET_STACK_GUARD(value) \
+    THREAD_SETMEM (THREAD_SELF, header.stack_guard, value)
+# define THREAD_COPY_STACK_GUARD(descr) \
+    ((descr)->header.stack_guard                                             \
+     = THREAD_GETMEM (THREAD_SELF, header.stack_guard))
+
+
+/* Set the pointer guard field in the TCB head.  */
+# define THREAD_SET_POINTER_GUARD(value) \
+  THREAD_SETMEM (THREAD_SELF, header.pointer_guard, value)
+# define THREAD_COPY_POINTER_GUARD(descr) \
+  ((descr)->header.pointer_guard                                             \
+   = THREAD_GETMEM (THREAD_SELF, header.pointer_guard))
+
+
+/* Get and set the global scope generation counter in the TCB head.  */
+# define THREAD_GSCOPE_FLAG_UNUSED 0
+# define THREAD_GSCOPE_FLAG_USED   1
+# define THREAD_GSCOPE_FLAG_WAIT   2
+# define THREAD_GSCOPE_RESET_FLAG() \
+  do                                                                         \
+    { int __res;                                                             \
+      asm volatile ("xchgl %0, %%fs:%P1"                                     \
+                   : "=r" (__res)                                            \
+                   : "i" (offsetof (struct pthread, header.gscope_flag)),    \
+                     "0" (THREAD_GSCOPE_FLAG_UNUSED));                       \
+      if (__res == THREAD_GSCOPE_FLAG_WAIT)                                  \
+       lll_futex_wake (&THREAD_SELF->header.gscope_flag, 1, LLL_PRIVATE);    \
+    }                                                                        \
+  while (0)
+# define THREAD_GSCOPE_SET_FLAG() \
+  THREAD_SETMEM (THREAD_SELF, header.gscope_flag, THREAD_GSCOPE_FLAG_USED)
+# define THREAD_GSCOPE_WAIT() \
+  GL(dl_wait_lookup_done) ()
+
+
+# ifdef SHARED
+/* Defined in dl-trampoline.S.  */
+extern void _dl_x86_64_save_sse (void);
+extern void _dl_x86_64_restore_sse (void);
+
+# define RTLD_CHECK_FOREIGN_CALL \
+  (THREAD_GETMEM (THREAD_SELF, header.rtld_must_xmm_save) != 0)
+
+/* NB: Don't use the xchg operation because that would imply a lock
+   prefix which is expensive and unnecessary.  The cache line is also
+   not contested at all.  */
+#  define RTLD_ENABLE_FOREIGN_CALL \
+  int old_rtld_must_xmm_save = THREAD_GETMEM (THREAD_SELF,                   \
+                                             header.rtld_must_xmm_save);     \
+  THREAD_SETMEM (THREAD_SELF, header.rtld_must_xmm_save, 1)
+
+#  define RTLD_PREPARE_FOREIGN_CALL \
+  do if (THREAD_GETMEM (THREAD_SELF, header.rtld_must_xmm_save))             \
+    {                                                                        \
+      _dl_x86_64_save_sse ();                                                \
+      THREAD_SETMEM (THREAD_SELF, header.rtld_must_xmm_save, 0);             \
+    }                                                                        \
+  while (0)
+
+#  define RTLD_FINALIZE_FOREIGN_CALL \
+  do {                                                                       \
+    if (THREAD_GETMEM (THREAD_SELF, header.rtld_must_xmm_save) == 0)         \
+      _dl_x86_64_restore_sse ();                                             \
+    THREAD_SETMEM (THREAD_SELF, header.rtld_must_xmm_save,                   \
+                  old_rtld_must_xmm_save);                                   \
+  } while (0)
+# endif
+
+
 #endif /* __ASSEMBLER__ */
 
 #endif /* tls.h */