github.com/zebozhuang/go@v0.0.0-20200207033046-f8a98f6f5c5d/src/syscall/mkall.sh (about)

     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  
    76  GOOSARCH="${GOOS}_${GOARCH}"
    77  
    78  # defaults
    79  mksyscall="./mksyscall.pl"
    80  mkerrors="./mkerrors.sh"
    81  zerrors="zerrors_$GOOSARCH.go"
    82  mksysctl=""
    83  zsysctl="zsysctl_$GOOSARCH.go"
    84  mksysnum=
    85  mktypes=
    86  run="sh"
    87  
    88  case "$1" in
    89  -syscalls)
    90  	for i in zsyscall*go
    91  	do
    92  		# Run the command line that appears in the first line
    93  		# of the generated file to regenerate it.
    94  		sed 1q $i | sed 's;^// ;;' | sh > _$i && gofmt < _$i > $i
    95  		rm _$i
    96  	done
    97  	exit 0
    98  	;;
    99  -n)
   100  	run="cat"
   101  	shift
   102  esac
   103  
   104  case "$#" in
   105  0)
   106  	;;
   107  *)
   108  	echo 'usage: mkall.sh [-n]' 1>&2
   109  	exit 2
   110  esac
   111  
   112  GOOSARCH_in=syscall_$GOOSARCH.go
   113  case "$GOOSARCH" in
   114  _* | *_ | _)
   115  	echo 'undefined $GOOS_$GOARCH:' "$GOOSARCH" 1>&2
   116  	exit 1
   117  	;;
   118  darwin_386)
   119  	mkerrors="$mkerrors -m32"
   120  	mksyscall="./mksyscall.pl -l32"
   121  	mksysnum="./mksysnum_darwin.pl /usr/include/sys/syscall.h"
   122  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   123  	;;
   124  darwin_amd64)
   125  	mkerrors="$mkerrors -m64"
   126  	mksysnum="./mksysnum_darwin.pl /usr/include/sys/syscall.h"
   127  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   128  	;;
   129  darwin_arm64)
   130  	mkerrors="$mkerrors -m64"
   131  	mksysnum="./mksysnum_darwin.pl /usr/include/sys/syscall.h"
   132  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   133  	;;
   134  dragonfly_386)
   135  	mkerrors="$mkerrors -m32"
   136  	mksyscall="./mksyscall.pl -l32 -dragonfly"
   137  	mksysnum="curl -s 'http://gitweb.dragonflybsd.org/dragonfly.git/blob_plain/HEAD:/sys/kern/syscalls.master' | ./mksysnum_dragonfly.pl"
   138  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   139  	;;
   140  dragonfly_amd64)
   141  	mkerrors="$mkerrors -m64"
   142  	mksyscall="./mksyscall.pl -dragonfly"
   143  	mksysnum="curl -s 'http://gitweb.dragonflybsd.org/dragonfly.git/blob_plain/HEAD:/sys/kern/syscalls.master' | ./mksysnum_dragonfly.pl"
   144  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   145  	;;
   146  freebsd_386)
   147  	mkerrors="$mkerrors -m32"
   148  	mksyscall="./mksyscall.pl -l32"
   149  	mksysnum="curl -s 'http://svn.freebsd.org/base/stable/10/sys/kern/syscalls.master' | ./mksysnum_freebsd.pl"
   150  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   151  	;;
   152  freebsd_amd64)
   153  	mkerrors="$mkerrors -m64"
   154  	mksysnum="curl -s 'http://svn.freebsd.org/base/stable/10/sys/kern/syscalls.master' | ./mksysnum_freebsd.pl"
   155  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   156  	;;
   157  freebsd_arm)
   158  	mkerrors="$mkerrors"
   159  	mksyscall="./mksyscall.pl -l32 -arm"
   160  	mksysnum="curl -s 'http://svn.freebsd.org/base/stable/10/sys/kern/syscalls.master' | ./mksysnum_freebsd.pl"
   161  	# Let the type of C char be signed to make the bare syscall
   162  	# API consistent between platforms.
   163  	mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char"
   164  	;;
   165  linux_386)
   166  	mkerrors="$mkerrors -m32"
   167  	mksyscall="./mksyscall.pl -l32"
   168  	mksysnum="./mksysnum_linux.pl /usr/include/asm/unistd_32.h"
   169  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   170  	;;
   171  linux_amd64)
   172  	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)
   173  	if [ "$unistd_h" = "" ]; then
   174  		echo >&2 cannot find unistd_64.h
   175  		exit 1
   176  	fi
   177  	mkerrors="$mkerrors -m64"
   178  	mksysnum="./mksysnum_linux.pl $unistd_h"
   179  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   180  	;;
   181  linux_arm)
   182  	mkerrors="$mkerrors"
   183  	mksyscall="./mksyscall.pl -l32 -arm"
   184  	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 -"
   185  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   186  	;;
   187  linux_arm64)
   188  	unistd_h=$(ls -1 /usr/include/asm/unistd.h /usr/include/asm-generic/unistd.h 2>/dev/null | head -1)
   189  	if [ "$unistd_h" = "" ]; then
   190  		echo >&2 cannot find unistd_64.h
   191  		exit 1
   192  	fi
   193  	mksysnum="./mksysnum_linux.pl $unistd_h"
   194  	# Let the type of C char be signed to make the bare syscall
   195  	# API consistent between platforms.
   196  	mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char"
   197  	;;
   198  linux_ppc64)
   199  	GOOSARCH_in=syscall_linux_ppc64x.go
   200  	unistd_h=/usr/include/asm/unistd.h
   201  	mkerrors="$mkerrors -m64"
   202  	mksysnum="./mksysnum_linux.pl $unistd_h"
   203  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   204  	;;
   205  linux_ppc64le)
   206  	GOOSARCH_in=syscall_linux_ppc64x.go
   207  	unistd_h=/usr/include/powerpc64le-linux-gnu/asm/unistd.h
   208  	mkerrors="$mkerrors -m64"
   209  	mksysnum="./mksysnum_linux.pl $unistd_h"
   210  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   211  	;;
   212  linux_s390x)
   213  	GOOSARCH_in=syscall_linux_s390x.go
   214  	unistd_h=/usr/include/asm/unistd.h
   215  	mkerrors="$mkerrors -m64"
   216  	mksysnum="./mksysnum_linux.pl $unistd_h"
   217  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   218  	;;
   219  nacl_386)
   220  	mkerrors=""
   221  	mksyscall="./mksyscall.pl -l32 -nacl"
   222  	mksysnum=""
   223  	mktypes=""
   224  	;;
   225  nacl_amd64p32)
   226  	mkerrors=""
   227  	mksyscall="./mksyscall.pl -nacl"
   228  	mksysnum=""
   229  	mktypes=""
   230  	;;
   231  netbsd_386)
   232  	mkerrors="$mkerrors -m32"
   233  	mksyscall="./mksyscall.pl -l32 -netbsd"
   234  	mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl"
   235  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   236  	;;
   237  netbsd_amd64)
   238  	mkerrors="$mkerrors -m64"
   239  	mksyscall="./mksyscall.pl -netbsd"
   240  	mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl"
   241  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   242  	;;
   243  openbsd_386)
   244  	mkerrors="$mkerrors -m32"
   245  	mksyscall="./mksyscall.pl -l32 -openbsd"
   246  	mksysctl="./mksysctl_openbsd.pl"
   247  	zsysctl="zsysctl_openbsd.go"
   248  	mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl"
   249  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   250  	;;
   251  openbsd_amd64)
   252  	mkerrors="$mkerrors -m64"
   253  	mksyscall="./mksyscall.pl -openbsd"
   254  	mksysctl="./mksysctl_openbsd.pl"
   255  	zsysctl="zsysctl_openbsd.go"
   256  	mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl"
   257  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   258  	;;
   259  openbsd_arm)
   260  	mkerrors="$mkerrors"
   261  	mksyscall="./mksyscall.pl -l32 -openbsd -arm"
   262  	mksysctl="./mksysctl_openbsd.pl"
   263  	zsysctl="zsysctl_openbsd.go"
   264  	mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl"
   265  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   266  	;;
   267  plan9_386)
   268  	mkerrors=
   269  	mksyscall="./mksyscall.pl -l32 -plan9"
   270  	mksysnum="./mksysnum_plan9.sh /n/sources/plan9/sys/src/libc/9syscall/sys.h"
   271  	mktypes="XXX"
   272  	;;
   273  solaris_amd64)
   274  	mksyscall="./mksyscall_solaris.pl"
   275  	mkerrors="$mkerrors -m64"
   276  	mksysnum=
   277  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   278  	;;
   279  windows_*)
   280  	echo 'run "go generate" instead' 1>&2
   281  	exit 1
   282  	;;
   283  *)
   284  	echo 'unrecognized $GOOS_$GOARCH: ' "$GOOSARCH" 1>&2
   285  	exit 1
   286  	;;
   287  esac
   288  
   289  (
   290  	if [ -n "$mkerrors" ]; then echo "$mkerrors |gofmt >$zerrors"; fi
   291  	syscall_goos="syscall_$GOOS.go"
   292   	case "$GOOS" in
   293  	darwin | dragonfly | freebsd | netbsd | openbsd)
   294  		syscall_goos="syscall_bsd.go $syscall_goos"
   295   		;;
   296   	esac
   297  	if [ -n "$mksyscall" ]; then echo "$mksyscall -tags $GOOS,$GOARCH $syscall_goos $GOOSARCH_in |gofmt >zsyscall_$GOOSARCH.go"; fi
   298  	if [ -n "$mksysctl" ]; then echo "$mksysctl |gofmt >$zsysctl"; fi
   299  	if [ -n "$mksysnum" ]; then echo "$mksysnum |gofmt >zsysnum_$GOOSARCH.go"; fi
   300  	if [ -n "$mktypes" ]; then echo "$mktypes types_$GOOS.go |go run mkpost.go >ztypes_$GOOSARCH.go"; fi
   301  ) | $run