• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..07-Jul-2021-

.gitignoreH A D07-Jul-202116 32

README.mdH A D07-Jul-20218 KiB174130

affinity_linux.goH A D07-Jul-20211.9 KiB8757

aliases.goH A D07-Jul-2021372 155

asm_aix_ppc64.sH A D07-Jul-2021410 185

asm_darwin_386.sH A D07-Jul-2021675 3011

asm_darwin_amd64.sH A D07-Jul-2021678 3011

asm_darwin_arm.sH A D07-Jul-2021686 3111

asm_darwin_arm64.sH A D07-Jul-2021691 3111

asm_dragonfly_amd64.sH A D07-Jul-2021681 3011

asm_freebsd_386.sH A D07-Jul-2021676 3011

asm_freebsd_amd64.sH A D07-Jul-2021679 3011

asm_freebsd_arm.sH A D07-Jul-2021666 3011

asm_freebsd_arm64.sH A D07-Jul-2021679 3011

asm_linux_386.sH A D07-Jul-20211.4 KiB6640

asm_linux_amd64.sH A D07-Jul-20211.2 KiB5837

asm_linux_arm.sH A D07-Jul-20211.1 KiB5736

asm_linux_arm64.sH A D07-Jul-20211.1 KiB5335

asm_linux_mips64x.sH A D07-Jul-20211.1 KiB5735

asm_linux_mipsx.sH A D07-Jul-20211.1 KiB5532

asm_linux_ppc64x.sH A D07-Jul-2021921 4527

asm_linux_riscv64.sH A D07-Jul-20211.1 KiB5536

asm_linux_s390x.sH A D07-Jul-20211.1 KiB5735

asm_netbsd_386.sH A D07-Jul-2021675 3011

asm_netbsd_amd64.sH A D07-Jul-2021678 3011

asm_netbsd_arm.sH A D07-Jul-2021665 3011

asm_netbsd_arm64.sH A D07-Jul-2021668 3011

asm_openbsd_386.sH A D07-Jul-2021676 3011

asm_openbsd_amd64.sH A D07-Jul-2021679 3011

asm_openbsd_arm.sH A D07-Jul-2021666 3011

asm_openbsd_arm64.sH A D07-Jul-2021679 3011

asm_solaris_amd64.sH A D07-Jul-2021426 185

bluetooth_linux.goH A D07-Jul-2021655 3624

cap_freebsd.goH A D07-Jul-20215 KiB196148

constants.goH A D07-Jul-2021289 146

dev_aix_ppc.goH A D07-Jul-2021745 2810

dev_aix_ppc64.goH A D07-Jul-2021864 3012

dev_darwin.goH A D07-Jul-2021747 2510

dev_dragonfly.goH A D07-Jul-20211 KiB3110

dev_freebsd.goH A D07-Jul-20211,013 3110

dev_linux.goH A D07-Jul-20211.5 KiB4318

dev_netbsd.goH A D07-Jul-2021913 3015

dev_openbsd.goH A D07-Jul-2021918 3015

dirent.goH A D07-Jul-20213 KiB10385

endian_big.goH A D07-Jul-2021236 102

endian_little.goH A D07-Jul-2021274 102

env_unix.goH A D07-Jul-2021616 3217

errors_freebsd_386.goH A D07-Jul-20219.2 KiB228219

errors_freebsd_amd64.goH A D07-Jul-20219.2 KiB228219

errors_freebsd_arm.goH A D07-Jul-20218.8 KiB227219

fcntl.goH A D07-Jul-2021980 3318

fcntl_darwin.goH A D07-Jul-2021587 199

fcntl_linux_32bit.goH A D07-Jul-2021388 144

gccgo.goH A D07-Jul-20212 KiB6340

gccgo_c.cH A D07-Jul-20211 KiB4024

gccgo_linux_amd64.goH A D07-Jul-2021429 2110

ioctl.goH A D07-Jul-20212 KiB6633

mkall.shH A D07-Jul-20217.9 KiB230197

mkerrors.shH A D07-Jul-202116.7 KiB685606

pagesize_unix.goH A D07-Jul-2021367 165

pledge_openbsd.goH A D07-Jul-20213.7 KiB164102

race.goH A D07-Jul-2021607 3118

race0.goH A D07-Jul-2021509 2613

readdirent_getdents.goH A D07-Jul-2021385 134

readdirent_getdirentries.goH A D07-Jul-2021697 206

sockcmsg_linux.goH A D07-Jul-20211 KiB3721

sockcmsg_unix.goH A D07-Jul-20213.2 KiB12183

str.goH A D07-Jul-2021615 2718

syscall.goH A D07-Jul-20212 KiB5418

syscall_aix.goH A D07-Jul-202115.1 KiB537303

syscall_aix_ppc.goH A D07-Jul-20211.3 KiB5531

syscall_aix_ppc64.goH A D07-Jul-20212 KiB8656

syscall_bsd.goH A D07-Jul-202115.2 KiB617461

syscall_darwin.1_12.goH A D07-Jul-2021811 3018

syscall_darwin.1_13.goH A D07-Jul-20212.7 KiB10463

syscall_darwin.goH A D07-Jul-202118.5 KiB681249

syscall_darwin_386.1_11.goH A D07-Jul-2021302 101

syscall_darwin_386.goH A D07-Jul-20212.1 KiB7035

syscall_darwin_amd64.1_11.goH A D07-Jul-2021304 101

syscall_darwin_amd64.goH A D07-Jul-20212.1 KiB7035

syscall_darwin_arm.1_11.goH A D07-Jul-2021300 124

syscall_darwin_arm.goH A D07-Jul-20212 KiB7341

syscall_darwin_arm64.1_11.goH A D07-Jul-2021302 124

syscall_darwin_arm64.goH A D07-Jul-20212 KiB7541

syscall_darwin_libSystem.goH A D07-Jul-20211.4 KiB3412

syscall_dragonfly.goH A D07-Jul-202113.6 KiB522158

syscall_dragonfly_amd64.goH A D07-Jul-20211.2 KiB5738

syscall_freebsd.goH A D07-Jul-202124.4 KiB880433

syscall_freebsd_386.goH A D07-Jul-20211.3 KiB5738

syscall_freebsd_amd64.goH A D07-Jul-20211.2 KiB5738

syscall_freebsd_arm.goH A D07-Jul-20211.3 KiB5738

syscall_freebsd_arm64.goH A D07-Jul-20211.2 KiB5738

syscall_linux.goH A D07-Jul-202157.4 KiB1,9741,171

syscall_linux_386.goH A D07-Jul-202110.7 KiB391274

syscall_linux_amd64.goH A D07-Jul-20216.4 KiB19592

syscall_linux_amd64_gc.goH A D07-Jul-2021297 143

syscall_linux_arm.goH A D07-Jul-20218.8 KiB292172

syscall_linux_arm64.goH A D07-Jul-20216.8 KiB228133

syscall_linux_gc.goH A D07-Jul-2021495 153

syscall_linux_gc_386.goH A D07-Jul-2021582 175

syscall_linux_gccgo_386.goH A D07-Jul-2021979 3120

syscall_linux_gccgo_arm.goH A D07-Jul-2021589 2112

syscall_linux_mips64x.goH A D07-Jul-20216.7 KiB227131

syscall_linux_mipsx.goH A D07-Jul-20217.2 KiB239131

syscall_linux_ppc64x.goH A D07-Jul-20216 KiB15757

syscall_linux_riscv64.goH A D07-Jul-20216.9 KiB231136

syscall_linux_s390x.goH A D07-Jul-202110.5 KiB343241

syscall_linux_sparc64.goH A D07-Jul-20215.3 KiB15264

syscall_netbsd.goH A D07-Jul-202116 KiB621186

syscall_netbsd_386.goH A D07-Jul-2021815 3824

syscall_netbsd_amd64.goH A D07-Jul-2021810 3824

syscall_netbsd_arm.goH A D07-Jul-2021815 3824

syscall_netbsd_arm64.goH A D07-Jul-2021810 3824

syscall_openbsd.goH A D07-Jul-202111.4 KiB415178

syscall_openbsd_386.goH A D07-Jul-2021996 4225

syscall_openbsd_amd64.goH A D07-Jul-2021986 4225

syscall_openbsd_arm.goH A D07-Jul-2021996 4225

syscall_openbsd_arm64.goH A D07-Jul-2021986 4225

syscall_solaris.goH A D07-Jul-202120.6 KiB725458

syscall_solaris_amd64.goH A D07-Jul-2021589 2816

syscall_unix.goH A D07-Jul-202110.7 KiB432334

syscall_unix_gc.goH A D07-Jul-2021622 166

syscall_unix_gc_ppc64x.goH A D07-Jul-2021798 2514

timestruct.goH A D07-Jul-20212.5 KiB8344

unveil_openbsd.goH A D07-Jul-20211 KiB4328

xattr_bsd.goH A D07-Jul-20215 KiB241178

zerrors_aix_ppc.goH A D07-Jul-202152 KiB1,3751,356

zerrors_aix_ppc64.goH A D07-Jul-202152.3 KiB1,3761,357

zerrors_darwin_386.goH A D07-Jul-202172.8 KiB1,7851,766

zerrors_darwin_amd64.goH A D07-Jul-202172.8 KiB1,7851,766

zerrors_darwin_arm.goH A D07-Jul-202172.8 KiB1,7851,766

zerrors_darwin_arm64.goH A D07-Jul-202172.8 KiB1,7851,766

zerrors_dragonfly_amd64.goH A D07-Jul-202167.1 KiB1,6521,633

zerrors_freebsd_386.goH A D07-Jul-202169.9 KiB1,7951,776

zerrors_freebsd_amd64.goH A D07-Jul-202169.9 KiB1,7961,777

zerrors_freebsd_arm.goH A D07-Jul-202170.2 KiB1,8041,785

zerrors_freebsd_arm64.goH A D07-Jul-202169.9 KiB1,7961,777

zerrors_linux_386.goH A D07-Jul-2021136.7 KiB3,1243,105

zerrors_linux_amd64.goH A D07-Jul-2021136.7 KiB3,1243,105

zerrors_linux_arm.goH A D07-Jul-2021137 KiB3,1303,111

zerrors_linux_arm64.goH A D07-Jul-2021136.5 KiB3,1173,098

zerrors_linux_mips.goH A D07-Jul-2021137.2 KiB3,1313,112

zerrors_linux_mips64.goH A D07-Jul-2021137.3 KiB3,1313,112

zerrors_linux_mips64le.goH A D07-Jul-2021137.3 KiB3,1313,112

zerrors_linux_mipsle.goH A D07-Jul-2021137.3 KiB3,1313,112

zerrors_linux_ppc64.goH A D07-Jul-2021139.7 KiB3,1863,167

zerrors_linux_ppc64le.goH A D07-Jul-2021139.7 KiB3,1863,167

zerrors_linux_riscv64.goH A D07-Jul-2021136.2 KiB3,1113,092

zerrors_linux_s390x.goH A D07-Jul-2021139.4 KiB3,1843,165

zerrors_linux_sparc64.goH A D07-Jul-2021139.5 KiB3,1803,161

zerrors_netbsd_386.goH A D07-Jul-202172.5 KiB1,7741,755

zerrors_netbsd_amd64.goH A D07-Jul-202172.1 KiB1,7641,745

zerrors_netbsd_arm.goH A D07-Jul-202171.6 KiB1,7531,734

zerrors_netbsd_arm64.goH A D07-Jul-202172.1 KiB1,7641,745

zerrors_openbsd_386.goH A D07-Jul-202167.9 KiB1,6581,639

zerrors_openbsd_amd64.goH A D07-Jul-202172.4 KiB1,7681,749

zerrors_openbsd_arm.goH A D07-Jul-202167.9 KiB1,6601,641

zerrors_openbsd_arm64.goH A D07-Jul-202173.5 KiB1,7911,772

zerrors_solaris_amd64.goH A D07-Jul-202158.1 KiB1,5341,515

zptrace386_linux.goH A D07-Jul-20211.8 KiB8162

zptracearm_linux.goH A D07-Jul-20211.2 KiB4223

zptracemips_linux.goH A D07-Jul-20211.4 KiB5132

zptracemipsle_linux.goH A D07-Jul-20211.4 KiB5132

zsyscall_aix_ppc.goH A D07-Jul-202136.1 KiB1,485992

zsyscall_aix_ppc64.goH A D07-Jul-202130.5 KiB1,4431,073

zsyscall_aix_ppc64_gc.goH A D07-Jul-202142.4 KiB1,193594

zsyscall_aix_ppc64_gccgo.goH A D07-Jul-202130.7 KiB1,071590

zsyscall_darwin_386.1_11.goH A D07-Jul-202143 KiB1,8121,381

zsyscall_darwin_386.1_13.goH A D07-Jul-20211.1 KiB4220

zsyscall_darwin_386.1_13.sH A D07-Jul-2021344 137

zsyscall_darwin_386.goH A D07-Jul-202166.8 KiB2,5001,513

zsyscall_darwin_386.sH A D07-Jul-20219.7 KiB285279

zsyscall_darwin_amd64.1_11.goH A D07-Jul-202142.8 KiB1,8121,381

zsyscall_darwin_amd64.1_13.goH A D07-Jul-20211.1 KiB4220

zsyscall_darwin_amd64.1_13.sH A D07-Jul-2021346 137

zsyscall_darwin_amd64.goH A D07-Jul-202166.6 KiB2,5001,513

zsyscall_darwin_amd64.sH A D07-Jul-20219.7 KiB285279

zsyscall_darwin_arm.1_11.goH A D07-Jul-202141.8 KiB1,7691,347

zsyscall_darwin_arm.1_13.goH A D07-Jul-20211.1 KiB4220

zsyscall_darwin_arm.1_13.sH A D07-Jul-2021344 137

zsyscall_darwin_arm.goH A D07-Jul-202165.6 KiB2,4641,491

zsyscall_darwin_arm.sH A D07-Jul-20219.5 KiB281275

zsyscall_darwin_arm64.1_11.goH A D07-Jul-202141.6 KiB1,7691,347

zsyscall_darwin_arm64.1_13.goH A D07-Jul-20211.1 KiB4220

zsyscall_darwin_arm64.1_13.sH A D07-Jul-2021346 137

zsyscall_darwin_arm64.goH A D07-Jul-202165.4 KiB2,4641,491

zsyscall_darwin_arm64.sH A D07-Jul-20219.5 KiB281275

zsyscall_dragonfly_amd64.goH A D07-Jul-202139.1 KiB1,6781,271

zsyscall_freebsd_386.goH A D07-Jul-202148.5 KiB2,0271,551

zsyscall_freebsd_amd64.goH A D07-Jul-202148.3 KiB2,0271,551

zsyscall_freebsd_arm.goH A D07-Jul-202148.6 KiB2,0271,551

zsyscall_freebsd_arm64.goH A D07-Jul-202148.3 KiB2,0271,551

zsyscall_linux_386.goH A D07-Jul-202155.1 KiB2,3011,777

zsyscall_linux_amd64.goH A D07-Jul-202159.6 KiB2,4681,899

zsyscall_linux_arm.goH A D07-Jul-202159.2 KiB2,4381,878

zsyscall_linux_arm64.goH A D07-Jul-202156.4 KiB2,3251,792

zsyscall_linux_mips.goH A D07-Jul-202160.1 KiB2,4811,909

zsyscall_linux_mips64.goH A D07-Jul-202159.2 KiB2,4521,889

zsyscall_linux_mips64le.goH A D07-Jul-202159.2 KiB2,4521,889

zsyscall_linux_mipsle.goH A D07-Jul-202160.1 KiB2,4811,909

zsyscall_linux_ppc64.goH A D07-Jul-202161.1 KiB2,5301,946

zsyscall_linux_ppc64le.goH A D07-Jul-202161.1 KiB2,5301,946

zsyscall_linux_riscv64.goH A D07-Jul-202155.9 KiB2,3051,775

zsyscall_linux_s390x.goH A D07-Jul-202154.9 KiB2,3001,779

zsyscall_linux_sparc64.goH A D07-Jul-202159.5 KiB2,4631,897

zsyscall_netbsd_386.goH A D07-Jul-202143.4 KiB1,8281,403

zsyscall_netbsd_amd64.goH A D07-Jul-202143.2 KiB1,8281,403

zsyscall_netbsd_arm.goH A D07-Jul-202143.4 KiB1,8281,403

zsyscall_netbsd_arm64.goH A D07-Jul-202143.2 KiB1,8281,403

zsyscall_openbsd_386.goH A D07-Jul-202139.5 KiB1,6941,284

zsyscall_openbsd_amd64.goH A D07-Jul-202139.4 KiB1,6941,284

zsyscall_openbsd_arm.goH A D07-Jul-202139.5 KiB1,6941,284

zsyscall_openbsd_arm64.goH A D07-Jul-202139.4 KiB1,6941,284

zsyscall_solaris_amd64.goH A D07-Jul-202153.8 KiB1,9551,305

zsysctl_openbsd_386.goH A D07-Jul-202111.7 KiB273265

zsysctl_openbsd_amd64.goH A D07-Jul-202111.6 KiB271263

zsysctl_openbsd_arm.goH A D07-Jul-202111.7 KiB273265

zsysctl_openbsd_arm64.goH A D07-Jul-202111.8 KiB276268

zsysnum_darwin_386.goH A D07-Jul-202117.7 KiB437430

zsysnum_darwin_amd64.goH A D07-Jul-202117.8 KiB439432

zsysnum_darwin_arm.goH A D07-Jul-202117.7 KiB437430

zsysnum_darwin_arm64.goH A D07-Jul-202117.7 KiB437430

zsysnum_dragonfly_amd64.goH A D07-Jul-202126.4 KiB316307

zsysnum_freebsd_386.goH A D07-Jul-202136.2 KiB397389

zsysnum_freebsd_amd64.goH A D07-Jul-202136.2 KiB397389

zsysnum_freebsd_arm.goH A D07-Jul-202136.2 KiB397389

zsysnum_freebsd_arm64.goH A D07-Jul-202136.2 KiB397389

zsysnum_linux_386.goH A D07-Jul-202116.7 KiB435428

zsysnum_linux_amd64.goH A D07-Jul-202111.6 KiB357350

zsysnum_linux_arm.goH A D07-Jul-202115.3 KiB399392

zsysnum_linux_arm64.goH A D07-Jul-20219.8 KiB301294

zsysnum_linux_mips.goH A D07-Jul-202116.6 KiB419412

zsysnum_linux_mips64.goH A D07-Jul-202111.8 KiB349342

zsysnum_linux_mips64le.goH A D07-Jul-202111.8 KiB349342

zsysnum_linux_mipsle.goH A D07-Jul-202116.6 KiB419412

zsysnum_linux_ppc64.goH A D07-Jul-202113 KiB399392

zsysnum_linux_ppc64le.goH A D07-Jul-202113 KiB399392

zsysnum_linux_riscv64.goH A D07-Jul-20219.8 KiB301294

zsysnum_linux_s390x.goH A D07-Jul-202111.9 KiB364357

zsysnum_linux_sparc64.goH A D07-Jul-202112.3 KiB378371

zsysnum_netbsd_386.goH A D07-Jul-202125.7 KiB275268

zsysnum_netbsd_amd64.goH A D07-Jul-202125.7 KiB275268

zsysnum_netbsd_arm.goH A D07-Jul-202125.7 KiB275268

zsysnum_netbsd_arm64.goH A D07-Jul-202125.7 KiB275268

zsysnum_openbsd_386.goH A D07-Jul-202117.8 KiB219212

zsysnum_openbsd_amd64.goH A D07-Jul-202117.8 KiB219212

zsysnum_openbsd_arm.goH A D07-Jul-202117.8 KiB219212

zsysnum_openbsd_arm64.goH A D07-Jul-202117.8 KiB218211

ztypes_aix_ppc.goH A D07-Jul-20214.9 KiB353295

ztypes_aix_ppc64.goH A D07-Jul-20214.9 KiB357299

ztypes_darwin_386.goH A D07-Jul-20217.2 KiB500434

ztypes_darwin_amd64.goH A D07-Jul-20217.4 KiB510444

ztypes_darwin_arm.goH A D07-Jul-20217.2 KiB501434

ztypes_darwin_arm64.goH A D07-Jul-20217.4 KiB510444

ztypes_dragonfly_amd64.goH A D07-Jul-20216.8 KiB470411

ztypes_freebsd_386.goH A D07-Jul-202110.6 KiB701622

ztypes_freebsd_amd64.goH A D07-Jul-202110.6 KiB707628

ztypes_freebsd_arm.goH A D07-Jul-202110.4 KiB684605

ztypes_freebsd_arm64.goH A D07-Jul-202110.3 KiB685606

ztypes_linux_386.goH A D07-Jul-202165.1 KiB2,6092,402

ztypes_linux_amd64.goH A D07-Jul-202165.3 KiB2,6232,416

ztypes_linux_arm.goH A D07-Jul-202165 KiB2,6002,393

ztypes_linux_arm64.goH A D07-Jul-202165 KiB2,6022,395

ztypes_linux_mips.goH A D07-Jul-202165.1 KiB2,6062,399

ztypes_linux_mips64.goH A D07-Jul-202165 KiB2,6042,397

ztypes_linux_mips64le.goH A D07-Jul-202165 KiB2,6042,397

ztypes_linux_mipsle.goH A D07-Jul-202165.1 KiB2,6062,399

ztypes_linux_ppc64.goH A D07-Jul-202165.2 KiB2,6122,405

ztypes_linux_ppc64le.goH A D07-Jul-202165.2 KiB2,6122,405

ztypes_linux_riscv64.goH A D07-Jul-202165.3 KiB2,6302,423

ztypes_linux_s390x.goH A D07-Jul-202165.5 KiB2,6262,416

ztypes_linux_sparc64.goH A D07-Jul-202165 KiB2,6072,400

ztypes_netbsd_386.goH A D07-Jul-20216.8 KiB467402

ztypes_netbsd_amd64.goH A D07-Jul-20216.9 KiB474409

ztypes_netbsd_arm.goH A D07-Jul-20216.9 KiB472407

ztypes_netbsd_arm64.goH A D07-Jul-20216.9 KiB474409

ztypes_openbsd_386.goH A D07-Jul-20219.4 KiB572507

ztypes_openbsd_amd64.goH A D07-Jul-20219.3 KiB572507

ztypes_openbsd_arm.goH A D07-Jul-20219.3 KiB573508

ztypes_openbsd_arm64.goH A D07-Jul-20219.2 KiB566501

ztypes_solaris_amd64.goH A D07-Jul-20216.4 KiB443383

README.md

1# Building `sys/unix`
2
3The sys/unix package provides access to the raw system call interface of the
4underlying operating system. See: https://godoc.org/golang.org/x/sys/unix
5
6Porting Go to a new architecture/OS combination or adding syscalls, types, or
7constants to an existing architecture/OS pair requires some manual effort;
8however, there are tools that automate much of the process.
9
10## Build Systems
11
12There are currently two ways we generate the necessary files. We are currently
13migrating the build system to use containers so the builds are reproducible.
14This is being done on an OS-by-OS basis. Please update this documentation as
15components of the build system change.
16
17### Old Build System (currently for `GOOS != "linux"`)
18
19The old build system generates the Go files based on the C header files
20present on your system. This means that files
21for a given GOOS/GOARCH pair must be generated on a system with that OS and
22architecture. This also means that the generated code can differ from system
23to system, based on differences in the header files.
24
25To avoid this, if you are using the old build system, only generate the Go
26files on an installation with unmodified header files. It is also important to
27keep track of which version of the OS the files were generated from (ex.
28Darwin 14 vs Darwin 15). This makes it easier to track the progress of changes
29and have each OS upgrade correspond to a single change.
30
31To build the files for your current OS and architecture, make sure GOOS and
32GOARCH are set correctly and run `mkall.sh`. This will generate the files for
33your specific system. Running `mkall.sh -n` shows the commands that will be run.
34
35Requirements: bash, go
36
37### New Build System (currently for `GOOS == "linux"`)
38
39The new build system uses a Docker container to generate the go files directly
40from source checkouts of the kernel and various system libraries. This means
41that on any platform that supports Docker, all the files using the new build
42system can be generated at once, and generated files will not change based on
43what the person running the scripts has installed on their computer.
44
45The OS specific files for the new build system are located in the `${GOOS}`
46directory, and the build is coordinated by the `${GOOS}/mkall.go` program. When
47the kernel or system library updates, modify the Dockerfile at
48`${GOOS}/Dockerfile` to checkout the new release of the source.
49
50To build all the files under the new build system, you must be on an amd64/Linux
51system and have your GOOS and GOARCH set accordingly. Running `mkall.sh` will
52then generate all of the files for all of the GOOS/GOARCH pairs in the new build
53system. Running `mkall.sh -n` shows the commands that will be run.
54
55Requirements: bash, go, docker
56
57## Component files
58
59This section describes the various files used in the code generation process.
60It also contains instructions on how to modify these files to add a new
61architecture/OS or to add additional syscalls, types, or constants. Note that
62if you are using the new build system, the scripts/programs cannot be called normally.
63They must be called from within the docker container.
64
65### asm files
66
67The hand-written assembly file at `asm_${GOOS}_${GOARCH}.s` implements system
68call dispatch. There are three entry points:
69```
70  func Syscall(trap, a1, a2, a3 uintptr) (r1, r2, err uintptr)
71  func Syscall6(trap, a1, a2, a3, a4, a5, a6 uintptr) (r1, r2, err uintptr)
72  func RawSyscall(trap, a1, a2, a3 uintptr) (r1, r2, err uintptr)
73```
74The first and second are the standard ones; they differ only in how many
75arguments can be passed to the kernel. The third is for low-level use by the
76ForkExec wrapper. Unlike the first two, it does not call into the scheduler to
77let it know that a system call is running.
78
79When porting Go to an new architecture/OS, this file must be implemented for
80each GOOS/GOARCH pair.
81
82### mksysnum
83
84Mksysnum is a Go program located at `${GOOS}/mksysnum.go` (or `mksysnum_${GOOS}.go`
85for the old system). This program takes in a list of header files containing the
86syscall number declarations and parses them to produce the corresponding list of
87Go numeric constants. See `zsysnum_${GOOS}_${GOARCH}.go` for the generated
88constants.
89
90Adding new syscall numbers is mostly done by running the build on a sufficiently
91new installation of the target OS (or updating the source checkouts for the
92new build system). However, depending on the OS, you make need to update the
93parsing in mksysnum.
94
95### mksyscall.go
96
97The `syscall.go`, `syscall_${GOOS}.go`, `syscall_${GOOS}_${GOARCH}.go` are
98hand-written Go files which implement system calls (for unix, the specific OS,
99or the specific OS/Architecture pair respectively) that need special handling
100and list `//sys` comments giving prototypes for ones that can be generated.
101
102The mksyscall.go program takes the `//sys` and `//sysnb` comments and converts
103them into syscalls. This requires the name of the prototype in the comment to
104match a syscall number in the `zsysnum_${GOOS}_${GOARCH}.go` file. The function
105prototype can be exported (capitalized) or not.
106
107Adding a new syscall often just requires adding a new `//sys` function prototype
108with the desired arguments and a capitalized name so it is exported. However, if
109you want the interface to the syscall to be different, often one will make an
110unexported `//sys` prototype, an then write a custom wrapper in
111`syscall_${GOOS}.go`.
112
113### types files
114
115For each OS, there is a hand-written Go file at `${GOOS}/types.go` (or
116`types_${GOOS}.go` on the old system). This file includes standard C headers and
117creates Go type aliases to the corresponding C types. The file is then fed
118through godef to get the Go compatible definitions. Finally, the generated code
119is fed though mkpost.go to format the code correctly and remove any hidden or
120private identifiers. This cleaned-up code is written to
121`ztypes_${GOOS}_${GOARCH}.go`.
122
123The hardest part about preparing this file is figuring out which headers to
124include and which symbols need to be `#define`d to get the actual data
125structures that pass through to the kernel system calls. Some C libraries
126preset alternate versions for binary compatibility and translate them on the
127way in and out of system calls, but there is almost always a `#define` that can
128get the real ones.
129See `types_darwin.go` and `linux/types.go` for examples.
130
131To add a new type, add in the necessary include statement at the top of the
132file (if it is not already there) and add in a type alias line. Note that if
133your type is significantly different on different architectures, you may need
134some `#if/#elif` macros in your include statements.
135
136### mkerrors.sh
137
138This script is used to generate the system's various constants. This doesn't
139just include the error numbers and error strings, but also the signal numbers
140an a wide variety of miscellaneous constants. The constants come from the list
141of include files in the `includes_${uname}` variable. A regex then picks out
142the desired `#define` statements, and generates the corresponding Go constants.
143The error numbers and strings are generated from `#include <errno.h>`, and the
144signal numbers and strings are generated from `#include <signal.h>`. All of
145these constants are written to `zerrors_${GOOS}_${GOARCH}.go` via a C program,
146`_errors.c`, which prints out all the constants.
147
148To add a constant, add the header that includes it to the appropriate variable.
149Then, edit the regex (if necessary) to match the desired constant. Avoid making
150the regex too broad to avoid matching unintended constants.
151
152
153## Generated files
154
155### `zerror_${GOOS}_${GOARCH}.go`
156
157A file containing all of the system's generated error numbers, error strings,
158signal numbers, and constants. Generated by `mkerrors.sh` (see above).
159
160### `zsyscall_${GOOS}_${GOARCH}.go`
161
162A file containing all the generated syscalls for a specific GOOS and GOARCH.
163Generated by `mksyscall.go` (see above).
164
165### `zsysnum_${GOOS}_${GOARCH}.go`
166
167A list of numeric constants for all the syscall number of the specific GOOS
168and GOARCH. Generated by mksysnum (see above).
169
170### `ztypes_${GOOS}_${GOARCH}.go`
171
172A file containing Go types for passing into (or returning from) syscalls.
173Generated by godefs and the types file (see above).
174