nptl/sysdeps/x86_64/tls.h

   1 /* Definition for thread-local data handling.  nptl/x86_64 version.
   2    Copyright (C) 2002-2007, 2008 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library 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 GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #ifndef _TLS_H
  21 #define _TLS_H  1
  22
  23 #ifndef __ASSEMBLER__
  24 # include <asm/prctl.h> /* For ARCH_SET_FS.  */
  25 # include <stdbool.h>
  26 # include <stddef.h>
  27 # include <stdint.h>
  28 # include <stdlib.h>
  29 # include <sysdep.h>
  30 # include <kernel-features.h>
  31 # include <bits/wordsize.h>
  32
  33
  34 /* Type for the dtv.  */
  35 typedef union dtv
  36 {
  37   size_t counter;
  38   struct
  39   {
  40     void *val;
  41     bool is_static;
  42   } pointer;
  43 } dtv_t;
  44
  45
  46 typedef struct
  47 {
  48   void *tcb;            /* Pointer to the TCB.  Not necessarily the
  49                            thread descriptor used by libpthread.  */
  50   dtv_t *dtv;
  51   void *self;           /* Pointer to the thread descriptor.  */
  52   int multiple_threads;
  53   int gscope_flag;
  54   uintptr_t sysinfo;
  55   uintptr_t stack_guard;
  56   uintptr_t pointer_guard;
  57   unsigned long int vgetcpu_cache[2];
  58 #ifndef __ASSUME_PRIVATE_FUTEX
  59   int private_futex;
  60 #else
  61   int __unused1;
  62 #endif
  63 #if __WORDSIZE == 64
  64   int __pad1;
  65 #endif
  66   /* Reservation of some values for the TM ABI.  */
  67   void *__private_tm[5];
  68 } tcbhead_t;
  69
  70 #else /* __ASSEMBLER__ */
  71 # include <tcb-offsets.h>
  72 #endif
  73
  74
  75 /* We require TLS support in the tools.  */
  76 #ifndef HAVE_TLS_SUPPORT
  77 # error "TLS support is required."
  78 #endif
  79
  80 /* Alignment requirement for the stack.  */
  81 #define STACK_ALIGN     16
  82
  83
  84 #ifndef __ASSEMBLER__
  85 /* Get system call information.  */
  86 # include <sysdep.h>
  87
  88
  89 /* Get the thread descriptor definition.  */
  90 # include <nptl/descr.h>
  91
  92 #ifndef LOCK_PREFIX
  93 # ifdef UP
  94 #  define LOCK_PREFIX   /* nothing */
  95 # else
  96 #  define LOCK_PREFIX   "lock;"
  97 # endif
  98 #endif
  99
 100 /* This is the size of the initial TCB.  Can't be just sizeof (tcbhead_t),
 101    because NPTL getpid, __libc_alloca_cutoff etc. need (almost) the whole
 102    struct pthread even when not linked with -lpthread.  */
 103 # define TLS_INIT_TCB_SIZE sizeof (struct pthread)
 104
 105 /* Alignment requirements for the initial TCB.  */
 106 # define TLS_INIT_TCB_ALIGN __alignof__ (struct pthread)
 107
 108 /* This is the size of the TCB.  */
 109 # define TLS_TCB_SIZE sizeof (struct pthread)
 110
 111 /* Alignment requirements for the TCB.  */
 112 # define TLS_TCB_ALIGN __alignof__ (struct pthread)
 113
 114 /* The TCB can have any size and the memory following the address the
 115    thread pointer points to is unspecified.  Allocate the TCB there.  */
 116 # define TLS_TCB_AT_TP  1
 117
 118
 119 /* Install the dtv pointer.  The pointer passed is to the element with
 120    index -1 which contain the length.  */
 121 # define INSTALL_DTV(descr, dtvp) \
 122   ((tcbhead_t *) (descr))->dtv = (dtvp) + 1
 123
 124 /* Install new dtv for current thread.  */
 125 # define INSTALL_NEW_DTV(dtvp) \
 126   ({ struct pthread *__pd;                                                    \
 127      THREAD_SETMEM (__pd, header.dtv, (dtvp)); })
 128
 129 /* Return dtv of given thread descriptor.  */
 130 # define GET_DTV(descr) \
 131   (((tcbhead_t *) (descr))->dtv)
 132
 133
 134 /* Macros to load from and store into segment registers.  */
 135 # define TLS_GET_FS() \
 136   ({ int __seg; __asm ("movl %%fs, %0" : "=q" (__seg)); __seg; })
 137 # define TLS_SET_FS(val) \
 138   __asm ("movl %0, %%fs" :: "q" (val))
 139
 140
 141 /* Code to initially initialize the thread pointer.  This might need
 142    special attention since 'errno' is not yet available and if the
 143    operation can cause a failure 'errno' must not be touched.
 144
 145    We have to make the syscall for both uses of the macro since the
 146    address might be (and probably is) different.  */
 147 # define TLS_INIT_TP(thrdescr, secondcall) \
 148   ({ void *_thrdescr = (thrdescr);                                            \
 149      tcbhead_t *_head = _thrdescr;                                            \
 150      int _result;                                                             \
 151                                                                               \
 152      _head->tcb = _thrdescr;                                                  \
 153      /* For now the thread descriptor is at the same address.  */             \
 154      _head->self = _thrdescr;                                                 \
 155                                                                               \
 156      /* It is a simple syscall to set the %fs value for the thread.  */       \
 157      asm volatile ("syscall"                                                  \
 158                    : "=a" (_result)                                           \
 159                    : "0" ((unsigned long int) __NR_arch_prctl),               \
 160                      "D" ((unsigned long int) ARCH_SET_FS),                   \
 161                      "S" (_thrdescr)                                          \
 162                    : "memory", "cc", "r11", "cx");                            \
 163                                                                               \
 164     _result ? "cannot set %fs base address for thread-local storage" : 0;     \
 165   })
 166
 167
 168 /* Return the address of the dtv for the current thread.  */
 169 # define THREAD_DTV() \
 170   ({ struct pthread *__pd;                                                    \
 171      THREAD_GETMEM (__pd, header.dtv); })
 172
 173
 174 /* Return the thread descriptor for the current thread.
 175
 176    The contained asm must *not* be marked volatile since otherwise
 177    assignments like
 178         pthread_descr self = thread_self();
 179    do not get optimized away.  */
 180 # define THREAD_SELF \
 181   ({ struct pthread *__self;                                                  \
 182      asm ("movq %%fs:%c1,%q0" : "=r" (__self)                                 \
 183           : "i" (offsetof (struct pthread, header.self)));                    \
 184      __self;})
 185
 186 /* Magic for libthread_db to know how to do THREAD_SELF.  */
 187 # define DB_THREAD_SELF_INCLUDE  <sys/reg.h> /* For the FS constant.  */
 188 # define DB_THREAD_SELF CONST_THREAD_AREA (64, FS)
 189
 190 /* Read member of the thread descriptor directly.  */
 191 # define THREAD_GETMEM(descr, member) \
 192   ({ __typeof (descr->member) __value;                                        \
 193      if (sizeof (__value) == 1)                                               \
 194        asm volatile ("movb %%fs:%P2,%b0"                                      \
 195                      : "=q" (__value)                                         \
 196                      : "0" (0), "i" (offsetof (struct pthread, member)));     \
 197      else if (sizeof (__value) == 4)                                          \
 198        asm volatile ("movl %%fs:%P1,%0"                                       \
 199                      : "=r" (__value)                                         \
 200                      : "i" (offsetof (struct pthread, member)));              \
 201      else                                                                     \
 202        {                                                                      \
 203          if (sizeof (__value) != 8)                                           \
 204            /* There should not be any value with a size other than 1,         \
 205               4 or 8.  */                                                     \
 206            abort ();                                                          \
 207                                                                               \
 208          asm volatile ("movq %%fs:%P1,%q0"                                    \
 209                        : "=r" (__value)                                       \
 210                        : "i" (offsetof (struct pthread, member)));            \
 211        }                                                                      \
 212      __value; })
 213
 214
 215 /* Same as THREAD_GETMEM, but the member offset can be non-constant.  */
 216 # define THREAD_GETMEM_NC(descr, member, idx) \
 217   ({ __typeof (descr->member[0]) __value;                                     \
 218      if (sizeof (__value) == 1)                                               \
 219        asm volatile ("movb %%fs:%P2(%q3),%b0"                                 \
 220                      : "=q" (__value)                                         \
 221                      : "0" (0), "i" (offsetof (struct pthread, member[0])),   \
 222                        "r" (idx));                                            \
 223      else if (sizeof (__value) == 4)                                          \
 224        asm volatile ("movl %%fs:%P1(,%q2,4),%0"                               \
 225                      : "=r" (__value)                                         \
 226                      : "i" (offsetof (struct pthread, member[0])), "r" (idx));\
 227      else                                                                     \
 228        {                                                                      \
 229          if (sizeof (__value) != 8)                                           \
 230            /* There should not be any value with a size other than 1,         \
 231               4 or 8.  */                                                     \
 232            abort ();                                                          \
 233                                                                               \
 234          asm volatile ("movq %%fs:%P1(,%q2,8),%q0"                            \
 235                        : "=r" (__value)                                       \
 236                        : "i" (offsetof (struct pthread, member[0])),          \
 237                          "r" (idx));                                          \
 238        }                                                                      \
 239      __value; })
 240
 241
 242 /* Loading addresses of objects on x86-64 needs to be treated special
 243    when generating PIC code.  */
 244 #ifdef __pic__
 245 # define IMM_MODE "nr"
 246 #else
 247 # define IMM_MODE "ir"
 248 #endif
 249
 250
 251 /* Same as THREAD_SETMEM, but the member offset can be non-constant.  */
 252 # define THREAD_SETMEM(descr, member, value) \
 253   ({ if (sizeof (descr->member) == 1)                                         \
 254        asm volatile ("movb %b0,%%fs:%P1" :                                    \
 255                      : "iq" (value),                                          \
 256                        "i" (offsetof (struct pthread, member)));              \
 257      else if (sizeof (descr->member) == 4)                                    \
 258        asm volatile ("movl %0,%%fs:%P1" :                                     \
 259                      : IMM_MODE (value),                                      \
 260                        "i" (offsetof (struct pthread, member)));              \
 261      else                                                                     \
 262        {                                                                      \
 263          if (sizeof (descr->member) != 8)                                     \
 264            /* There should not be any value with a size other than 1,         \
 265               4 or 8.  */                                                     \
 266            abort ();                                                          \
 267                                                                               \
 268          asm volatile ("movq %q0,%%fs:%P1" :                                  \
 269                        : IMM_MODE ((unsigned long int) value),                \
 270                          "i" (offsetof (struct pthread, member)));            \
 271        }})
 272
 273
 274 /* Set member of the thread descriptor directly.  */
 275 # define THREAD_SETMEM_NC(descr, member, idx, value) \
 276   ({ if (sizeof (descr->member[0]) == 1)                                      \
 277        asm volatile ("movb %b0,%%fs:%P1(%q2)" :                               \
 278                      : "iq" (value),                                          \
 279                        "i" (offsetof (struct pthread, member[0])),            \
 280                        "r" (idx));                                            \
 281      else if (sizeof (descr->member[0]) == 4)                                 \
 282        asm volatile ("movl %0,%%fs:%P1(,%q2,4)" :                             \
 283                      : IMM_MODE (value),                                      \
 284                        "i" (offsetof (struct pthread, member[0])),            \
 285                        "r" (idx));                                            \
 286      else                                                                     \
 287        {                                                                      \
 288          if (sizeof (descr->member[0]) != 8)                                  \
 289            /* There should not be any value with a size other than 1,         \
 290               4 or 8.  */                                                     \
 291            abort ();                                                          \
 292                                                                               \
 293          asm volatile ("movq %q0,%%fs:%P1(,%q2,8)" :                          \
 294                        : IMM_MODE ((unsigned long int) value),                \
 295                          "i" (offsetof (struct pthread, member[0])),          \
 296                          "r" (idx));                                          \
 297        }})
 298
 299
 300 /* Atomic compare and exchange on TLS, returning old value.  */
 301 #define THREAD_ATOMIC_CMPXCHG_VAL(descr, member, newval, oldval) \
 302   ({ __typeof (descr->member) __ret;                                          \
 303      __typeof (oldval) __old = (oldval);                                      \
 304      if (sizeof (descr->member) == 4)                                         \
 305        asm volatile (LOCK_PREFIX "cmpxchgl %2, %%fs:%P3"                      \
 306                      : "=a" (__ret)                                           \
 307                      : "0" (__old), "r" (newval),                             \
 308                        "i" (offsetof (struct pthread, member)));              \
 309      else                                                                     \
 310        /* Not necessary for other sizes in the moment.  */                    \
 311        abort ();                                                              \
 312      __ret; })
 313
 314
 315 /* Atomic set bit.  */
 316 #define THREAD_ATOMIC_BIT_SET(descr, member, bit) \
 317   (void) ({ if (sizeof ((descr)->member) == 4)                                \
 318               asm volatile (LOCK_PREFIX "orl %1, %%fs:%P0"                    \
 319                             :: "i" (offsetof (struct pthread, member)),       \
 320                                "ir" (1 << (bit)));                            \
 321             else                                                              \
 322               /* Not necessary for other sizes in the moment.  */             \
 323               abort (); })
 324
 325
 326 #define CALL_THREAD_FCT(descr) \
 327   ({ void *__res;                                                             \
 328      asm volatile ("movq %%fs:%P2, %%rdi\n\t"                                 \
 329                    "callq *%%fs:%P1"                                          \
 330                    : "=a" (__res)                                             \
 331                    : "i" (offsetof (struct pthread, start_routine)),          \
 332                      "i" (offsetof (struct pthread, arg))                     \
 333                    : "di", "si", "cx", "dx", "r8", "r9", "r10", "r11",        \
 334                      "memory", "cc");                                         \
 335      __res; })
 336
 337
 338 /* Set the stack guard field in TCB head.  */
 339 # define THREAD_SET_STACK_GUARD(value) \
 340     THREAD_SETMEM (THREAD_SELF, header.stack_guard, value)
 341 # define THREAD_COPY_STACK_GUARD(descr) \
 342     ((descr)->header.stack_guard                                              \
 343      = THREAD_GETMEM (THREAD_SELF, header.stack_guard))
 344
 345
 346 /* Set the pointer guard field in the TCB head.  */
 347 #define THREAD_SET_POINTER_GUARD(value) \
 348   THREAD_SETMEM (THREAD_SELF, header.pointer_guard, value)
 349 #define THREAD_COPY_POINTER_GUARD(descr) \
 350   ((descr)->header.pointer_guard                                              \
 351    = THREAD_GETMEM (THREAD_SELF, header.pointer_guard))
 352
 353
 354 /* Get and set the global scope generation counter in the TCB head.  */
 355 #define THREAD_GSCOPE_FLAG_UNUSED 0
 356 #define THREAD_GSCOPE_FLAG_USED   1
 357 #define THREAD_GSCOPE_FLAG_WAIT   2
 358 #define THREAD_GSCOPE_RESET_FLAG() \
 359   do                                                                          \
 360     { int __res;                                                              \
 361       asm volatile ("xchgl %0, %%fs:%P1"                                      \
 362                     : "=r" (__res)                                            \
 363                     : "i" (offsetof (struct pthread, header.gscope_flag)),    \
 364                       "0" (THREAD_GSCOPE_FLAG_UNUSED));                       \
 365       if (__res == THREAD_GSCOPE_FLAG_WAIT)                                   \
 366         lll_futex_wake (&THREAD_SELF->header.gscope_flag, 1, LLL_PRIVATE);    \
 367     }                                                                         \
 368   while (0)
 369 #define THREAD_GSCOPE_SET_FLAG() \
 370   THREAD_SETMEM (THREAD_SELF, header.gscope_flag, THREAD_GSCOPE_FLAG_USED)
 371 #define THREAD_GSCOPE_WAIT() \
 372   GL(dl_wait_lookup_done) ()
 373
 374 #endif /* __ASSEMBLER__ */
 375
 376 #endif  /* tls.h */