summaryrefslogtreecommitdiff
path: root/sysdeps
diff options
context:
space:
mode:
authorCarlos O'Donell <carlos@systemhalted.org>2012-11-20 13:54:47 -0500
committerCarlos O'Donell <carlos@systemhalted.org>2012-11-20 14:40:34 -0500
commit105ce2ce621b79ebad13e307fb14ef8163cf7a44 (patch)
tree8bb1ded54861c88f253cea9c31a675697e7b96f4 /sysdeps
parentd072f3f7724d85ceaf230806660235f0cf2f9c3b (diff)
Document syscall signature prefixes in sysdep/unix/make-syscalls.sh
Diffstat (limited to 'sysdeps')
-rw-r--r--sysdeps/unix/make-syscalls.sh16
1 files changed, 14 insertions, 2 deletions
diff --git a/sysdeps/unix/make-syscalls.sh b/sysdeps/unix/make-syscalls.sh
index 7e7de65f3a..f7162e2186 100644
--- a/sysdeps/unix/make-syscalls.sh
+++ b/sysdeps/unix/make-syscalls.sh
@@ -4,8 +4,19 @@
# Expects $sysdirs in environment.
##############################################################################
-
-# Syscall Signature Key Letters for BP Thunks:
+#
+# This script is used to process the syscall data encoded in the various
+# syscalls.list files to produce thin assembly syscall wrappers around the
+# appropriate OS syscall. See syscall-template.s for more details on the
+# actual wrapper.
+#
+# Syscall Signature Prefixes:
+#
+# C: cancellable (i.e., this syscall is a cancellation point)
+# E: errno and return value are not set by the call
+# V: errno is not set, but errno or zero (success) is returned from the call
+#
+# Syscall Signature Key Letters:
#
# a: unchecked address (e.g., 1st arg to mmap)
# b: non-NULL buffer (e.g., 2nd arg to read; return value from mmap)
@@ -23,6 +34,7 @@
# v: vararg scalar (e.g., optional 3rd arg to open)
# V: byte-per-page vector (3rd arg to mincore)
# W: wait status, optionally-NULL pointer to int (e.g., 2nd arg of wait4)
+#
ptr='[abBfFINpPsSWV]' # all pointer keyletters
int='[inv]' # all scalar keyletters