[glibc.git] / sysdeps / powerpc / nptl / tls.h

/* Definition for thread-local data handling.  NPTL/PowerPC version.
   Copyright (C) 2003-2021 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
   <https://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>
# include <dl-dtv.h>

#else /* __ASSEMBLER__ */
# include <tcb-offsets.h>
# define __ASSEMBLY__
# include <asm/ptrace.h>
#endif /* __ASSEMBLER__ */

#ifndef __powerpc64__
/* Register r2 (tp) is reserved by the ABI as "thread pointer". */
# define PT_THREAD_POINTER PT_R2
# ifndef __ASSEMBLER__
register void *__thread_register __asm__ ("r2");
# endif

#else /* __powerpc64__ */
/* Register r13 (tp) is reserved by the ABI as "thread pointer". */
# define PT_THREAD_POINTER PT_R13
# ifndef __ASSEMBLER__
register void *__thread_register __asm__ ("r13");
# endif
#endif /* __powerpc64__ */

#ifndef __ASSEMBLER__

# include <hwcapinfo.h>

/* 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

/* We use the multiple_threads field in the pthread struct */
#define TLS_MULTIPLE_THREADS_IN_TCB	1

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


/* The stack_guard is accessed directly by GCC -fstack-protector code,
   so it is a part of public ABI.  The dtv and pointer_guard fields
   are private.  */
typedef struct
{
  /* Reservation for HWCAP data.  To be accessed by GCC in
     __builtin_cpu_supports(), so it is a part of public ABI.  */
  uint64_t hwcap;
  /* Reservation for AT_PLATFORM data.  To be accessed by GCC in
     __builtin_cpu_is(), so it is a part of public ABI.  Since there
     are different ABIs for 32 and 64 bit, we put this field in a
     previously empty padding space for powerpc64.  */
#ifndef __powerpc64__
  /* Padding to maintain alignment.  */
  uint32_t padding;
  uint32_t at_platform;
#endif
  uint32_t __unused;
  /* Reservation for AT_PLATFORM data - powerpc64.  */
#ifdef __powerpc64__
  uint32_t at_platform;
#endif
  /* Reservation for Dynamic System Optimizer ABI.  */
  uintptr_t dso_slot2;
  uintptr_t dso_slot1;
  /* Reservation for tar register (ISA 2.07).  */
  uintptr_t tar_save;
  /* GCC split stack support.  */
  void *__private_ss;
  /* Reservation for the Event-Based Branching ABI.  */
  uintptr_t ebb_handler;
  uintptr_t ebb_ctx_pointer;
  uintptr_t ebb_reserved1;
  uintptr_t ebb_reserved2;
  uintptr_t pointer_guard;
  uintptr_t stack_guard;
  dtv_t *dtv;
} tcbhead_t;

/* This is the size of the initial TCB.  */
# define TLS_INIT_TCB_SIZE	0

/* This is the size of the TCB.  */
# define TLS_TCB_SIZE		0

/* This is the size we need before TCB.  */
# define TLS_PRE_TCB_SIZE \
  (sizeof (struct pthread)						      \
   + ((sizeof (tcbhead_t) + __alignof (struct pthread) - 1)		      \
      & ~(__alignof (struct pthread) - 1)))

/* The following assumes that TP (R2 or R13) points to the end of the
   TCB + 0x7000 (per the ABI).  This implies that TCB address is
   TP - 0x7000.  As we define TLS_DTV_AT_TP we can
   assume that the pthread struct is allocated immediately ahead of the
   TCB.  This implies that the pthread_descr address is
   TP - (TLS_PRE_TCB_SIZE + 0x7000).  */
# define TLS_TCB_OFFSET	0x7000

/* 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))[-1].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))[-1].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) \
  ({ 									      \
    __thread_register = (void *) (tcbp) + TLS_TCB_OFFSET;		      \
    THREAD_SET_HWCAP (__tcb_hwcap);					      \
    THREAD_SET_AT_PLATFORM (__tcb_platform);				      \
    NULL;								      \
  })

/* Value passed to 'clone' for initialization of the thread register.  */
# define TLS_DEFINE_INIT_TP(tp, pd) \
    void *tp = (void *) (pd) + TLS_TCB_OFFSET + TLS_PRE_TCB_SIZE;	      \
    (((tcbhead_t *) ((char *) tp - TLS_TCB_OFFSET))[-1].hwcap) =	      \
      THREAD_GET_HWCAP ();						      \
    (((tcbhead_t *) ((char *) tp - TLS_TCB_OFFSET))[-1].at_platform) =	      \
      THREAD_GET_AT_PLATFORM ();

/* Return the address of the dtv for the current thread.  */
# define THREAD_DTV() \
    (((tcbhead_t *) (__thread_register - TLS_TCB_OFFSET))[-1].dtv)

/* Return the thread descriptor for the current thread.  */
# define THREAD_SELF \
    ((struct pthread *) (__thread_register \
			 - TLS_TCB_OFFSET - TLS_PRE_TCB_SIZE))

/* Magic for libthread_db to know how to do THREAD_SELF.  */
# define DB_THREAD_SELF							      \
  REGISTER (32, 32, PT_THREAD_POINTER * 4,				      \
	    - TLS_TCB_OFFSET - TLS_PRE_TCB_SIZE)			      \
  REGISTER (64, 64, PT_THREAD_POINTER * 8,				      \
	    - TLS_TCB_OFFSET - TLS_PRE_TCB_SIZE)

# include <tcb-access.h>

/* Set the stack guard field in TCB head.  */
# define THREAD_SET_STACK_GUARD(value) \
    (((tcbhead_t *) ((char *) __thread_register				      \
		     - TLS_TCB_OFFSET))[-1].stack_guard = (value))
# define THREAD_COPY_STACK_GUARD(descr) \
    (((tcbhead_t *) ((char *) (descr)					      \
		     + TLS_PRE_TCB_SIZE))[-1].stack_guard		      \
     = ((tcbhead_t *) ((char *) __thread_register			      \
		       - TLS_TCB_OFFSET))[-1].stack_guard)

/* Set the stack guard field in TCB head.  */
# define THREAD_GET_POINTER_GUARD() \
    (((tcbhead_t *) ((char *) __thread_register				      \
		     - TLS_TCB_OFFSET))[-1].pointer_guard)
# define THREAD_SET_POINTER_GUARD(value) \
    (THREAD_GET_POINTER_GUARD () = (value))
# define THREAD_COPY_POINTER_GUARD(descr) \
    (((tcbhead_t *) ((char *) (descr)					      \
		     + TLS_PRE_TCB_SIZE))[-1].pointer_guard		      \
     = THREAD_GET_POINTER_GUARD())

/* hwcap field in TCB head.  */
# define THREAD_GET_HWCAP() \
    (((tcbhead_t *) ((char *) __thread_register				      \
		     - TLS_TCB_OFFSET))[-1].hwcap)
# define THREAD_SET_HWCAP(value) \
    (THREAD_GET_HWCAP () = (value))

/* at_platform field in TCB head.  */
# define THREAD_GET_AT_PLATFORM() \
    (((tcbhead_t *) ((char *) __thread_register				      \
		     - TLS_TCB_OFFSET))[-1].at_platform)
# define THREAD_SET_AT_PLATFORM(value) \
    (THREAD_GET_AT_PLATFORM () = (value))

/* l_tls_offset == 0 is perfectly valid on PPC, so we have to use some
   different value to mean unset l_tls_offset.  */
# define NO_TLS_OFFSET		-1

/* 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)

#endif /* __ASSEMBLER__ */

#endif	/* tls.h */
Commit	Line	Data
f3c13160	1	/* Definition for thread-local data handling. NPTL/PowerPC version.
2b778ceb	2	Copyright (C) 2003-2021 Free Software Foundation, Inc.
f3c13160 RM	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
59ba27a6	16	License along with the GNU C Library; if not, see
5a82c748	17	<https://www.gnu.org/licenses/>. */
f3c13160 RM	18
	19	#ifndef _TLS_H
	20	#define _TLS_H 1
	21
	22	# include <dl-sysdep.h>
	23
	24	#ifndef __ASSEMBLER__
9dcafc55	25	# include <stdbool.h>
f3c13160 RM	26	# include <stddef.h>
f3c13160 RM	27	# include <stdint.h>
aca1daef	28	# include <dl-dtv.h>
f3c13160 RM	29
	30	#else /* __ASSEMBLER__ */
	31	# include <tcb-offsets.h>
1e0a7fd0 MC	32	# define __ASSEMBLY__
1e0a7fd0 MC	33	# include <asm/ptrace.h>
f3c13160 RM	34	#endif /* __ASSEMBLER__ */
f3c13160 RM	35
1e0a7fd0 MC	36	#ifndef __powerpc64__
	37	/* Register r2 (tp) is reserved by the ABI as "thread pointer". */
	38	# define PT_THREAD_POINTER PT_R2
	39	# ifndef __ASSEMBLER__
	40	register void *__thread_register __asm__ ("r2");
	41	# endif
	42
	43	#else /* __powerpc64__ */
	44	/* Register r13 (tp) is reserved by the ABI as "thread pointer". */
	45	# define PT_THREAD_POINTER PT_R13
	46	# ifndef __ASSEMBLER__
	47	register void *__thread_register __asm__ ("r13");
	48	# endif
	49	#endif /* __powerpc64__ */
f3c13160	50
f3c13160 RM	51	#ifndef __ASSEMBLER__
f3c13160 RM	52
67385a01 CES	53	# include <hwcapinfo.h>
67385a01 CES	54
f3c13160 RM	55	/* Get system call information. */
	56	# include <sysdep.h>
	57
	58	/* The TP points to the start of the thread blocks. */
	59	# define TLS_DTV_AT_TP 1
498a2233	60	# define TLS_TCB_AT_TP 0
f3c13160	61
94659495 RM	62	/* We use the multiple_threads field in the pthread struct */
94659495 RM	63	#define TLS_MULTIPLE_THREADS_IN_TCB 1
f3c13160 RM	64
	65	/* Get the thread descriptor definition. */
	66	# include <nptl/descr.h>
	67
498a2233	68
35f1e827	69	/* The stack_guard is accessed directly by GCC -fstack-protector code,
991fa82b UD	70	so it is a part of public ABI. The dtv and pointer_guard fields
991fa82b UD	71	are private. */
f3c13160 RM	72	typedef struct
f3c13160 RM	73	{
67385a01 CES	74	/* Reservation for HWCAP data. To be accessed by GCC in
	75	__builtin_cpu_supports(), so it is a part of public ABI. */
	76	uint64_t hwcap;
	77	/* Reservation for AT_PLATFORM data. To be accessed by GCC in
	78	__builtin_cpu_is(), so it is a part of public ABI. Since there
	79	are different ABIs for 32 and 64 bit, we put this field in a
	80	previously empty padding space for powerpc64. */
	81	#ifndef __powerpc64__
	82	/* Padding to maintain alignment. */
	83	uint32_t padding;
	84	uint32_t at_platform;
	85	#endif
f0458cf4	86	uint32_t __unused;
67385a01 CES	87	/* Reservation for AT_PLATFORM data - powerpc64. */
	88	#ifdef __powerpc64__
	89	uint32_t at_platform;
	90	#endif
5b9bf191 AZ	91	/* Reservation for Dynamic System Optimizer ABI. */
	92	uintptr_t dso_slot2;
	93	uintptr_t dso_slot1;
	94	/* Reservation for tar register (ISA 2.07). */
	95	uintptr_t tar_save;
b525166b UW	96	/* GCC split stack support. */
b525166b UW	97	void *__private_ss;
e55a9b25 AZ	98	/* Reservation for the Event-Based Branching ABI. */
	99	uintptr_t ebb_handler;
	100	uintptr_t ebb_ctx_pointer;
	101	uintptr_t ebb_reserved1;
	102	uintptr_t ebb_reserved2;
00c2b3b9	103	uintptr_t pointer_guard;
35f1e827	104	uintptr_t stack_guard;
f3c13160 RM	105	dtv_t *dtv;
	106	} tcbhead_t;
	107
	108	/* This is the size of the initial TCB. */
299601a1	109	# define TLS_INIT_TCB_SIZE 0
f3c13160	110
f3c13160	111	/* This is the size of the TCB. */
299601a1	112	# define TLS_TCB_SIZE 0
f3c13160	113
f3c13160	114	/* This is the size we need before TCB. */
468777e1 UD	115	# define TLS_PRE_TCB_SIZE \
468777e1 UD	116	(sizeof (struct pthread) \
627f5ede FW	117	+ ((sizeof (tcbhead_t) + __alignof (struct pthread) - 1) \
627f5ede FW	118	& ~(__alignof (struct pthread) - 1)))
f3c13160	119
f3c13160 RM	120	/* The following assumes that TP (R2 or R13) points to the end of the
f3c13160 RM	121	TCB + 0x7000 (per the ABI). This implies that TCB address is
299601a1	122	TP - 0x7000. As we define TLS_DTV_AT_TP we can
f3c13160 RM	123	assume that the pthread struct is allocated immediately ahead of the
f3c13160 RM	124	TCB. This implies that the pthread_descr address is
299601a1	125	TP - (TLS_PRE_TCB_SIZE + 0x7000). */
f3c13160 RM	126	# define TLS_TCB_OFFSET 0x7000
	127
	128	/* Install the dtv pointer. The pointer passed is to the element with
	129	index -1 which contain the length. */
	130	# define INSTALL_DTV(tcbp, dtvp) \
299601a1	131	((tcbhead_t *) (tcbp))[-1].dtv = dtvp + 1
f3c13160 RM	132
	133	/* Install new dtv for current thread. */
	134	# define INSTALL_NEW_DTV(dtv) (THREAD_DTV() = (dtv))
	135
	136	/* Return dtv of given thread descriptor. */
299601a1	137	# define GET_DTV(tcbp) (((tcbhead_t *) (tcbp))[-1].dtv)
f3c13160 RM	138
	139	/* Code to initially initialize the thread pointer. This might need
	140	special attention since 'errno' is not yet available and if the
	141	operation can cause a failure 'errno' must not be touched. */
774f9285	142	# define TLS_INIT_TP(tcbp) \
56cf2763 AZ	143	({ \
56cf2763 AZ	144	__thread_register = (void *) (tcbp) + TLS_TCB_OFFSET; \
67385a01 CES	145	THREAD_SET_HWCAP (__tcb_hwcap); \
67385a01 CES	146	THREAD_SET_AT_PLATFORM (__tcb_platform); \
56cf2763 AZ	147	NULL; \
56cf2763 AZ	148	})
f3c13160	149
f12b4814 RM	150	/* Value passed to 'clone' for initialization of the thread register. */
f12b4814 RM	151	# define TLS_DEFINE_INIT_TP(tp, pd) \
56cf2763	152	void tp = (void ) (pd) + TLS_TCB_OFFSET + TLS_PRE_TCB_SIZE; \
67385a01 CES	153	(((tcbhead_t ) ((char ) tp - TLS_TCB_OFFSET))[-1].hwcap) = \
	154	THREAD_GET_HWCAP (); \
	155	(((tcbhead_t ) ((char ) tp - TLS_TCB_OFFSET))[-1].at_platform) = \
	156	THREAD_GET_AT_PLATFORM ();
f12b4814	157
f3c13160 RM	158	/* Return the address of the dtv for the current thread. */
f3c13160 RM	159	# define THREAD_DTV() \
35f1e827	160	(((tcbhead_t *) (__thread_register - TLS_TCB_OFFSET))[-1].dtv)
f3c13160 RM	161
	162	/* Return the thread descriptor for the current thread. */
	163	# define THREAD_SELF \
	164	((struct pthread *) (__thread_register \
299601a1	165	- TLS_TCB_OFFSET - TLS_PRE_TCB_SIZE))
f3c13160	166
7f08f55a RM	167	/* Magic for libthread_db to know how to do THREAD_SELF. */
7f08f55a RM	168	# define DB_THREAD_SELF \
35f1e827	169	REGISTER (32, 32, PT_THREAD_POINTER * 4, \
7f08f55a	170	- TLS_TCB_OFFSET - TLS_PRE_TCB_SIZE) \
35f1e827	171	REGISTER (64, 64, PT_THREAD_POINTER * 8, \
7f08f55a RM	172	- TLS_TCB_OFFSET - TLS_PRE_TCB_SIZE)
7f08f55a RM	173
ce2248ab	174	# include <tcb-access.h>
f3c13160	175
35f1e827 UD	176	/* Set the stack guard field in TCB head. */
	177	# define THREAD_SET_STACK_GUARD(value) \
	178	(((tcbhead_t ) ((char ) __thread_register \
	179	- TLS_TCB_OFFSET))[-1].stack_guard = (value))
	180	# define THREAD_COPY_STACK_GUARD(descr) \
	181	(((tcbhead_t ) ((char ) (descr) \
	182	+ TLS_PRE_TCB_SIZE))[-1].stack_guard \
	183	= ((tcbhead_t ) ((char ) __thread_register \
	184	- TLS_TCB_OFFSET))[-1].stack_guard)
	185
00c2b3b9 UD	186	/* Set the stack guard field in TCB head. */
	187	# define THREAD_GET_POINTER_GUARD() \
	188	(((tcbhead_t ) ((char ) __thread_register \
	189	- TLS_TCB_OFFSET))[-1].pointer_guard)
	190	# define THREAD_SET_POINTER_GUARD(value) \
	191	(THREAD_GET_POINTER_GUARD () = (value))
	192	# define THREAD_COPY_POINTER_GUARD(descr) \
	193	(((tcbhead_t ) ((char ) (descr) \
	194	+ TLS_PRE_TCB_SIZE))[-1].pointer_guard \
	195	= THREAD_GET_POINTER_GUARD())
56cf2763	196
67385a01 CES	197	/* hwcap field in TCB head. */
	198	# define THREAD_GET_HWCAP() \
	199	(((tcbhead_t ) ((char ) __thread_register \
	200	- TLS_TCB_OFFSET))[-1].hwcap)
	201	# define THREAD_SET_HWCAP(value) \
	202	(THREAD_GET_HWCAP () = (value))
	203
	204	/* at_platform field in TCB head. */
	205	# define THREAD_GET_AT_PLATFORM() \
	206	(((tcbhead_t ) ((char ) __thread_register \
	207	- TLS_TCB_OFFSET))[-1].at_platform)
	208	# define THREAD_SET_AT_PLATFORM(value) \
	209	(THREAD_GET_AT_PLATFORM () = (value))
00c2b3b9	210
299601a1 UD	211	/* l_tls_offset == 0 is perfectly valid on PPC, so we have to use some
	212	different value to mean unset l_tls_offset. */
	213	# define NO_TLS_OFFSET -1
	214
991fa82b	215	/* Get and set the global scope generation counter in struct pthread. */
0a54ab53 UD	216	#define THREAD_GSCOPE_FLAG_UNUSED 0
	217	#define THREAD_GSCOPE_FLAG_USED 1
	218	#define THREAD_GSCOPE_FLAG_WAIT 2
0a54ab53 UD	219	#define THREAD_GSCOPE_RESET_FLAG() \
	220	do \
	221	{ int __res \
991fa82b	222	= atomic_exchange_rel (&THREAD_SELF->header.gscope_flag, \
0a54ab53 UD	223	THREAD_GSCOPE_FLAG_UNUSED); \
0a54ab53 UD	224	if (__res == THREAD_GSCOPE_FLAG_WAIT) \
085a4412	225	lll_futex_wake (&THREAD_SELF->header.gscope_flag, 1, LLL_PRIVATE); \
0a54ab53 UD	226	} \
	227	while (0)
	228	#define THREAD_GSCOPE_SET_FLAG() \
991fa82b UD	229	do \
	230	{ \
	231	THREAD_SELF->header.gscope_flag = THREAD_GSCOPE_FLAG_USED; \
	232	atomic_write_barrier (); \
	233	} \
	234	while (0)
0a54ab53	235
f3c13160 RM	236	#endif /* __ASSEMBLER__ */
	237
	238	#endif /* tls.h */