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 darwin_arm64) 128 mkerrors="$mkerrors -m64" 129 mksysnum="./mksysnum_darwin.pl /usr/include/sys/syscall.h" 130 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 131 ;; 132 dragonfly_386) 133 mkerrors="$mkerrors -m32" 134 mksyscall="./mksyscall.pl -l32 -dragonfly" 135 mksysnum="curl -s 'http://gitweb.dragonflybsd.org/dragonfly.git/blob_plain/HEAD:/sys/kern/syscalls.master' | ./mksysnum_dragonfly.pl" 136 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 137 ;; 138 dragonfly_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 ;; 144 freebsd_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 ;; 150 freebsd_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 ;; 155 freebsd_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 singed for making the bare syscall 160 # API consistent across over platforms. 161 mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char" 162 ;; 163 linux_386) 164 mkerrors="$mkerrors -m32" 165 mksyscall="./mksyscall.pl -l32" 166 mksysnum="./mksysnum_linux.pl /usr/include/asm/unistd_32.h" 167 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 168 ;; 169 linux_amd64) 170 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) 171 if [ "$unistd_h" = "" ]; then 172 echo >&2 cannot find unistd_64.h 173 exit 1 174 fi 175 mkerrors="$mkerrors -m64" 176 mksysnum="./mksysnum_linux.pl $unistd_h" 177 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 178 ;; 179 linux_arm) 180 mkerrors="$mkerrors" 181 mksyscall="./mksyscall.pl -l32 -arm" 182 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 -" 183 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 184 ;; 185 linux_arm64) 186 unistd_h=$(ls -1 /usr/include/asm/unistd.h /usr/include/asm-generic/unistd.h 2>/dev/null | head -1) 187 if [ "$unistd_h" = "" ]; then 188 echo >&2 cannot find unistd_64.h 189 exit 1 190 fi 191 mksysnum="./mksysnum_linux.pl $unistd_h" 192 # Let the type of C char be singed for making the bare syscall 193 # API consistent across over platforms. 194 mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char" 195 ;; 196 linux_ppc64) 197 GOOSARCH_in=syscall_linux_ppc64x.go 198 unistd_h=/usr/include/asm/unistd.h 199 mkerrors="$mkerrors -m64" 200 mksysnum="./mksysnum_linux.pl $unistd_h" 201 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 202 ;; 203 linux_ppc64le) 204 GOOSARCH_in=syscall_linux_ppc64x.go 205 unistd_h=/usr/include/powerpc64le-linux-gnu/asm/unistd.h 206 mkerrors="$mkerrors -m64" 207 mksysnum="./mksysnum_linux.pl $unistd_h" 208 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 209 ;; 210 nacl_386) 211 mkerrors="" 212 mksyscall="./mksyscall.pl -l32 -nacl" 213 mksysnum="" 214 mktypes="" 215 ;; 216 nacl_amd64p32) 217 mkerrors="" 218 mksyscall="./mksyscall.pl -nacl" 219 mksysnum="" 220 mktypes="" 221 ;; 222 netbsd_386) 223 mkerrors="$mkerrors -m32" 224 mksyscall="./mksyscall.pl -l32 -netbsd" 225 mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl" 226 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 227 ;; 228 netbsd_amd64) 229 mkerrors="$mkerrors -m64" 230 mksyscall="./mksyscall.pl -netbsd" 231 mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl" 232 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 233 ;; 234 openbsd_386) 235 mkerrors="$mkerrors -m32" 236 mksyscall="./mksyscall.pl -l32 -openbsd" 237 mksysctl="./mksysctl_openbsd.pl" 238 zsysctl="zsysctl_openbsd.go" 239 mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl" 240 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 241 ;; 242 openbsd_amd64) 243 mkerrors="$mkerrors -m64" 244 mksyscall="./mksyscall.pl -openbsd" 245 mksysctl="./mksysctl_openbsd.pl" 246 zsysctl="zsysctl_openbsd.go" 247 mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl" 248 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 249 ;; 250 openbsd_arm) 251 mkerrors="$mkerrors" 252 mksyscall="./mksyscall.pl -l32 -openbsd -arm" 253 mksysctl="./mksysctl_openbsd.pl" 254 zsysctl="zsysctl_openbsd.go" 255 mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl" 256 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 257 ;; 258 plan9_386) 259 mkerrors= 260 mksyscall="./mksyscall.pl -l32 -plan9" 261 mksysnum="./mksysnum_plan9.sh /n/sources/plan9/sys/src/libc/9syscall/sys.h" 262 mktypes="XXX" 263 ;; 264 solaris_amd64) 265 mksyscall="./mksyscall_solaris.pl" 266 mkerrors="$mkerrors -m64" 267 mksysnum= 268 mktypes="GOARCH=$GOARCH go tool cgo -godefs" 269 ;; 270 windows_*) 271 echo 'run "go generate syscall_windows.go" instead' 1>&2 272 exit 1 273 ;; 274 *) 275 echo 'unrecognized $GOOS_$GOARCH: ' "$GOOSARCH" 1>&2 276 exit 1 277 ;; 278 esac 279 280 ( 281 if [ -n "$mkerrors" ]; then echo "$mkerrors |gofmt >$zerrors"; fi 282 syscall_goos="syscall_$GOOS.go" 283 case "$GOOS" in 284 darwin | dragonfly | freebsd | netbsd | openbsd) 285 syscall_goos="syscall_bsd.go $syscall_goos" 286 ;; 287 esac 288 if [ -n "$mksyscall" ]; then echo "$mksyscall $syscall_goos $GOOSARCH_in |gofmt >zsyscall_$GOOSARCH.go"; fi 289 if [ -n "$mksysctl" ]; then echo "$mksysctl |gofmt >$zsysctl"; fi 290 if [ -n "$mksysnum" ]; then echo "$mksysnum |gofmt >zsysnum_$GOOSARCH.go"; fi 291 if [ -n "$mktypes" ]; then echo "$mktypes types_$GOOS.go |gofmt >ztypes_$GOOSARCH.go"; fi 292 ) | $run 293
