Text file src/syscall/mkall.sh
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 mkasm=
87 run="sh"
88
89 case "$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
103 esac
104
105 case "$#" in
106 0)
107 ;;
108 *)
109 echo 'usage: mkall.sh [-n]' 1>&2
110 exit 2
111 esac
112
113 GOOSARCH_in=syscall_$GOOSARCH.go
114 case "$GOOSARCH" in
115 _* | *_ | _)
116 echo 'undefined $GOOS_$GOARCH:' "$GOOSARCH" 1>&2
117 exit 1
118 ;;
119 aix_ppc64)
120 mkerrors="$mkerrors -maix64"
121 mksyscall="./mksyscall_libc.pl -aix"
122 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
123 ;;
124 darwin_386)
125 mkerrors="$mkerrors -m32"
126 mksyscall="./mksyscall.pl -l32 -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 ;;
131 darwin_amd64)
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 ;;
138 darwin_arm64)
139 mkerrors="$mkerrors -m64"
140 mksyscall="./mksyscall.pl -darwin"
141 mksysnum="./mksysnum_darwin.pl /usr/include/sys/syscall.h"
142 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
143 mkasm="go run mkasm_darwin.go"
144 ;;
145 darwin_arm)
146 mkerrors="$mkerrors -m32"
147 mksyscall="./mksyscall.pl -l32 -darwin"
148 mksysnum="./mksysnum_darwin.pl /usr/include/sys/syscall.h"
149 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
150 mkasm="go run mkasm_darwin.go"
151 ;;
152 dragonfly_amd64)
153 mkerrors="$mkerrors -m64"
154 mksyscall="./mksyscall.pl -dragonfly"
155 mksysnum="curl -s 'http://gitweb.dragonflybsd.org/dragonfly.git/blob_plain/HEAD:/sys/kern/syscalls.master' | ./mksysnum_dragonfly.pl"
156 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
157 ;;
158 freebsd_386)
159 mkerrors="$mkerrors -m32"
160 mksyscall="./mksyscall.pl -l32"
161 mksysnum="curl -s 'http://svn.freebsd.org/base/stable/10/sys/kern/syscalls.master' | ./mksysnum_freebsd.pl"
162 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
163 ;;
164 freebsd_amd64)
165 mkerrors="$mkerrors -m64"
166 mksysnum="curl -s 'http://svn.freebsd.org/base/stable/10/sys/kern/syscalls.master' | ./mksysnum_freebsd.pl"
167 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
168 ;;
169 freebsd_arm)
170 mkerrors="$mkerrors"
171 mksyscall="./mksyscall.pl -l32 -arm"
172 mksysnum="curl -s 'http://svn.freebsd.org/base/stable/10/sys/kern/syscalls.master' | ./mksysnum_freebsd.pl"
173 # Let the type of C char be signed to make the bare syscall
174 # API consistent between platforms.
175 mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char"
176 ;;
177 linux_386)
178 mkerrors="$mkerrors -m32"
179 mksyscall="./mksyscall.pl -l32"
180 mksysnum="./mksysnum_linux.pl /usr/include/asm/unistd_32.h"
181 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
182 ;;
183 linux_amd64)
184 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)
185 if [ "$unistd_h" = "" ]; then
186 echo >&2 cannot find unistd_64.h
187 exit 1
188 fi
189 mkerrors="$mkerrors -m64"
190 mksysnum="./mksysnum_linux.pl $unistd_h"
191 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
192 ;;
193 linux_arm)
194 mkerrors="$mkerrors"
195 mksyscall="./mksyscall.pl -l32 -arm"
196 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 -"
197 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
198 ;;
199 linux_arm64)
200 unistd_h=$(ls -1 /usr/include/asm/unistd.h /usr/include/asm-generic/unistd.h 2>/dev/null | head -1)
201 if [ "$unistd_h" = "" ]; then
202 echo >&2 cannot find unistd_64.h
203 exit 1
204 fi
205 mksysnum="./mksysnum_linux.pl $unistd_h"
206 # Let the type of C char be signed to make the bare syscall
207 # API consistent between platforms.
208 mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char"
209 ;;
210 linux_mips)
211 GOOSARCH_in=syscall_linux_mipsx.go
212 unistd_h=/usr/include/asm/unistd.h
213 mksyscall="./mksyscall.pl -b32 -arm"
214 mkerrors="$mkerrors"
215 mksysnum="./mksysnum_linux.pl $unistd_h"
216 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
217 ;;
218 linux_mipsle)
219 GOOSARCH_in=syscall_linux_mipsx.go
220 unistd_h=/usr/include/asm/unistd.h
221 mksyscall="./mksyscall.pl -l32 -arm"
222 mkerrors="$mkerrors"
223 mksysnum="./mksysnum_linux.pl $unistd_h"
224 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
225 ;;
226 linux_mips64)
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 ;;
233 linux_mips64le)
234 GOOSARCH_in=syscall_linux_mips64x.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 ;;
240 linux_ppc64)
241 GOOSARCH_in=syscall_linux_ppc64x.go
242 unistd_h=/usr/include/asm/unistd.h
243 mkerrors="$mkerrors -m64"
244 mksysnum="./mksysnum_linux.pl $unistd_h"
245 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
246 ;;
247 linux_ppc64le)
248 GOOSARCH_in=syscall_linux_ppc64x.go
249 unistd_h=/usr/include/powerpc64le-linux-gnu/asm/unistd.h
250 mkerrors="$mkerrors -m64"
251 mksysnum="./mksysnum_linux.pl $unistd_h"
252 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
253 ;;
254 linux_s390x)
255 GOOSARCH_in=syscall_linux_s390x.go
256 unistd_h=/usr/include/asm/unistd.h
257 mkerrors="$mkerrors -m64"
258 mksysnum="./mksysnum_linux.pl $unistd_h"
259 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
260 ;;
261 nacl_386)
262 mkerrors=""
263 mksyscall="./mksyscall.pl -l32 -nacl"
264 mksysnum=""
265 mktypes=""
266 ;;
267 nacl_amd64p32)
268 mkerrors=""
269 mksyscall="./mksyscall.pl -nacl"
270 mksysnum=""
271 mktypes=""
272 ;;
273 netbsd_386)
274 mkerrors="$mkerrors -m32"
275 mksyscall="./mksyscall.pl -l32 -netbsd"
276 mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl"
277 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
278 ;;
279 netbsd_amd64)
280 mkerrors="$mkerrors -m64"
281 mksyscall="./mksyscall.pl -netbsd"
282 mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl"
283 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
284 ;;
285 netbsd_arm)
286 mkerrors="$mkerrors -m32"
287 mksyscall="./mksyscall.pl -l32 -netbsd -arm"
288 mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl"
289 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
290 ;;
291 netbsd_arm64)
292 mkerrors="$mkerrors -m64"
293 mksyscall="./mksyscall.pl -netbsd"
294 mksysnum="curl -s 'http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_netbsd.pl"
295 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
296 ;;
297 openbsd_386)
298 mkerrors="$mkerrors -m32"
299 mksyscall="./mksyscall.pl -l32 -openbsd"
300 mksysctl="./mksysctl_openbsd.pl"
301 zsysctl="zsysctl_openbsd.go"
302 mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl"
303 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
304 ;;
305 openbsd_amd64)
306 mkerrors="$mkerrors -m64"
307 mksyscall="./mksyscall.pl -openbsd"
308 mksysctl="./mksysctl_openbsd.pl"
309 zsysctl="zsysctl_openbsd.go"
310 mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl"
311 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
312 ;;
313 openbsd_arm)
314 mkerrors="$mkerrors"
315 mksyscall="./mksyscall.pl -l32 -openbsd -arm"
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 ;;
323 openbsd_arm64)
324 mkerrors="$mkerrors -m64"
325 mksyscall="./mksyscall.pl -openbsd"
326 mksysctl="./mksysctl_openbsd.pl"
327 zsysctl="zsysctl_openbsd.go"
328 mksysnum="curl -s 'http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/sys/kern/syscalls.master' | ./mksysnum_openbsd.pl"
329 # Let the type of C char be signed to make the bare syscall
330 # API consistent between platforms.
331 mktypes="GOARCH=$GOARCH go tool cgo -godefs -- -fsigned-char"
332 ;;
333 plan9_386)
334 mkerrors=
335 mksyscall="./mksyscall.pl -l32 -plan9"
336 mksysnum="./mksysnum_plan9.sh /n/sources/plan9/sys/src/libc/9syscall/sys.h"
337 mktypes="XXX"
338 ;;
339 solaris_amd64)
340 mksyscall="./mksyscall_libc.pl -solaris"
341 mkerrors="$mkerrors -m64"
342 mksysnum=
343 mktypes="GOARCH=$GOARCH go tool cgo -godefs"
344 ;;
345 windows_*)
346 echo 'run "go generate" instead' 1>&2
347 exit 1
348 ;;
349 *)
350 echo 'unrecognized $GOOS_$GOARCH: ' "$GOOSARCH" 1>&2
351 exit 1
352 ;;
353 esac
354
355 (
356 if [ -n "$mkerrors" ]; then echo "$mkerrors |gofmt >$zerrors"; fi
357 syscall_goos="syscall_$GOOS.go"
358 case "$GOOS" in
359 darwin | dragonfly | freebsd | netbsd | openbsd)
360 syscall_goos="syscall_bsd.go $syscall_goos"
361 ;;
362 esac
363 if [ -n "$mksyscall" ]; then echo "$mksyscall -tags $GOOS,$GOARCH $syscall_goos $GOOSARCH_in |gofmt >zsyscall_$GOOSARCH.go"; fi
364 if [ -n "$mksysctl" ]; then echo "$mksysctl |gofmt >$zsysctl"; fi
365 if [ -n "$mksysnum" ]; then echo "$mksysnum |gofmt >zsysnum_$GOOSARCH.go"; fi
366 if [ -n "$mktypes" ]; then
367 # ztypes_$GOOSARCH.go could be erased before "go run mkpost.go" is called.
368 # Therefore, "go run" tries to recompile syscall package but ztypes is empty and it fails.
369 echo "$mktypes types_$GOOS.go |go run mkpost.go >ztypes_$GOOSARCH.go.NEW && mv ztypes_$GOOSARCH.go.NEW ztypes_$GOOSARCH.go";
370 fi
371 if [ -n "$mkasm" ]; then echo "$mkasm $GOARCH"; fi
372 ) | $run
View as plain text