Black Lives Matter. Support the Equal Justice Initiative.

Text file src/syscall/mkall.sh

Documentation: syscall

     1#!/usr/bin/env bash
     2# Copyright 2009 The Go Authors. All rights reserved.
     3# Use of this source code is governed by a BSD-style
     4# license that can be found in the LICENSE file.
     5
     6# The syscall package provides access to the raw system call
     7# interface of the underlying operating system.  Porting Go to
     8# a new architecture/operating system combination requires
     9# some manual effort, though there are tools that automate
    10# much of the process.  The auto-generated files have names
    11# beginning with z.
    12#
    13# This script runs or (given -n) prints suggested commands to generate z files
    14# for the current system.  Running those commands is not automatic.
    15# This script is documentation more than anything else.
    16#
    17# * asm_${GOOS}_${GOARCH}.s
    18#
    19# This hand-written assembly file implements system call dispatch.
    20# There are three entry points:
    21#
    22# 	func Syscall(trap, a1, a2, a3 uintptr) (r1, r2, err uintptr);
    23# 	func Syscall6(trap, a1, a2, a3, a4, a5, a6 uintptr) (r1, r2, err uintptr);
    24# 	func RawSyscall(trap, a1, a2, a3 uintptr) (r1, r2, err uintptr);
    25#
    26# The first and second are the standard ones; they differ only in
    27# how many arguments can be passed to the kernel.
    28# The third is for low-level use by the ForkExec wrapper;
    29# unlike the first two, it does not call into the scheduler to
    30# let it know that a system call is running.
    31#
    32# * syscall_${GOOS}.go
    33#
    34# This hand-written Go file implements system calls that need
    35# special handling and lists "//sys" comments giving prototypes
    36# for ones that can be auto-generated.  Mksyscall reads those
    37# comments to generate the stubs.
    38#
    39# * syscall_${GOOS}_${GOARCH}.go
    40#
    41# Same as syscall_${GOOS}.go except that it contains code specific
    42# to ${GOOS} on one particular architecture.
    43#
    44# * types_${GOOS}.c
    45#
    46# This hand-written C file includes standard C headers and then
    47# creates typedef or enum names beginning with a dollar sign
    48# (use of $ in variable names is a gcc extension).  The hardest
    49# part about preparing this file is figuring out which headers to
    50# include and which symbols need to be #defined to get the
    51# actual data structures that pass through to the kernel system calls.
    52# Some C libraries present alternate versions for binary compatibility
    53# and translate them on the way in and out of system calls, but
    54# there is almost always a #define that can get the real ones.
    55# See types_darwin.c and types_linux.c for examples.
    56#
    57# * zerror_${GOOS}_${GOARCH}.go
    58#
    59# This machine-generated file defines the system's error numbers,
    60# error strings, and signal numbers.  The generator is "mkerrors.sh".
    61# Usually no arguments are needed, but mkerrors.sh will pass its
    62# arguments on to godefs.
    63#
    64# * zsyscall_${GOOS}_${GOARCH}.go
    65#
    66# Generated by mksyscall.pl; see syscall_${GOOS}.go above.
    67#
    68# * zsysnum_${GOOS}_${GOARCH}.go
    69#
    70# Generated by mksysnum_${GOOS}.
    71#
    72# * ztypes_${GOOS}_${GOARCH}.go
    73#
    74# Generated by godefs; see types_${GOOS}.c above.
    75
    76GOOSARCH="${GOOS}_${GOARCH}"
    77
    78# defaults
    79mksyscall="./mksyscall.pl"
    80mkerrors="./mkerrors.sh"
    81zerrors="zerrors_$GOOSARCH.go"
    82mksysctl=""
    83zsysctl="zsysctl_$GOOSARCH.go"
    84mksysnum=
    85mktypes=
    86mkasm=
    87run="sh"
    88
    89case "$1" in
    90-syscalls)
    91	for i in zsyscall*go
    92	do
    93		# Run the command line that appears in the first line
    94		# of the generated file to regenerate it.
    95		sed 1q $i | sed 's;^// ;;' | sh > _$i && gofmt < _$i > $i
    96		rm _$i
    97	done
    98	exit 0
    99	;;
   100-n)
   101	run="cat"
   102	shift
   103esac
   104
   105case "$#" in
   1060)
   107	;;
   108*)
   109	echo 'usage: mkall.sh [-n]' 1>&2
   110	exit 2
   111esac
   112
   113GOOSARCH_in=syscall_$GOOSARCH.go
   114case "$GOOSARCH" in
   115_* | *_ | _)
   116	echo 'undefined $GOOS_$GOARCH:' "$GOOSARCH" 1>&2
   117	exit 1
   118	;;
   119aix_ppc64)
   120	mkerrors="$mkerrors -maix64"
   121	mksyscall="./mksyscall_libc.pl -aix"
   122	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   123	;;
   124darwin_amd64)
   125	mkerrors="$mkerrors -m64"
   126	mksyscall="./mksyscall.pl -darwin"
   127	mksysnum="./mksysnum_darwin.pl /usr/include/sys/syscall.h"
   128	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   129	mkasm="go run mkasm_darwin.go"
   130	;;
   131darwin_arm64)
   132	mkerrors="$mkerrors -m64"
   133	mksyscall="./mksyscall.pl -darwin"
   134	mksysnum="./mksysnum_darwin.pl /usr/include/sys/syscall.h"
   135	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   136	mkasm="go run mkasm_darwin.go"
   137	;;
   138dragonfly_amd64)
   139	mkerrors="$mkerrors -m64"
   140	mksyscall="./mksyscall.pl -dragonfly"
   141	mksysnum="curl -s 'http://gitweb.dragonflybsd.org/dragonfly.git/blob_plain/HEAD:/sys/kern/syscalls.master' | ./mksysnum_dragonfly.pl"
   142	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   143	;;
   144freebsd_386)
   145	mkerrors="$mkerrors -m32"
   146	mksyscall="./mksyscall.pl -l32"
   147	mksysnum="curl -s 'http://svn.freebsd.org/base/stable/10/sys/kern/syscalls.master' | ./mksysnum_freebsd.pl"
   148	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   149	;;
   150freebsd_amd64)
   151	mkerrors="$mkerrors -m64"
   152	mksysnum="curl -s 'http://svn.freebsd.org/base/stable/10/sys/kern/syscalls.master' | ./mksysnum_freebsd.pl"
   153	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   154	;;
   155freebsd_arm)
   156	mkerrors="$mkerrors"
   157	mksyscall="./mksyscall.pl -l32 -arm"
   158	mksysnum="curl -s 'http://svn.freebsd.org/base/stable/10/sys/kern/syscalls.master' | ./mksysnum_freebsd.pl"
   159	# Let the type of C char be signed to make the bare syscall
   160	# API consistent between platforms.
   161	mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char"
   162	;;
   163freebsd_arm64)
   164	mkerrors="$mkerrors"
   165	mksysnum="curl -s 'http://svn.freebsd.org/base/stable/10/sys/kern/syscalls.master' | ./mksysnum_freebsd.pl"
   166	# Let the type of C char be signed to make the bare syscall
   167	# API consistent between platforms.
   168	mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char"
   169	;;
   170linux_386)
   171	mkerrors="$mkerrors -m32"
   172	mksyscall="./mksyscall.pl -l32"
   173	mksysnum="./mksysnum_linux.pl /usr/include/asm/unistd_32.h"
   174	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   175	;;
   176linux_amd64)
   177	unistd_h=$(ls -1 /usr/include/asm/unistd_64.h /usr/include/x86_64-linux-gnu/asm/unistd_64.h 2>/dev/null | head -1)
   178	if [ "$unistd_h" = "" ]; then
   179		echo >&2 cannot find unistd_64.h
   180		exit 1
   181	fi
   182	mkerrors="$mkerrors -m64"
   183	mksysnum="./mksysnum_linux.pl $unistd_h"
   184	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   185	;;
   186linux_arm)
   187	mkerrors="$mkerrors"
   188	mksyscall="./mksyscall.pl -l32 -arm"
   189	mksysnum="curl -s 'http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/plain/arch/arm/include/uapi/asm/unistd.h' | ./mksysnum_linux.pl -"
   190	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   191	;;
   192linux_arm64)
   193	unistd_h=$(ls -1 /usr/include/asm/unistd.h /usr/include/asm-generic/unistd.h 2>/dev/null | head -1)
   194	if [ "$unistd_h" = "" ]; then
   195		echo >&2 cannot find unistd_64.h
   196		exit 1
   197	fi
   198	mksysnum="./mksysnum_linux.pl $unistd_h"
   199	# Let the type of C char be signed to make the bare syscall
   200	# API consistent between platforms.
   201	mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char"
   202	;;
   203linux_mips)
   204	GOOSARCH_in=syscall_linux_mipsx.go
   205	unistd_h=/usr/include/asm/unistd.h
   206	mksyscall="./mksyscall.pl -b32 -arm"
   207	mkerrors="$mkerrors"
   208	mksysnum="./mksysnum_linux.pl $unistd_h"
   209	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   210	;;
   211linux_mipsle)
   212	GOOSARCH_in=syscall_linux_mipsx.go
   213	unistd_h=/usr/include/asm/unistd.h
   214	mksyscall="./mksyscall.pl -l32 -arm"
   215	mkerrors="$mkerrors"
   216	mksysnum="./mksysnum_linux.pl $unistd_h"
   217	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   218	;;
   219linux_mips64)
   220	GOOSARCH_in=syscall_linux_mips64x.go
   221	unistd_h=/usr/include/asm/unistd.h
   222	mkerrors="$mkerrors -m64"
   223	mksysnum="./mksysnum_linux.pl $unistd_h"
   224	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   225	;;
   226linux_mips64le)
   227	GOOSARCH_in=syscall_linux_mips64x.go
   228	unistd_h=/usr/include/asm/unistd.h
   229	mkerrors="$mkerrors -m64"
   230	mksysnum="./mksysnum_linux.pl $unistd_h"
   231	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   232	;;
   233linux_ppc64)
   234	GOOSARCH_in=syscall_linux_ppc64x.go
   235	unistd_h=/usr/include/asm/unistd.h
   236	mkerrors="$mkerrors -m64"
   237	mksysnum="./mksysnum_linux.pl $unistd_h"
   238	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   239	;;
   240linux_ppc64le)
   241	GOOSARCH_in=syscall_linux_ppc64x.go
   242	unistd_h=/usr/include/powerpc64le-linux-gnu/asm/unistd.h
   243	mkerrors="$mkerrors -m64"
   244	mksysnum="./mksysnum_linux.pl $unistd_h"
   245	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   246	;;
   247linux_riscv64)
   248	unistd_h=$(ls -1 /usr/include/asm/unistd.h /usr/include/asm-generic/unistd.h 2>/dev/null | head -1)
   249	if [ "$unistd_h" = "" ]; then
   250		echo >&2 cannot find unistd_64.h
   251		exit 1
   252	fi
   253	mksysnum="./mksysnum_linux.pl $unistd_h"
   254	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   255	;;
   256linux_s390x)
   257	GOOSARCH_in=syscall_linux_s390x.go
   258	unistd_h=/usr/include/asm/unistd.h
   259	mkerrors="$mkerrors -m64"
   260	mksysnum="./mksysnum_linux.pl $unistd_h"
   261	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   262	;;
   263netbsd_386)
   264	mkerrors="$mkerrors -m32"
   265	mksyscall="./mksyscall.pl -l32 -netbsd"
   266	mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl"
   267	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   268	;;
   269netbsd_amd64)
   270	mkerrors="$mkerrors -m64"
   271	mksyscall="./mksyscall.pl -netbsd"
   272	mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl"
   273	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   274	;;
   275netbsd_arm)
   276	mkerrors="$mkerrors -m32"
   277	mksyscall="./mksyscall.pl -l32 -netbsd -arm"
   278	mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl"
   279	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   280	;;
   281netbsd_arm64)
   282	mkerrors="$mkerrors -m64"
   283	mksyscall="./mksyscall.pl -netbsd"
   284	mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl"
   285	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   286	;;
   287openbsd_386)
   288	mkerrors="$mkerrors -m32"
   289	mksyscall="./mksyscall.pl -l32 -openbsd"
   290	mksysctl="./mksysctl_openbsd.pl"
   291	zsysctl="zsysctl_openbsd.go"
   292	mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl"
   293	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   294	;;
   295openbsd_amd64)
   296	mkerrors="$mkerrors -m64"
   297	mksyscall="./mksyscall.pl -openbsd"
   298	mksysctl="./mksysctl_openbsd.pl"
   299	zsysctl="zsysctl_openbsd.go"
   300	mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl"
   301	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   302	;;
   303openbsd_arm)
   304	mkerrors="$mkerrors"
   305	mksyscall="./mksyscall.pl -l32 -openbsd -arm"
   306	mksysctl="./mksysctl_openbsd.pl"
   307	zsysctl="zsysctl_openbsd.go"
   308	mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl"
   309	# Let the type of C char be signed to make the bare syscall
   310	# API consistent between platforms.
   311	mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char"
   312	;;
   313openbsd_arm64)
   314	mkerrors="$mkerrors -m64"
   315	mksyscall="./mksyscall.pl -openbsd"
   316	mksysctl="./mksysctl_openbsd.pl"
   317	zsysctl="zsysctl_openbsd.go"
   318	mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl"
   319	# Let the type of C char be signed to make the bare syscall
   320	# API consistent between platforms.
   321	mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char"
   322	;;
   323plan9_386)
   324	mkerrors=
   325	mksyscall="./mksyscall.pl -l32 -plan9"
   326	mksysnum="./mksysnum_plan9.sh /n/sources/plan9/sys/src/libc/9syscall/sys.h"
   327	mktypes="XXX"
   328	;;
   329solaris_amd64)
   330	mksyscall="./mksyscall_libc.pl -solaris"
   331	mkerrors="$mkerrors -m64"
   332	mksysnum=
   333	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   334	;;
   335windows_*)
   336	echo 'run "go generate" instead' 1>&2
   337	exit 1
   338	;;
   339*)
   340	echo 'unrecognized $GOOS_$GOARCH: ' "$GOOSARCH" 1>&2
   341	exit 1
   342	;;
   343esac
   344
   345(
   346	if [ -n "$mkerrors" ]; then echo "$mkerrors |gofmt >$zerrors"; fi
   347	syscall_goos="syscall_$GOOS.go"
   348 	case "$GOOS" in
   349	darwin | dragonfly | freebsd | netbsd | openbsd)
   350		syscall_goos="syscall_bsd.go $syscall_goos"
   351 		;;
   352 	esac
   353	if [ -n "$mksyscall" ]; then echo "$mksyscall -tags $GOOS,$GOARCH $syscall_goos $GOOSARCH_in |gofmt >zsyscall_$GOOSARCH.go"; fi
   354	if [ -n "$mksysctl" ]; then echo "$mksysctl |gofmt >$zsysctl"; fi
   355	if [ -n "$mksysnum" ]; then echo "$mksysnum |gofmt >zsysnum_$GOOSARCH.go"; fi
   356	if [ -n "$mktypes" ]; then
   357		# ztypes_$GOOSARCH.go could be erased before "go run mkpost.go" is called.
   358		# Therefore, "go run" tries to recompile syscall package but ztypes is empty and it fails.
   359		echo "$mktypes types_$GOOS.go |go run mkpost.go >ztypes_$GOOSARCH.go.NEW && mv ztypes_$GOOSARCH.go.NEW ztypes_$GOOSARCH.go";
   360	fi
   361	if [ -n "$mkasm" ]; then echo "$mkasm $GOARCH"; fi
   362) | $run

View as plain text