[PATCH] syscall.2: add arm64 and mips

[PATCH] syscall.2: add arm64 and mips

[Kees Cook]

Added mips to tables. Extra column added for boolean error register, since
both ia64 and mips use this convention. Added explicit non-register argument
passing note for mips/o32.

Added arm64 to tables.

Signed-off-by: Kees Cook <keescook-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
---
 man2/syscall.2 | 47 +++++++++++++++++++++++++++--------------------
 1 file changed, 27 insertions(+), 20 deletions(-)

diff --git a/man2/syscall.2 b/man2/syscall.2
index 3e76e56..05bf042 100644
--- a/man2/syscall.2
+++ b/man2/syscall.2
@@ -36,6 +36,8 @@
 .\"
 .\" 2002-03-20  Christoph Hellwig <hch-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
 .\"	- adopted for Linux
+.\" 2015-01-17, Kees Cook <keescook-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
+.\"	Added mips and arm64.
 .\"
 .TH SYSCALL 2 2014-12-31 "Linux" "Linux Programmer's Manual"
 .SH NAME
@@ -148,29 +150,29 @@ The first table lists the instruction used to transition to kernel mode,
 so you might have to refer to
 .BR vdso (7)),
 the register used to indicate the system call number,
-and the register used to return the system call result.
+the register used to return the system call result,
+and the register used to indicate simple boolean failure of
+the system call.
 .if t \{\
 .ft CW
 \}
 .TS
-l l1 l l1 l.
-arch/ABI	instruction	syscall #	retval	Notes
+l l l l l l.
+arch/ABI	instruction	syscall #	retval	bool error	Notes
 _
-arm/OABI	swi NR	-	a1	NR is syscall #
-arm/EABI	swi 0x0	r7	r0
-blackfin	excpt 0x0	P0	R0
-i386	int $0x80	eax	eax
-ia64	break 0x100000	r15	r10/r8	T{
-bool error/
-.br
-errno value
-T}
-parisc	ble 0x100(%sr2, %r0)	r20	r28
-s390	svc 0	r1	r2	See below
-s390x	svc 0	r1	r2	See below
-sparc/32	t 0x10	g1	o0
-sparc/64	t 0x6d	g1	o0
-x86_64	syscall	rax	rax
+arm/OABI	swi NR	-	a1	-	NR is syscall #
+arm/EABI	swi 0x0	r7	r0	-
+arm64	svc #0	x8	x0	-
+blackfin	excpt 0x0	P0	R0	-
+i386	int $0x80	eax	eax	-
+ia64	break 0x100000	r15	r8	r10
+mips	syscall	v0	v0	a3
+parisc	ble 0x100(%sr2, %r0)	r20	r28	-
+s390	svc 0	r1	r2	-	See below
+s390x	svc 0	r1	r2	-	See below
+sparc/32	t 0x10	g1	o0	-
+sparc/64	t 0x6d	g1	o0	-
+x86_64	syscall	rax	rax	-
 .TE
 .PP
 For s390 and s390x, NR (the system call number)
@@ -185,14 +187,17 @@ The second table shows the registers used to pass the system call arguments.
 .ft CW
 \}
 .TS
-l l l l l l l l.
-arch/ABI	arg1	arg2	arg3	arg4	arg5	arg6	arg7
+l l l l l l l l l.
+arch/ABI	arg1	arg2	arg3	arg4	arg5	arg6	arg7	Notes
 _
 arm/OABI	a1	a2	a3	a4	v1	v2	v3
 arm/EABI	r0	r1	r2	r3	r4	r5	r6
+arm64	x0	x1	x2	x3	x4	x5	-
 blackfin	R0	R1	R2	R3	R4	R5	-
 i386	ebx	ecx	edx	esi	edi	ebp	-
 ia64	out0	out1	out2	out3	out4	out5	-
+mips/o32	a0	a1	a2	a3	-	-	-	See below
+mips/n32,64	a0	a1	a2	a3	a4	a5	-
 parisc	r26	r25	r24	r23	r22	r21	-
 s390	r2	r3	r4	r5	r6	r7	-
 s390x	r2	r3	r4	r5	r6	r7	-
@@ -200,6 +205,8 @@ sparc/32	o0	o1	o2	o3	o4	o5	-
 sparc/64	o0	o1	o2	o3	o4	o5	-
 x86_64	rdi	rsi	rdx	r10	r8	r9	-
 .TE
+.PP
+The mips/o32 syscall convention passes arguments 5 through 8 on the user stack.
 .if t \{\
 .in
 .ft P
-- 
1.9.1


-- 
Kees Cook
Chrome OS Security
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] syscall.2: add arm64 and mips

[Michael Kerrisk (man-pages)]

On 01/18/2015 08:22 AM, Kees Cook wrote:
> Added mips to tables. Extra column added for boolean error register, since
> both ia64 and mips use this convention. Added explicit non-register argument
> passing note for mips/o32.
> 
> Added arm64 to tables.

Thanks Kees. I applied, but then tweaked. Because I do not want the tables 
to render wider than 80 columns, I took the 'bool error' piece into a 
paragraph below the table. See my commit eb83484fc.
Could you double check the result in the Git please.

Cheers,

Michael


> 
> Signed-off-by: Kees Cook <keescook-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
> ---
>  man2/syscall.2 | 47 +++++++++++++++++++++++++++--------------------
>  1 file changed, 27 insertions(+), 20 deletions(-)
> 
> diff --git a/man2/syscall.2 b/man2/syscall.2
> index 3e76e56..05bf042 100644
> --- a/man2/syscall.2
> +++ b/man2/syscall.2
> @@ -36,6 +36,8 @@
>  .\"
>  .\" 2002-03-20  Christoph Hellwig <hch-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
>  .\"	- adopted for Linux
> +.\" 2015-01-17, Kees Cook <keescook-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
> +.\"	Added mips and arm64.
>  .\"
>  .TH SYSCALL 2 2014-12-31 "Linux" "Linux Programmer's Manual"
>  .SH NAME
> @@ -148,29 +150,29 @@ The first table lists the instruction used to transition to kernel mode,
>  so you might have to refer to
>  .BR vdso (7)),
>  the register used to indicate the system call number,
> -and the register used to return the system call result.
> +the register used to return the system call result,
> +and the register used to indicate simple boolean failure of
> +the system call.
>  .if t \{\
>  .ft CW
>  \}
>  .TS
> -l l1 l l1 l.
> -arch/ABI	instruction	syscall #	retval	Notes
> +l l l l l l.
> +arch/ABI	instruction	syscall #	retval	bool error	Notes
>  _
> -arm/OABI	swi NR	-	a1	NR is syscall #
> -arm/EABI	swi 0x0	r7	r0
> -blackfin	excpt 0x0	P0	R0
> -i386	int $0x80	eax	eax
> -ia64	break 0x100000	r15	r10/r8	T{
> -bool error/
> -.br
> -errno value
> -T}
> -parisc	ble 0x100(%sr2, %r0)	r20	r28
> -s390	svc 0	r1	r2	See below
> -s390x	svc 0	r1	r2	See below
> -sparc/32	t 0x10	g1	o0
> -sparc/64	t 0x6d	g1	o0
> -x86_64	syscall	rax	rax
> +arm/OABI	swi NR	-	a1	-	NR is syscall #
> +arm/EABI	swi 0x0	r7	r0	-
> +arm64	svc #0	x8	x0	-
> +blackfin	excpt 0x0	P0	R0	-
> +i386	int $0x80	eax	eax	-
> +ia64	break 0x100000	r15	r8	r10
> +mips	syscall	v0	v0	a3
> +parisc	ble 0x100(%sr2, %r0)	r20	r28	-
> +s390	svc 0	r1	r2	-	See below
> +s390x	svc 0	r1	r2	-	See below
> +sparc/32	t 0x10	g1	o0	-
> +sparc/64	t 0x6d	g1	o0	-
> +x86_64	syscall	rax	rax	-
>  .TE
>  .PP
>  For s390 and s390x, NR (the system call number)
> @@ -185,14 +187,17 @@ The second table shows the registers used to pass the system call arguments.
>  .ft CW
>  \}
>  .TS
> -l l l l l l l l.
> -arch/ABI	arg1	arg2	arg3	arg4	arg5	arg6	arg7
> +l l l l l l l l l.
> +arch/ABI	arg1	arg2	arg3	arg4	arg5	arg6	arg7	Notes
>  _
>  arm/OABI	a1	a2	a3	a4	v1	v2	v3
>  arm/EABI	r0	r1	r2	r3	r4	r5	r6
> +arm64	x0	x1	x2	x3	x4	x5	-
>  blackfin	R0	R1	R2	R3	R4	R5	-
>  i386	ebx	ecx	edx	esi	edi	ebp	-
>  ia64	out0	out1	out2	out3	out4	out5	-
> +mips/o32	a0	a1	a2	a3	-	-	-	See below
> +mips/n32,64	a0	a1	a2	a3	a4	a5	-
>  parisc	r26	r25	r24	r23	r22	r21	-
>  s390	r2	r3	r4	r5	r6	r7	-
>  s390x	r2	r3	r4	r5	r6	r7	-
> @@ -200,6 +205,8 @@ sparc/32	o0	o1	o2	o3	o4	o5	-
>  sparc/64	o0	o1	o2	o3	o4	o5	-
>  x86_64	rdi	rsi	rdx	r10	r8	r9	-
>  .TE
> +.PP
> +The mips/o32 syscall convention passes arguments 5 through 8 on the user stack.
>  .if t \{\
>  .in
>  .ft P
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] syscall.2: add arm64 and mips

[Kees Cook]

On Sun, Jan 18, 2015 at 3:58 AM, Michael Kerrisk (man-pages)
<mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> On 01/18/2015 08:22 AM, Kees Cook wrote:
>> Added mips to tables. Extra column added for boolean error register, since
>> both ia64 and mips use this convention. Added explicit non-register argument
>> passing note for mips/o32.
>>
>> Added arm64 to tables.
>
> Thanks Kees. I applied, but then tweaked. Because I do not want the tables
> to render wider than 80 columns, I took the 'bool error' piece into a
> paragraph below the table. See my commit eb83484fc.
> Could you double check the result in the Git please.

Ah, perfect, yes, that looks great. Thanks!

-Kees

-- 
Kees Cook
Chrome OS Security
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] syscall.2: add arm64 and mips

[Mike Frysinger]

[-- Attachment #1: Type: text/plain, Size: 487 bytes --]

On 17 Jan 2015 23:22, Kees Cook wrote:
> --- a/man2/syscall.2
> +++ b/man2/syscall.2
> @@ -36,6 +36,8 @@
>  .\"
>  .\" 2002-03-20  Christoph Hellwig <hch-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
>  .\"	- adopted for Linux
> +.\" 2015-01-17, Kees Cook <keescook-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
> +.\"	Added mips and arm64.
>  .\"

can we scrub changelogs from the man pages in general ?  they're usually 
incomplete and rarely provide more than `git log -p`.
-mike

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [PATCH] syscall.2: add arm64 and mips

[Michael Kerrisk (man-pages)]

On 02/15/2015 11:46 AM, Mike Frysinger wrote:
> On 17 Jan 2015 23:22, Kees Cook wrote:
>> --- a/man2/syscall.2
>> +++ b/man2/syscall.2
>> @@ -36,6 +36,8 @@
>>  .\"
>>  .\" 2002-03-20  Christoph Hellwig <hch-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
>>  .\"	- adopted for Linux
>> +.\" 2015-01-17, Kees Cook <keescook-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
>> +.\"	Added mips and arm64.
>>  .\"
> 
> can we scrub changelogs from the man pages in general ?  they're usually 
> incomplete and rarely provide more than `git log -p`.

Yes, I tend to discourage them these days, but don't always worry too much if
someone adds them to  patch.

Cheers,

Michael


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] syscall.2: add arm64 and mips

[Mike Frysinger]

[-- Attachment #1: Type: text/plain, Size: 1002 bytes --]

On 15 Feb 2015 16:13, Michael Kerrisk (man-pages) wrote:
> On 02/15/2015 11:46 AM, Mike Frysinger wrote:
> > On 17 Jan 2015 23:22, Kees Cook wrote:
> >> --- a/man2/syscall.2
> >> +++ b/man2/syscall.2
> >> @@ -36,6 +36,8 @@
> >>  .\"
> >>  .\" 2002-03-20  Christoph Hellwig <hch-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
> >>  .\"	- adopted for Linux
> >> +.\" 2015-01-17, Kees Cook <keescook-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
> >> +.\"	Added mips and arm64.
> >>  .\"
> > 
> > can we scrub changelogs from the man pages in general ?  they're usually 
> > incomplete and rarely provide more than `git log -p`.
> 
> Yes, I tend to discourage them these days, but don't always worry too much if
> someone adds them to  patch.

in this case, i think Kees was following apparent convention rather than 
thinking he always add one.  so i'm suggesting we help out at least the 
people who are just trying to DTRT by scrubbing the tree of existing ones 
that aren't useful.
-mike

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [PATCH] syscall.2: add arm64 and mips

[Kees Cook]

On Sun, Feb 15, 2015 at 9:51 AM, Mike Frysinger <vapier-aBrp7R+bbdUdnm+yROfE0A@public.gmane.org> wrote:
> On 15 Feb 2015 16:13, Michael Kerrisk (man-pages) wrote:
>> On 02/15/2015 11:46 AM, Mike Frysinger wrote:
>> > On 17 Jan 2015 23:22, Kees Cook wrote:
>> >> --- a/man2/syscall.2
>> >> +++ b/man2/syscall.2
>> >> @@ -36,6 +36,8 @@
>> >>  .\"
>> >>  .\" 2002-03-20  Christoph Hellwig <hch-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
>> >>  .\"       - adopted for Linux
>> >> +.\" 2015-01-17, Kees Cook <keescook-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
>> >> +.\"       Added mips and arm64.
>> >>  .\"
>> >
>> > can we scrub changelogs from the man pages in general ?  they're usually
>> > incomplete and rarely provide more than `git log -p`.
>>
>> Yes, I tend to discourage them these days, but don't always worry too much if
>> someone adds them to  patch.
>
> in this case, i think Kees was following apparent convention rather than
> thinking he always add one.  so i'm suggesting we help out at least the
> people who are just trying to DTRT by scrubbing the tree of existing ones
> that aren't useful.

Yeah, I tend to try to follow the convention in the file. It's wasn't
clear what to do. I'm happy to send a patch to wipe my entries, if
that's desired.

-Kees

-- 
Kees Cook
Chrome OS Security
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] syscall.2: add arm64 and mips

[Mike Frysinger]

[-- Attachment #1: Type: text/plain, Size: 1476 bytes --]

On 16 Feb 2015 11:30, Kees Cook wrote:
> On Sun, Feb 15, 2015 at 9:51 AM, Mike Frysinger wrote:
> > On 15 Feb 2015 16:13, Michael Kerrisk (man-pages) wrote:
> >> On 02/15/2015 11:46 AM, Mike Frysinger wrote:
> >> > On 17 Jan 2015 23:22, Kees Cook wrote:
> >> >> --- a/man2/syscall.2
> >> >> +++ b/man2/syscall.2
> >> >> @@ -36,6 +36,8 @@
> >> >>  .\"
> >> >>  .\" 2002-03-20  Christoph Hellwig <hch-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
> >> >>  .\"       - adopted for Linux
> >> >> +.\" 2015-01-17, Kees Cook <keescook-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
> >> >> +.\"       Added mips and arm64.
> >> >>  .\"
> >> >
> >> > can we scrub changelogs from the man pages in general ?  they're usually
> >> > incomplete and rarely provide more than `git log -p`.
> >>
> >> Yes, I tend to discourage them these days, but don't always worry too much if
> >> someone adds them to  patch.
> >
> > in this case, i think Kees was following apparent convention rather than
> > thinking he always add one.  so i'm suggesting we help out at least the
> > people who are just trying to DTRT by scrubbing the tree of existing ones
> > that aren't useful.
> 
> Yeah, I tend to try to follow the convention in the file. It's wasn't
> clear what to do. I'm happy to send a patch to wipe my entries, if
> that's desired.

i don't think we need to make you do that one off :).  if Michael is happy with 
scrubbing the code base, lets go that route.
-mike

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [PATCH] syscall.2: add arm64 and mips

[Michael Kerrisk (man-pages)]

On 17 February 2015 at 05:02, Mike Frysinger <vapier-aBrp7R+bbdUdnm+yROfE0A@public.gmane.org> wrote:
> On 16 Feb 2015 11:30, Kees Cook wrote:
>> On Sun, Feb 15, 2015 at 9:51 AM, Mike Frysinger wrote:
>> > On 15 Feb 2015 16:13, Michael Kerrisk (man-pages) wrote:
>> >> On 02/15/2015 11:46 AM, Mike Frysinger wrote:
>> >> > On 17 Jan 2015 23:22, Kees Cook wrote:
>> >> >> --- a/man2/syscall.2
>> >> >> +++ b/man2/syscall.2
>> >> >> @@ -36,6 +36,8 @@
>> >> >>  .\"
>> >> >>  .\" 2002-03-20  Christoph Hellwig <hch-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
>> >> >>  .\"       - adopted for Linux
>> >> >> +.\" 2015-01-17, Kees Cook <keescook-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
>> >> >> +.\"       Added mips and arm64.
>> >> >>  .\"
>> >> >
>> >> > can we scrub changelogs from the man pages in general ?  they're usually
>> >> > incomplete and rarely provide more than `git log -p`.
>> >>
>> >> Yes, I tend to discourage them these days, but don't always worry too much if
>> >> someone adds them to  patch.
>> >
>> > in this case, i think Kees was following apparent convention rather than
>> > thinking he always add one.  so i'm suggesting we help out at least the
>> > people who are just trying to DTRT by scrubbing the tree of existing ones
>> > that aren't useful.
>>
>> Yeah, I tend to try to follow the convention in the file. It's wasn't
>> clear what to do. I'm happy to send a patch to wipe my entries, if
>> that's desired.
>
> i don't think we need to make you do that one off :).  if Michael is happy with
> scrubbing the code base, lets go that route.

While I (generally) discourage changelogs in the source, I'm not
concerned enough to actually do anything about this (and Kees don't
worry about a patch). In some cases, the changelogs do have actually
useful info (from pre-Git days), and even since then I myself find a
few entries are sometimes useful to get a quick idea of the evolution
of a page. Yes, some entries are just noise, but automating some
solution to remove them would be error prone and require moderate
effort for tiny benefit.

Thanks,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html