[thirdparty/glibc.git] / sysdeps / unix / sysdep.h

/* Copyright (C) 1991-2024 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/>.  */

#include <sysdeps/generic/sysdep.h>
#include <single-thread.h>
#include <sys/syscall.h>
#define	HAVE_SYSCALLS

/* Note that using a `PASTE' macro loses.  */
#define	SYSCALL__(name, args)	PSEUDO (__##name, name, args)
#define	SYSCALL(name, args)	PSEUDO (name, name, args)

#define __SYSCALL_CONCAT_X(a,b)     a##b
#define __SYSCALL_CONCAT(a,b)       __SYSCALL_CONCAT_X (a, b)


#define __INTERNAL_SYSCALL0(name) \
  INTERNAL_SYSCALL (name, 0)
#define __INTERNAL_SYSCALL1(name, a1) \
  INTERNAL_SYSCALL (name, 1, a1)
#define __INTERNAL_SYSCALL2(name, a1, a2) \
  INTERNAL_SYSCALL (name, 2, a1, a2)
#define __INTERNAL_SYSCALL3(name, a1, a2, a3) \
  INTERNAL_SYSCALL (name, 3, a1, a2, a3)
#define __INTERNAL_SYSCALL4(name, a1, a2, a3, a4) \
  INTERNAL_SYSCALL (name, 4, a1, a2, a3, a4)
#define __INTERNAL_SYSCALL5(name, a1, a2, a3, a4, a5) \
  INTERNAL_SYSCALL (name, 5, a1, a2, a3, a4, a5)
#define __INTERNAL_SYSCALL6(name, a1, a2, a3, a4, a5, a6) \
  INTERNAL_SYSCALL (name, 6, a1, a2, a3, a4, a5, a6)
#define __INTERNAL_SYSCALL7(name, a1, a2, a3, a4, a5, a6, a7) \
  INTERNAL_SYSCALL (name, 7, a1, a2, a3, a4, a5, a6, a7)

#define __INTERNAL_SYSCALL_NARGS_X(a,b,c,d,e,f,g,h,n,...) n
#define __INTERNAL_SYSCALL_NARGS(...) \
  __INTERNAL_SYSCALL_NARGS_X (__VA_ARGS__,7,6,5,4,3,2,1,0,)
#define __INTERNAL_SYSCALL_DISP(b,...) \
  __SYSCALL_CONCAT (b,__INTERNAL_SYSCALL_NARGS(__VA_ARGS__))(__VA_ARGS__)

/* Issue a syscall defined by syscall number plus any other argument required.
   It is similar to INTERNAL_SYSCALL macro, but without the need to pass the
   expected argument number as second parameter.  */
#define INTERNAL_SYSCALL_CALL(...) \
  __INTERNAL_SYSCALL_DISP (__INTERNAL_SYSCALL, __VA_ARGS__)

#define __INTERNAL_SYSCALL_NCS0(name) \
  INTERNAL_SYSCALL_NCS (name, 0)
#define __INTERNAL_SYSCALL_NCS1(name, a1) \
  INTERNAL_SYSCALL_NCS (name, 1, a1)
#define __INTERNAL_SYSCALL_NCS2(name, a1, a2) \
  INTERNAL_SYSCALL_NCS (name, 2, a1, a2)
#define __INTERNAL_SYSCALL_NCS3(name, a1, a2, a3) \
  INTERNAL_SYSCALL_NCS (name, 3, a1, a2, a3)
#define __INTERNAL_SYSCALL_NCS4(name, a1, a2, a3, a4) \
  INTERNAL_SYSCALL_NCS (name, 4, a1, a2, a3, a4)
#define __INTERNAL_SYSCALL_NCS5(name, a1, a2, a3, a4, a5) \
  INTERNAL_SYSCALL_NCS (name, 5, a1, a2, a3, a4, a5)
#define __INTERNAL_SYSCALL_NCS6(name, a1, a2, a3, a4, a5, a6) \
  INTERNAL_SYSCALL_NCS (name, 6, a1, a2, a3, a4, a5, a6)
#define __INTERNAL_SYSCALL_NCS7(name, a1, a2, a3, a4, a5, a6, a7) \
  INTERNAL_SYSCALL_NCS (name, 7, a1, a2, a3, a4, a5, a6, a7)

#define INTERNAL_SYSCALL_NCS_CALL(...) \
  __INTERNAL_SYSCALL_DISP (__INTERNAL_SYSCALL_NCS, __VA_ARGS__)

#define __INLINE_SYSCALL0(name) \
  INLINE_SYSCALL (name, 0)
#define __INLINE_SYSCALL1(name, a1) \
  INLINE_SYSCALL (name, 1, a1)
#define __INLINE_SYSCALL2(name, a1, a2) \
  INLINE_SYSCALL (name, 2, a1, a2)
#define __INLINE_SYSCALL3(name, a1, a2, a3) \
  INLINE_SYSCALL (name, 3, a1, a2, a3)
#define __INLINE_SYSCALL4(name, a1, a2, a3, a4) \
  INLINE_SYSCALL (name, 4, a1, a2, a3, a4)
#define __INLINE_SYSCALL5(name, a1, a2, a3, a4, a5) \
  INLINE_SYSCALL (name, 5, a1, a2, a3, a4, a5)
#define __INLINE_SYSCALL6(name, a1, a2, a3, a4, a5, a6) \
  INLINE_SYSCALL (name, 6, a1, a2, a3, a4, a5, a6)
#define __INLINE_SYSCALL7(name, a1, a2, a3, a4, a5, a6, a7) \
  INLINE_SYSCALL (name, 7, a1, a2, a3, a4, a5, a6, a7)

#define __INLINE_SYSCALL_NARGS_X(a,b,c,d,e,f,g,h,n,...) n
#define __INLINE_SYSCALL_NARGS(...) \
  __INLINE_SYSCALL_NARGS_X (__VA_ARGS__,7,6,5,4,3,2,1,0,)
#define __INLINE_SYSCALL_DISP(b,...) \
  __SYSCALL_CONCAT (b,__INLINE_SYSCALL_NARGS(__VA_ARGS__))(__VA_ARGS__)

/* Issue a syscall defined by syscall number plus any other argument
   required.  Any error will be handled using arch defined macros and errno
   will be set accordingly.
   It is similar to INLINE_SYSCALL macro, but without the need to pass the
   expected argument number as second parameter.  */
#define INLINE_SYSCALL_CALL(...) \
  __INLINE_SYSCALL_DISP (__INLINE_SYSCALL, __VA_ARGS__)

#if IS_IN (rtld)
/* All cancellation points are compiled out in the dynamic loader.  */
# define NO_SYSCALL_CANCEL_CHECKING 1
#else
# define NO_SYSCALL_CANCEL_CHECKING SINGLE_THREAD_P
#endif

#define SYSCALL_CANCEL(...) \
  ({									     \
    long int sc_ret;							     \
    if (NO_SYSCALL_CANCEL_CHECKING)					     \
      sc_ret = INLINE_SYSCALL_CALL (__VA_ARGS__); 			     \
    else								     \
      {									     \
	int sc_cancel_oldtype = LIBC_CANCEL_ASYNC ();			     \
	sc_ret = INLINE_SYSCALL_CALL (__VA_ARGS__);			     \
        LIBC_CANCEL_RESET (sc_cancel_oldtype);				     \
      }									     \
    sc_ret;								     \
  })

/* Issue a syscall defined by syscall number plus any other argument
   required.  Any error will be returned unmodified (including errno).  */
#define INTERNAL_SYSCALL_CANCEL(...) \
  ({									     \
    long int sc_ret;							     \
    if (NO_SYSCALL_CANCEL_CHECKING) 					     \
      sc_ret = INTERNAL_SYSCALL_CALL (__VA_ARGS__); 			     \
    else								     \
      {									     \
	int sc_cancel_oldtype = LIBC_CANCEL_ASYNC ();			     \
	sc_ret = INTERNAL_SYSCALL_CALL (__VA_ARGS__);			     \
        LIBC_CANCEL_RESET (sc_cancel_oldtype);				     \
      }									     \
    sc_ret;								     \
  })

/* Machine-dependent sysdep.h files are expected to define the macro
   PSEUDO (function_name, syscall_name) to emit assembly code to define the
   C-callable function FUNCTION_NAME to do system call SYSCALL_NAME.
   r0 and r1 are the system call outputs.  MOVE(x, y) should be defined as
   an instruction such that "MOVE(r1, r0)" works.  ret should be defined
   as the return instruction.  */

#ifndef SYS_ify
#define SYS_ify(syscall_name) SYS_##syscall_name
#endif

/* Terminate a system call named SYM.  This is used on some platforms
   to generate correct debugging information.  */
#ifndef PSEUDO_END
#define PSEUDO_END(sym)
#endif
#ifndef PSEUDO_END_NOERRNO
#define PSEUDO_END_NOERRNO(sym)	PSEUDO_END(sym)
#endif
#ifndef PSEUDO_END_ERRVAL
#define PSEUDO_END_ERRVAL(sym)	PSEUDO_END(sym)
#endif

/* Wrappers around system calls should normally inline the system call code.
   But sometimes it is not possible or implemented and we use this code.  */
#ifndef INLINE_SYSCALL
#define INLINE_SYSCALL(name, nr, args...) __syscall_##name (args)
#endif
Commit	Line	Data
dff8da6b	1	/* Copyright (C) 1991-2024 Free Software Foundation, Inc.
b5791037	2	This file is part of the GNU C Library.
28f540f4	3
b5791037	4	The GNU C Library is free software; you can redistribute it and/or
41bdb6e2 AJ	5	modify it under the terms of the GNU Lesser General Public
	6	License as published by the Free Software Foundation; either
	7	version 2.1 of the License, or (at your option) any later version.
28f540f4	8
b5791037 UD	9	The GNU C Library is distributed in the hope that it will be useful,
	10	but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41bdb6e2	12	Lesser General Public License for more details.
28f540f4	13
41bdb6e2	14	You should have received a copy of the GNU Lesser General Public
59ba27a6	15	License along with the GNU C Library; if not, see
5a82c748	16	<https://www.gnu.org/licenses/>. */
28f540f4	17
e75154a6	18	#include <sysdeps/generic/sysdep.h>
fdb8a0be	19	#include <single-thread.h>
df4ef2ab	20	#include <sys/syscall.h>
28f540f4 RM	21	#define HAVE_SYSCALLS
	22
	23	/* Note that using a `PASTE' macro loses. */
28f540f4	24	#define SYSCALL__(name, args) PSEUDO (__##name, name, args)
28f540f4 RM	25	#define SYSCALL(name, args) PSEUDO (name, name, args)
28f540f4 RM	26
e33a23fb AZ	27	#define __SYSCALL_CONCAT_X(a,b) a##b
	28	#define __SYSCALL_CONCAT(a,b) __SYSCALL_CONCAT_X (a, b)
	29
	30
bc2eb932 AZ	31	#define __INTERNAL_SYSCALL0(name) \
	32	INTERNAL_SYSCALL (name, 0)
	33	#define __INTERNAL_SYSCALL1(name, a1) \
	34	INTERNAL_SYSCALL (name, 1, a1)
	35	#define __INTERNAL_SYSCALL2(name, a1, a2) \
	36	INTERNAL_SYSCALL (name, 2, a1, a2)
	37	#define __INTERNAL_SYSCALL3(name, a1, a2, a3) \
	38	INTERNAL_SYSCALL (name, 3, a1, a2, a3)
	39	#define __INTERNAL_SYSCALL4(name, a1, a2, a3, a4) \
	40	INTERNAL_SYSCALL (name, 4, a1, a2, a3, a4)
	41	#define __INTERNAL_SYSCALL5(name, a1, a2, a3, a4, a5) \
	42	INTERNAL_SYSCALL (name, 5, a1, a2, a3, a4, a5)
	43	#define __INTERNAL_SYSCALL6(name, a1, a2, a3, a4, a5, a6) \
	44	INTERNAL_SYSCALL (name, 6, a1, a2, a3, a4, a5, a6)
	45	#define __INTERNAL_SYSCALL7(name, a1, a2, a3, a4, a5, a6, a7) \
	46	INTERNAL_SYSCALL (name, 7, a1, a2, a3, a4, a5, a6, a7)
e33a23fb	47
bc2eb932	48	#define __INTERNAL_SYSCALL_NARGS_X(a,b,c,d,e,f,g,h,n,...) n
e33a23fb AZ	49	#define __INTERNAL_SYSCALL_NARGS(...) \
	50	__INTERNAL_SYSCALL_NARGS_X (__VA_ARGS__,7,6,5,4,3,2,1,0,)
	51	#define __INTERNAL_SYSCALL_DISP(b,...) \
	52	__SYSCALL_CONCAT (b,__INTERNAL_SYSCALL_NARGS(__VA_ARGS__))(__VA_ARGS__)
	53
	54	/* Issue a syscall defined by syscall number plus any other argument required.
	55	It is similar to INTERNAL_SYSCALL macro, but without the need to pass the
	56	expected argument number as second parameter. */
	57	#define INTERNAL_SYSCALL_CALL(...) \
	58	__INTERNAL_SYSCALL_DISP (__INTERNAL_SYSCALL, __VA_ARGS__)
	59
00baddbb AZ	60	#define __INTERNAL_SYSCALL_NCS0(name) \
	61	INTERNAL_SYSCALL_NCS (name, 0)
	62	#define __INTERNAL_SYSCALL_NCS1(name, a1) \
	63	INTERNAL_SYSCALL_NCS (name, 1, a1)
	64	#define __INTERNAL_SYSCALL_NCS2(name, a1, a2) \
	65	INTERNAL_SYSCALL_NCS (name, 2, a1, a2)
	66	#define __INTERNAL_SYSCALL_NCS3(name, a1, a2, a3) \
	67	INTERNAL_SYSCALL_NCS (name, 3, a1, a2, a3)
	68	#define __INTERNAL_SYSCALL_NCS4(name, a1, a2, a3, a4) \
	69	INTERNAL_SYSCALL_NCS (name, 4, a1, a2, a3, a4)
	70	#define __INTERNAL_SYSCALL_NCS5(name, a1, a2, a3, a4, a5) \
	71	INTERNAL_SYSCALL_NCS (name, 5, a1, a2, a3, a4, a5)
	72	#define __INTERNAL_SYSCALL_NCS6(name, a1, a2, a3, a4, a5, a6) \
	73	INTERNAL_SYSCALL_NCS (name, 6, a1, a2, a3, a4, a5, a6)
	74	#define __INTERNAL_SYSCALL_NCS7(name, a1, a2, a3, a4, a5, a6, a7) \
	75	INTERNAL_SYSCALL_NCS (name, 7, a1, a2, a3, a4, a5, a6, a7)
	76
	77	#define INTERNAL_SYSCALL_NCS_CALL(...) \
	78	__INTERNAL_SYSCALL_DISP (__INTERNAL_SYSCALL_NCS, __VA_ARGS__)
	79
e33a23fb	80	#define __INLINE_SYSCALL0(name) \
fc48bfbc	81	INLINE_SYSCALL (name, 0)
e33a23fb	82	#define __INLINE_SYSCALL1(name, a1) \
fc48bfbc	83	INLINE_SYSCALL (name, 1, a1)
e33a23fb	84	#define __INLINE_SYSCALL2(name, a1, a2) \
fc48bfbc	85	INLINE_SYSCALL (name, 2, a1, a2)
e33a23fb	86	#define __INLINE_SYSCALL3(name, a1, a2, a3) \
fc48bfbc	87	INLINE_SYSCALL (name, 3, a1, a2, a3)
e33a23fb	88	#define __INLINE_SYSCALL4(name, a1, a2, a3, a4) \
fc48bfbc	89	INLINE_SYSCALL (name, 4, a1, a2, a3, a4)
e33a23fb	90	#define __INLINE_SYSCALL5(name, a1, a2, a3, a4, a5) \
fc48bfbc	91	INLINE_SYSCALL (name, 5, a1, a2, a3, a4, a5)
e33a23fb	92	#define __INLINE_SYSCALL6(name, a1, a2, a3, a4, a5, a6) \
fc48bfbc	93	INLINE_SYSCALL (name, 6, a1, a2, a3, a4, a5, a6)
e33a23fb	94	#define __INLINE_SYSCALL7(name, a1, a2, a3, a4, a5, a6, a7) \
fc48bfbc AZ	95	INLINE_SYSCALL (name, 7, a1, a2, a3, a4, a5, a6, a7)
fc48bfbc AZ	96
e33a23fb AZ	97	#define __INLINE_SYSCALL_NARGS_X(a,b,c,d,e,f,g,h,n,...) n
	98	#define __INLINE_SYSCALL_NARGS(...) \
	99	__INLINE_SYSCALL_NARGS_X (__VA_ARGS__,7,6,5,4,3,2,1,0,)
	100	#define __INLINE_SYSCALL_DISP(b,...) \
	101	__SYSCALL_CONCAT (b,__INLINE_SYSCALL_NARGS(__VA_ARGS__))(__VA_ARGS__)
fc48bfbc	102
e33a23fb AZ	103	/* Issue a syscall defined by syscall number plus any other argument
	104	required. Any error will be handled using arch defined macros and errno
	105	will be set accordingly.
	106	It is similar to INLINE_SYSCALL macro, but without the need to pass the
	107	expected argument number as second parameter. */
	108	#define INLINE_SYSCALL_CALL(...) \
	109	__INLINE_SYSCALL_DISP (__INLINE_SYSCALL, __VA_ARGS__)
c6bb095e	110
1c75f896 FW	111	#if IS_IN (rtld)
	112	/* All cancellation points are compiled out in the dynamic loader. */
	113	# define NO_SYSCALL_CANCEL_CHECKING 1
	114	#else
	115	# define NO_SYSCALL_CANCEL_CHECKING SINGLE_THREAD_P
	116	#endif
	117
fc48bfbc	118	#define SYSCALL_CANCEL(...) \
c6bb095e AZ	119	({ \
c6bb095e AZ	120	long int sc_ret; \
1c75f896	121	if (NO_SYSCALL_CANCEL_CHECKING) \
e33a23fb	122	sc_ret = INLINE_SYSCALL_CALL (__VA_ARGS__); \
c6bb095e AZ	123	else \
	124	{ \
	125	int sc_cancel_oldtype = LIBC_CANCEL_ASYNC (); \
e33a23fb	126	sc_ret = INLINE_SYSCALL_CALL (__VA_ARGS__); \
c6bb095e AZ	127	LIBC_CANCEL_RESET (sc_cancel_oldtype); \
	128	} \
	129	sc_ret; \
	130	})
	131
ce7528f6 AZ	132	/* Issue a syscall defined by syscall number plus any other argument
	133	required. Any error will be returned unmodified (including errno). */
	134	#define INTERNAL_SYSCALL_CANCEL(...) \
	135	({ \
	136	long int sc_ret; \
1c75f896	137	if (NO_SYSCALL_CANCEL_CHECKING) \
ce7528f6 AZ	138	sc_ret = INTERNAL_SYSCALL_CALL (__VA_ARGS__); \
	139	else \
	140	{ \
	141	int sc_cancel_oldtype = LIBC_CANCEL_ASYNC (); \
	142	sc_ret = INTERNAL_SYSCALL_CALL (__VA_ARGS__); \
	143	LIBC_CANCEL_RESET (sc_cancel_oldtype); \
	144	} \
	145	sc_ret; \
	146	})
	147
28f540f4 RM	148	/* Machine-dependent sysdep.h files are expected to define the macro
	149	PSEUDO (function_name, syscall_name) to emit assembly code to define the
	150	C-callable function FUNCTION_NAME to do system call SYSCALL_NAME.
	151	r0 and r1 are the system call outputs. MOVE(x, y) should be defined as
	152	an instruction such that "MOVE(r1, r0)" works. ret should be defined
	153	as the return instruction. */
	154
c6bb095e	155	#ifndef SYS_ify
28f540f4	156	#define SYS_ify(syscall_name) SYS_##syscall_name
c6bb095e	157	#endif
84724245	158
a1470b6f RM	159	/* Terminate a system call named SYM. This is used on some platforms
a1470b6f RM	160	to generate correct debugging information. */
b5791037	161	#ifndef PSEUDO_END
a1470b6f	162	#define PSEUDO_END(sym)
b5791037	163	#endif
da058e45 UD	164	#ifndef PSEUDO_END_NOERRNO
da058e45 UD	165	#define PSEUDO_END_NOERRNO(sym) PSEUDO_END(sym)
9eb88290	166	#endif
137ffcdc UD	167	#ifndef PSEUDO_END_ERRVAL
	168	#define PSEUDO_END_ERRVAL(sym) PSEUDO_END(sym)
	169	#endif
0dee6738 UD	170
	171	/* Wrappers around system calls should normally inline the system call code.
	172	But sometimes it is not possible or implemented and we use this code. */
c6bb095e	173	#ifndef INLINE_SYSCALL
0dee6738	174	#define INLINE_SYSCALL(name, nr, args...) __syscall_##name (args)
c6bb095e	175	#endif