github.com/hbdrawn/golang@v0.0.0-20141214014649-6b835209aba2/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  		sed 1q $i | sed 's;^// ;;' | sh > _$i && gofmt < _$i > $i
    93  		rm _$i
    94  	done
    95  	exit 0
    96  	;;
    97  -n)
    98  	run="cat"
    99  	shift
   100  esac
   101  
   102  case "$#" in
   103  0)
   104  	;;
   105  *)
   106  	echo 'usage: mkall.sh [-n]' 1>&2
   107  	exit 2
   108  esac
   109  
   110  GOOSARCH_in=syscall_$GOOSARCH.go
   111  case "$GOOSARCH" in
   112  _* | *_ | _)
   113  	echo 'undefined $GOOS_$GOARCH:' "$GOOSARCH" 1>&2
   114  	exit 1
   115  	;;
   116  darwin_386)
   117  	mkerrors="$mkerrors -m32"
   118  	mksyscall="./mksyscall.pl -l32"
   119  	mksysnum="./mksysnum_darwin.pl /usr/include/sys/syscall.h"
   120  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   121  	;;
   122  darwin_amd64)
   123  	mkerrors="$mkerrors -m64"
   124  	mksysnum="./mksysnum_darwin.pl /usr/include/sys/syscall.h"
   125  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   126  	;;
   127  dragonfly_386)
   128  	mkerrors="$mkerrors -m32"
   129  	mksyscall="./mksyscall.pl -l32 -dragonfly"
   130  	mksysnum="curl -s 'http://gitweb.dragonflybsd.org/dragonfly.git/blob_plain/HEAD:/sys/kern/syscalls.master' | ./mksysnum_dragonfly.pl"
   131  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   132  	;;
   133  dragonfly_amd64)
   134  	mkerrors="$mkerrors -m64"
   135  	mksyscall="./mksyscall.pl -dragonfly"
   136  	mksysnum="curl -s 'http://gitweb.dragonflybsd.org/dragonfly.git/blob_plain/HEAD:/sys/kern/syscalls.master' | ./mksysnum_dragonfly.pl"
   137  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   138  	;;
   139  freebsd_386)
   140  	mkerrors="$mkerrors -m32"
   141  	mksyscall="./mksyscall.pl -l32"
   142  	mksysnum="curl -s 'http://svn.freebsd.org/base/stable/10/sys/kern/syscalls.master' | ./mksysnum_freebsd.pl"
   143  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   144  	;;
   145  freebsd_amd64)
   146  	mkerrors="$mkerrors -m64"
   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  	;;
   150  freebsd_arm)
   151  	mkerrors="$mkerrors"
   152  	mksyscall="./mksyscall.pl -l32 -arm"
   153  	mksysnum="curl -s 'http://svn.freebsd.org/base/stable/10/sys/kern/syscalls.master' | ./mksysnum_freebsd.pl"
   154  	# Let the type of C char be singed for making the bare syscall
   155  	# API consistent across over platforms.
   156  	mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char"
   157  	;;
   158  linux_386)
   159  	mkerrors="$mkerrors -m32"
   160  	mksyscall="./mksyscall.pl -l32"
   161  	mksysnum="./mksysnum_linux.pl /usr/include/asm/unistd_32.h"
   162  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   163  	;;
   164  linux_amd64)
   165  	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)
   166  	if [ "$unistd_h" = "" ]; then
   167  		echo >&2 cannot find unistd_64.h
   168  		exit 1
   169  	fi
   170  	mkerrors="$mkerrors -m64"
   171  	mksysnum="./mksysnum_linux.pl $unistd_h"
   172  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   173  	;;
   174  linux_arm)
   175  	mkerrors="$mkerrors"
   176  	mksyscall="./mksyscall.pl -l32 -arm"
   177  	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"
   178  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   179  	;;
   180  linux_ppc64)
   181  	GOOSARCH_in=syscall_linux_ppc64x.go
   182  	unistd_h=/usr/include/asm/unistd.h
   183  	mkerrors="$mkerrors -m64"
   184  	mksysnum="./mksysnum_linux.pl $unistd_h"
   185  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   186  	;;
   187  linux_ppc64le)
   188  	GOOSARCH_in=syscall_linux_ppc64x.go
   189  	unistd_h=/usr/include/powerpc64le-linux-gnu/asm/unistd.h
   190  	mkerrors="$mkerrors -m64"
   191  	mksysnum="./mksysnum_linux.pl $unistd_h"
   192  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   193  	;;
   194  nacl_386)
   195  	mkerrors=""
   196  	mksyscall="./mksyscall.pl -l32 -nacl"
   197  	mksysnum=""
   198  	mktypes=""
   199  	;;
   200  nacl_amd64p32)
   201  	mkerrors=""
   202  	mksyscall="./mksyscall.pl -nacl"
   203  	mksysnum=""
   204  	mktypes=""
   205  	;;
   206  netbsd_386)
   207  	mkerrors="$mkerrors -m32"
   208  	mksyscall="./mksyscall.pl -l32 -netbsd"
   209  	mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl"
   210  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   211  	;;
   212  netbsd_amd64)
   213  	mkerrors="$mkerrors -m64"
   214  	mksyscall="./mksyscall.pl -netbsd"
   215  	mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl"
   216  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   217  	;;
   218  openbsd_386)
   219  	mkerrors="$mkerrors -m32"
   220  	mksyscall="./mksyscall.pl -l32 -openbsd"
   221  	mksysctl="./mksysctl_openbsd.pl"
   222  	zsysctl="zsysctl_openbsd.go"
   223  	mksysnum="curl -s 'http://www.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl"
   224  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   225  	;;
   226  openbsd_amd64)
   227  	mkerrors="$mkerrors -m64"
   228  	mksyscall="./mksyscall.pl -openbsd"
   229  	mksysctl="./mksysctl_openbsd.pl"
   230  	zsysctl="zsysctl_openbsd.go"
   231  	mksysnum="curl -s 'http://www.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl"
   232  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   233  	;;
   234  plan9_386)
   235  	mkerrors=
   236  	mksyscall="./mksyscall.pl -l32 -plan9"
   237  	mksysnum="./mksysnum_plan9.sh /n/sources/plan9/sys/src/libc/9syscall/sys.h"
   238  	mktypes="XXX"
   239  	;;
   240  solaris_amd64)
   241  	mksyscall="./mksyscall_solaris.pl"
   242  	mkerrors="$mkerrors -m64"
   243  	mksysnum=
   244  	mktypes="GOARCH=$GOARCH go tool cgo -godefs"
   245  	;;
   246  windows_*)
   247  	mksyscall=
   248  	mkerrors=
   249  	zerrors=
   250  	;;
   251  *)
   252  	echo 'unrecognized $GOOS_$GOARCH: ' "$GOOSARCH" 1>&2
   253  	exit 1
   254  	;;
   255  esac
   256  
   257  (
   258  	if [ -n "$mkerrors" ]; then echo "$mkerrors |gofmt >$zerrors"; fi
   259  	case "$GOOS" in
   260  	windows)
   261  		echo "GOOS= GOARCH= go build mksyscall_windows.go"
   262  		echo "./mksyscall_windows syscall_windows.go security_windows.go |gofmt >zsyscall_windows.go"
   263  		echo "rm -f ./mksyscall_windows"
   264  		;;
   265  	*)
   266  		syscall_goos="syscall_$GOOS.go"
   267  		case "$GOOS" in
   268  		darwin | dragonfly | freebsd | netbsd | openbsd)
   269  			syscall_goos="syscall_bsd.go $syscall_goos"
   270  			;;
   271  		esac
   272  		if [ -n "$mksyscall" ]; then echo "$mksyscall $syscall_goos $GOOSARCH_in |gofmt >zsyscall_$GOOSARCH.go"; fi
   273  		;;
   274  	esac
   275  	if [ -n "$mksysctl" ]; then echo "$mksysctl |gofmt >$zsysctl"; fi
   276  	if [ -n "$mksysnum" ]; then echo "$mksysnum |gofmt >zsysnum_$GOOSARCH.go"; fi
   277  	if [ -n "$mktypes" ]; then echo "$mktypes types_$GOOS.go |gofmt >ztypes_$GOOSARCH.go"; fi
   278  ) | $run