[thirdparty/glibc.git] / sysdeps / aarch64 / nptl / tls.h

/* Copyright (C) 2005-2016 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, see
   <http://www.gnu.org/licenses/>.  */

#ifndef _TLS_H
#define _TLS_H	1

#include <dl-sysdep.h>

#ifndef __ASSEMBLER__
# include <stdbool.h>
# include <stddef.h>
# include <stdint.h>

/* Type for the dtv.  */
typedef union dtv
{
  size_t counter;
  struct
  {
    void *val;
    bool is_static;
  } pointer;
} dtv_t;

#else /* __ASSEMBLER__ */
# include <tcb-offsets.h>
#endif /* __ASSEMBLER__ */

#ifndef __ASSEMBLER__

/* Get system call information.  */
# include <sysdep.h>

/* The TP points to the start of the thread blocks.  */
# define TLS_DTV_AT_TP	1
# define TLS_TCB_AT_TP	0

/* Get the thread descriptor definition.  */
# include <nptl/descr.h>

typedef struct
{
  dtv_t *dtv;
  void *private;
} tcbhead_t;

/* This is the size of the initial TCB.  */
# define TLS_INIT_TCB_SIZE	sizeof (tcbhead_t)

/* Alignment requirements for the initial TCB.  */
# define TLS_INIT_TCB_ALIGN	__alignof__ (struct pthread)

/* This is the size of the TCB.  */
# define TLS_TCB_SIZE		sizeof (tcbhead_t)

/* This is the size we need before TCB.  */
# define TLS_PRE_TCB_SIZE	sizeof (struct pthread)

/* Alignment requirements for the TCB.  */
# define TLS_TCB_ALIGN		__alignof__ (struct pthread)

/* Install the dtv pointer.  The pointer passed is to the element with
   index -1 which contain the length.  */
# define INSTALL_DTV(tcbp, dtvp) \
  (((tcbhead_t *) (tcbp))->dtv = (dtvp) + 1)

/* Install new dtv for current thread.  */
# define INSTALL_NEW_DTV(dtv) \
  (THREAD_DTV() = (dtv))

/* Return dtv of given thread descriptor.  */
# define GET_DTV(tcbp) \
  (((tcbhead_t *) (tcbp))->dtv)

/* 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.  */
# define TLS_INIT_TP(tcbp) \
  ({ __asm __volatile ("msr tpidr_el0, %0" : : "r" (tcbp)); NULL; })

/* Value passed to 'clone' for initialization of the thread register.  */
# define TLS_DEFINE_INIT_TP(tp, pd) void *tp = (pd) + 1

/* Return the address of the dtv for the current thread.  */
# define THREAD_DTV() \
  (((tcbhead_t *) __builtin_thread_pointer ())->dtv)

/* Return the thread descriptor for the current thread.  */
# define THREAD_SELF \
 ((struct pthread *)__builtin_thread_pointer () - 1)

/* Magic for libthread_db to know how to do THREAD_SELF.  */
# define DB_THREAD_SELF \
  CONST_THREAD_AREA (64, sizeof (struct pthread))

/* Access to data in the thread descriptor is easy.  */
# define THREAD_GETMEM(descr, member) \
  descr->member
# define THREAD_GETMEM_NC(descr, member, idx) \
  descr->member[idx]
# define THREAD_SETMEM(descr, member, value) \
  descr->member = (value)
# define THREAD_SETMEM_NC(descr, member, idx, value) \
  descr->member[idx] = (value)

/* Get and set the global scope generation counter in struct pthread.  */
# 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								     \
	= atomic_exchange_rel (&THREAD_SELF->header.gscope_flag,	     \
			       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() \
  do									     \
    {									     \
      THREAD_SELF->header.gscope_flag = THREAD_GSCOPE_FLAG_USED;	     \
      atomic_write_barrier ();						     \
    }									     \
  while (0)
# define THREAD_GSCOPE_WAIT() \
  GL(dl_wait_lookup_done) ()

# endif /* __ASSEMBLER__ */

#endif	/* tls.h */
Commit	Line	Data
f7a9f785	1	/* Copyright (C) 2005-2016 Free Software Foundation, Inc.
554066b8 MS	2
	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 License as
	7	published by the Free Software Foundation; either version 2.1 of the
	8	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, see
	17	<http://www.gnu.org/licenses/>. */
	18
	19	#ifndef _TLS_H
	20	#define _TLS_H 1
	21
	22	#include <dl-sysdep.h>
	23
	24	#ifndef __ASSEMBLER__
	25	# include <stdbool.h>
	26	# include <stddef.h>
	27	# include <stdint.h>
	28
	29	/* Type for the dtv. */
	30	typedef union dtv
	31	{
	32	size_t counter;
	33	struct
	34	{
	35	void *val;
	36	bool is_static;
	37	} pointer;
	38	} dtv_t;
	39
	40	#else /* __ASSEMBLER__ */
	41	# include <tcb-offsets.h>
	42	#endif /* __ASSEMBLER__ */
	43
	44	#ifndef __ASSEMBLER__
	45
	46	/* Get system call information. */
	47	# include <sysdep.h>
	48
	49	/* The TP points to the start of the thread blocks. */
	50	# define TLS_DTV_AT_TP 1
498a2233	51	# define TLS_TCB_AT_TP 0
554066b8 MS	52
	53	/* Get the thread descriptor definition. */
	54	# include <nptl/descr.h>
	55
	56	typedef struct
	57	{
	58	dtv_t *dtv;
	59	void *private;
	60	} tcbhead_t;
	61
	62	/* This is the size of the initial TCB. */
	63	# define TLS_INIT_TCB_SIZE sizeof (tcbhead_t)
	64
	65	/* Alignment requirements for the initial TCB. */
75f11331	66	# define TLS_INIT_TCB_ALIGN __alignof__ (struct pthread)
554066b8 MS	67
	68	/* This is the size of the TCB. */
	69	# define TLS_TCB_SIZE sizeof (tcbhead_t)
	70
	71	/* This is the size we need before TCB. */
	72	# define TLS_PRE_TCB_SIZE sizeof (struct pthread)
	73
	74	/* Alignment requirements for the TCB. */
75f11331	75	# define TLS_TCB_ALIGN __alignof__ (struct pthread)
554066b8 MS	76
	77	/* Install the dtv pointer. The pointer passed is to the element with
	78	index -1 which contain the length. */
	79	# define INSTALL_DTV(tcbp, dtvp) \
	80	(((tcbhead_t *) (tcbp))->dtv = (dtvp) + 1)
	81
	82	/* Install new dtv for current thread. */
	83	# define INSTALL_NEW_DTV(dtv) \
	84	(THREAD_DTV() = (dtv))
	85
	86	/* Return dtv of given thread descriptor. */
	87	# define GET_DTV(tcbp) \
	88	(((tcbhead_t *) (tcbp))->dtv)
	89
	90	/* Code to initially initialize the thread pointer. This might need
	91	special attention since 'errno' is not yet available and if the
	92	operation can cause a failure 'errno' must not be touched. */
774f9285	93	# define TLS_INIT_TP(tcbp) \
554066b8 MS	94	({ __asm __volatile ("msr tpidr_el0, %0" : : "r" (tcbp)); NULL; })
554066b8 MS	95
9503784a RM	96	/* Value passed to 'clone' for initialization of the thread register. */
	97	# define TLS_DEFINE_INIT_TP(tp, pd) void *tp = (pd) + 1
	98
554066b8 MS	99	/* Return the address of the dtv for the current thread. */
	100	# define THREAD_DTV() \
	101	(((tcbhead_t *) __builtin_thread_pointer ())->dtv)
	102
	103	/* Return the thread descriptor for the current thread. */
	104	# define THREAD_SELF \
	105	((struct pthread *)__builtin_thread_pointer () - 1)
	106
	107	/* Magic for libthread_db to know how to do THREAD_SELF. */
	108	# define DB_THREAD_SELF \
	109	CONST_THREAD_AREA (64, sizeof (struct pthread))
	110
	111	/* Access to data in the thread descriptor is easy. */
	112	# define THREAD_GETMEM(descr, member) \
	113	descr->member
	114	# define THREAD_GETMEM_NC(descr, member, idx) \
	115	descr->member[idx]
	116	# define THREAD_SETMEM(descr, member, value) \
	117	descr->member = (value)
	118	# define THREAD_SETMEM_NC(descr, member, idx, value) \
	119	descr->member[idx] = (value)
	120
	121	/* Get and set the global scope generation counter in struct pthread. */
	122	# define THREAD_GSCOPE_FLAG_UNUSED 0
	123	# define THREAD_GSCOPE_FLAG_USED 1
	124	# define THREAD_GSCOPE_FLAG_WAIT 2
	125	# define THREAD_GSCOPE_RESET_FLAG() \
	126	do \
	127	{ int __res \
	128	= atomic_exchange_rel (&THREAD_SELF->header.gscope_flag, \
	129	THREAD_GSCOPE_FLAG_UNUSED); \
	130	if (__res == THREAD_GSCOPE_FLAG_WAIT) \
	131	lll_futex_wake (&THREAD_SELF->header.gscope_flag, 1, LLL_PRIVATE); \
	132	} \
	133	while (0)
	134	# define THREAD_GSCOPE_SET_FLAG() \
	135	do \
	136	{ \
	137	THREAD_SELF->header.gscope_flag = THREAD_GSCOPE_FLAG_USED; \
	138	atomic_write_barrier (); \
	139	} \
	140	while (0)
	141	# define THREAD_GSCOPE_WAIT() \
	142	GL(dl_wait_lookup_done) ()
	143
	144	# endif /* __ASSEMBLER__ */
	145
	146	#endif /* tls.h */