2002-10-16 Jakub Jelinek <jakub@redhat.com>
[kopensolaris-gnu/glibc.git] / sysdeps / unix / sysv / linux / x86_64 / sysdep.h
1 /* Copyright (C) 2001,02 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
4    The GNU C Library is free software; you can redistribute it and/or
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.
8
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
12    Lesser General Public License for more details.
13
14    You should have received a copy of the GNU Lesser General Public
15    License along with the GNU C Library; if not, write to the Free
16    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
17    02111-1307 USA.  */
18
19 #ifndef _LINUX_X86_64_SYSDEP_H
20 #define _LINUX_X86_64_SYSDEP_H 1
21
22 /* There is some commonality.  */
23 #include <sysdeps/unix/x86_64/sysdep.h>
24 #include <bp-sym.h>
25 #include <bp-asm.h>
26 #include <tls.h>
27
28 #ifdef IS_IN_rtld
29 # include <dl-sysdep.h>         /* Defines RTLD_PRIVATE_ERRNO.  */
30 #endif
31
32 /* For Linux we can use the system call table in the header file
33         /usr/include/asm/unistd.h
34    of the kernel.  But these symbols do not follow the SYS_* syntax
35    so we have to redefine the `SYS_ify' macro here.  */
36 #undef SYS_ify
37 #define SYS_ify(syscall_name)   __NR_##syscall_name
38
39 /* This is a kludge to make syscalls.list find these under the names
40    pread and pwrite, since some kernel headers define those names
41    and some define the *64 names for the same system calls.  */
42 #if !defined __NR_pread && defined __NR_pread64
43 # define __NR_pread __NR_pread64
44 #endif
45 #if !defined __NR_pwrite && defined __NR_pwrite64
46 # define __NR_pwrite __NR_pwrite64
47 #endif
48
49 #ifdef __ASSEMBLER__
50
51 /* Linux uses a negative return value to indicate syscall errors,
52    unlike most Unices, which use the condition codes' carry flag.
53
54    Since version 2.1 the return value of a system call might be
55    negative even if the call succeeded.  E.g., the `lseek' system call
56    might return a large offset.  Therefore we must not anymore test
57    for < 0, but test for a real error by making sure the value in %eax
58    is a real error number.  Linus said he will make sure the no syscall
59    returns a value in -1 .. -4095 as a valid result so we can savely
60    test with -4095.  */
61
62 /* We don't want the label for the error handle to be global when we define
63    it here.  */
64 #ifdef PIC
65 # define SYSCALL_ERROR_LABEL 0f
66 #else
67 # define SYSCALL_ERROR_LABEL syscall_error
68 #endif
69
70 #undef  PSEUDO
71 #define PSEUDO(name, syscall_name, args)                                      \
72   .text;                                                                      \
73   ENTRY (name)                                                                \
74     DO_CALL (syscall_name, args);                                             \
75     cmpq $-4095, %rax;                                                        \
76     jae SYSCALL_ERROR_LABEL;                                                  \
77   L(pseudo_end):
78
79 #undef  PSEUDO_END
80 #define PSEUDO_END(name)                                                      \
81   SYSCALL_ERROR_HANDLER                                                       \
82   END (name)
83
84 #ifndef PIC
85 #define SYSCALL_ERROR_HANDLER   /* Nothing here; code in sysdep.S is used.  */
86 #elif RTLD_PRIVATE_ERRNO
87 # define SYSCALL_ERROR_HANDLER                  \
88 0:                                              \
89   leaq errno(%rip), %rcx;                       \
90   xorq %rdx, %rdx;                              \
91   subq %rax, %rdx;                              \
92   movl %edx, (%rcx);                            \
93   orq $-1, %rax;                                \
94   jmp L(pseudo_end);
95 #elif USE___THREAD
96 # define SYSCALL_ERROR_HANDLER                  \
97 0:                                              \
98   movq __libc_errno@GOTTPOFF(%rip), %rcx;       \
99   xorq %rdx, %rdx;                              \
100   subq %rax, %rdx;                              \
101   movl %edx, %fs:(%rcx);                        \
102   orq $-1, %rax;                                \
103   jmp L(pseudo_end);
104 #elif defined _LIBC_REENTRANT
105 /* Store (- %rax) into errno through the GOT.
106    Note that errno occupies only 4 bytes.  */
107 # define SYSCALL_ERROR_HANDLER                  \
108 0:                                              \
109   xorq %rdx, %rdx;                              \
110   subq %rax, %rdx;                              \
111   pushq %rdx                                    \
112   PUSH_ERRNO_LOCATION_RETURN;                   \
113   call BP_SYM (__errno_location)@PLT;           \
114   POP_ERRNO_LOCATION_RETURN;                    \
115   popq %rdx;                                    \
116   movl %edx, (%rax);                            \
117   orq $-1, %rax;                                \
118   jmp L(pseudo_end);
119
120 /* A quick note: it is assumed that the call to `__errno_location' does
121    not modify the stack!  */
122 #else /* Not _LIBC_REENTRANT.  */
123 # define SYSCALL_ERROR_HANDLER                  \
124 0:movq errno@GOTPCREL(%RIP), %rcx;              \
125   xorq %rdx, %rdx;                              \
126   subq %rax, %rdx;                              \
127   movl %edx, (%rcx);                            \
128   orq $-1, %rax;                                \
129   jmp L(pseudo_end);
130 #endif  /* PIC */
131
132 /* Linux/x86-64 takes system call arguments in registers:
133
134     Register setup:
135     system call number  rax
136     arg 1               rdi
137     arg 2               rsi
138     arg 3               rdx
139     arg 4               rcx
140     arg 5               r8
141     arg 6               r9
142
143     return address from
144     syscall             rcx
145     additionally clobered: r12-r15,rbx,rbp
146     eflags from syscall r11
147
148     The compiler is going to form a call by coming here, through PSEUDO, with arguments:
149
150         syscall number  in the DO_CALL macro
151         arg 1           rdi
152         arg 2           rsi
153         arg 3           rdx
154         arg 4           r10
155         arg 5           r8
156         arg 6           r9
157
158      We have to take care that the stack is alignedto 16 bytes.  When
159      called the stack is not aligned since the return address has just
160      been pushed.
161
162      Syscalls of more than 6 arguments are not supported.  */
163
164 #undef  DO_CALL
165 #define DO_CALL(syscall_name, args)             \
166     DOARGS_##args                               \
167     movq $SYS_ify (syscall_name), %rax;         \
168     syscall;
169
170 #define DOARGS_0 /* nothing */
171 #define DOARGS_1 /* nothing */
172 #define DOARGS_2 /* nothing */
173 #define DOARGS_3 /* nothing */
174 #define DOARGS_4 movq %rcx, %r10;
175 #define DOARGS_5 DOARGS_4
176 #define DOARGS_6 DOARGS_5
177
178 #else   /* !__ASSEMBLER__ */
179 /* Define a macro which expands inline into the wrapper code for a system
180    call.  */
181 #undef INLINE_SYSCALL
182 #define INLINE_SYSCALL(name, nr, args...) \
183   ({                                                                          \
184     unsigned long resultvar;                                                  \
185     LOAD_ARGS_##nr (args)                                                     \
186     asm volatile (                                                            \
187     "movq %1, %%rax\n\t"                                                      \
188     "syscall\n\t"                                                             \
189     : "=a" (resultvar)                                                        \
190     : "i" (__NR_##name) ASM_ARGS_##nr : "memory", "cc", "r11", "cx");         \
191     if (resultvar >= (unsigned long) -4095)                                   \
192       {                                                                       \
193         __set_errno (-resultvar);                                             \
194         resultvar = (unsigned long) -1;                                       \
195       }                                                                       \
196     (long) resultvar; })
197
198 #define LOAD_ARGS_0()
199 #define ASM_ARGS_0
200
201 #define LOAD_ARGS_1(a1)                                 \
202   register long int _a1 asm ("rdi") = (long) (a1);      \
203   LOAD_ARGS_0 ()
204 #define ASM_ARGS_1      ASM_ARGS_0, "r" (_a1)
205
206 #define LOAD_ARGS_2(a1, a2)                             \
207   register long int _a2 asm ("rsi") = (long) (a2);      \
208   LOAD_ARGS_1 (a1)
209 #define ASM_ARGS_2      ASM_ARGS_1, "r" (_a2)
210
211 #define LOAD_ARGS_3(a1, a2, a3)                         \
212   register long int _a3 asm ("rdx") = (long) (a3);      \
213   LOAD_ARGS_2 (a1, a2)
214 #define ASM_ARGS_3      ASM_ARGS_2, "r" (_a3)
215
216 #define LOAD_ARGS_4(a1, a2, a3, a4)                     \
217   register long int _a4 asm ("r10") = (long) (a4);      \
218   LOAD_ARGS_3 (a1, a2, a3)
219 #define ASM_ARGS_4      ASM_ARGS_3, "r" (_a4)
220
221 #define LOAD_ARGS_5(a1, a2, a3, a4, a5)                 \
222   register long int _a5 asm ("r8") = (long) (a5);       \
223   LOAD_ARGS_4 (a1, a2, a3, a4)
224 #define ASM_ARGS_5      ASM_ARGS_4, "r" (_a5)
225
226 #define LOAD_ARGS_6(a1, a2, a3, a4, a5, a6)             \
227   register long int _a6 asm ("r9") = (long) (a6);       \
228   LOAD_ARGS_5 (a1, a2, a3, a4, a5)
229 #define ASM_ARGS_6      ASM_ARGS_5, "r" (_a6)
230
231 #endif  /* __ASSEMBLER__ */
232
233 #endif /* linux/x86_64/sysdep.h */