src/syscall/syscall_darwin.go

   1 // Copyright 2009,2010 The Go Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style
   3 // license that can be found in the LICENSE file.
   4
   5 // Darwin system calls.
   6 // This file is compiled as ordinary Go code,
   7 // but it is also input to mksyscall,
   8 // which parses the //sys lines and generates system call stubs.
   9 // Note that sometimes we use a lowercase //sys name and wrap
  10 // it in our own nicer implementation, either here or in
  11 // syscall_bsd.go or syscall_unix.go.
  12
  13 package syscall
  14
  15 import "unsafe"
  16
  17 type SockaddrDatalink struct {
  18         Len    uint8
  19         Family uint8
  20         Index  uint16
  21         Type   uint8
  22         Nlen   uint8
  23         Alen   uint8
  24         Slen   uint8
  25         Data   [12]int8
  26         raw    RawSockaddrDatalink
  27 }
  28
  29 // Translate "kern.hostname" to []_C_int{0,1,2,3}.
  30 func nametomib(name string) (mib []_C_int, err error) {
  31         const siz = unsafe.Sizeof(mib[0])
  32
  33         // NOTE(rsc): It seems strange to set the buffer to have
  34         // size CTL_MAXNAME+2 but use only CTL_MAXNAME
  35         // as the size. I don't know why the +2 is here, but the
  36         // kernel uses +2 for its own implementation of this function.
  37         // I am scared that if we don't include the +2 here, the kernel
  38         // will silently write 2 words farther than we specify
  39         // and we'll get memory corruption.
  40         var buf [CTL_MAXNAME + 2]_C_int
  41         n := uintptr(CTL_MAXNAME) * siz
  42
  43         p := (*byte)(unsafe.Pointer(&buf[0]))
  44         bytes, err := ByteSliceFromString(name)
  45         if err != nil {
  46                 return nil, err
  47         }
  48
  49         // Magic sysctl: "setting" 0.3 to a string name
  50         // lets you read back the array of integers form.
  51         if err = sysctl([]_C_int{0, 3}, p, &n, &bytes[0], uintptr(len(name))); err != nil {
  52                 return nil, err
  53         }
  54         return buf[0 : n/siz], nil
  55 }
  56
  57 func direntIno(buf []byte) (uint64, bool) {
  58         return readInt(buf, unsafe.Offsetof(Dirent{}.Ino), unsafe.Sizeof(Dirent{}.Ino))
  59 }
  60
  61 func direntReclen(buf []byte) (uint64, bool) {
  62         return readInt(buf, unsafe.Offsetof(Dirent{}.Reclen), unsafe.Sizeof(Dirent{}.Reclen))
  63 }
  64
  65 func direntNamlen(buf []byte) (uint64, bool) {
  66         return readInt(buf, unsafe.Offsetof(Dirent{}.Namlen), unsafe.Sizeof(Dirent{}.Namlen))
  67 }
  68
  69 func PtraceAttach(pid int) (err error) { return ptrace(PT_ATTACH, pid, 0, 0) }
  70 func PtraceDetach(pid int) (err error) { return ptrace(PT_DETACH, pid, 0, 0) }
  71
  72 const (
  73         attrBitMapCount = 5
  74         attrCmnModtime  = 0x00000400
  75         attrCmnAcctime  = 0x00001000
  76 )
  77
  78 type attrList struct {
  79         bitmapCount uint16
  80         _           uint16
  81         CommonAttr  uint32
  82         VolAttr     uint32
  83         DirAttr     uint32
  84         FileAttr    uint32
  85         Forkattr    uint32
  86 }
  87
  88 //sysnb pipe(p *[2]int32) (err error)
  89
  90 func Pipe(p []int) (err error) {
  91         if len(p) != 2 {
  92                 return EINVAL
  93         }
  94         var q [2]int32
  95         err = pipe(&q)
  96         p[0] = int(q[0])
  97         p[1] = int(q[1])
  98         return
  99 }
 100
 101 func Getfsstat(buf []Statfs_t, flags int) (n int, err error) {
 102         var _p0 unsafe.Pointer
 103         var bufsize uintptr
 104         if len(buf) > 0 {
 105                 _p0 = unsafe.Pointer(&buf[0])
 106                 bufsize = unsafe.Sizeof(Statfs_t{}) * uintptr(len(buf))
 107         }
 108         r0, _, e1 := syscall(funcPC(libc_getfsstat_trampoline), uintptr(_p0), bufsize, uintptr(flags))
 109         n = int(r0)
 110         if e1 != 0 {
 111                 err = e1
 112         }
 113         return
 114 }
 115
 116 func libc_getfsstat_trampoline()
 117
 118 //go:cgo_import_dynamic libc_getfsstat getfsstat "/usr/lib/libSystem.B.dylib"
 119
 120 func setattrlistTimes(path string, times []Timespec) error {
 121         _p0, err := BytePtrFromString(path)
 122         if err != nil {
 123                 return err
 124         }
 125
 126         var attrList attrList
 127         attrList.bitmapCount = attrBitMapCount
 128         attrList.CommonAttr = attrCmnModtime | attrCmnAcctime
 129
 130         // order is mtime, atime: the opposite of Chtimes
 131         attributes := [2]Timespec{times[1], times[0]}
 132         const options = 0
 133         _, _, e1 := syscall6(
 134                 funcPC(libc_setattrlist_trampoline),
 135                 uintptr(unsafe.Pointer(_p0)),
 136                 uintptr(unsafe.Pointer(&attrList)),
 137                 uintptr(unsafe.Pointer(&attributes)),
 138                 uintptr(unsafe.Sizeof(attributes)),
 139                 uintptr(options),
 140                 0,
 141         )
 142         if e1 != 0 {
 143                 return e1
 144         }
 145         return nil
 146 }
 147
 148 func libc_setattrlist_trampoline()
 149
 150 //go:cgo_import_dynamic libc_setattrlist setattrlist "/usr/lib/libSystem.B.dylib"
 151
 152 func utimensat(dirfd int, path string, times *[2]Timespec, flag int) error {
 153         // Darwin doesn't support SYS_UTIMENSAT
 154         return ENOSYS
 155 }
 156
 157 /*
 158  * Wrapped
 159  */
 160
 161 //sys   kill(pid int, signum int, posix int) (err error)
 162
 163 func Kill(pid int, signum Signal) (err error) { return kill(pid, int(signum), 1) }
 164
 165 /*
 166  * Exposed directly
 167  */
 168 //sys   Access(path string, mode uint32) (err error)
 169 //sys   Adjtime(delta *Timeval, olddelta *Timeval) (err error)
 170 //sys   Chdir(path string) (err error)
 171 //sys   Chflags(path string, flags int) (err error)
 172 //sys   Chmod(path string, mode uint32) (err error)
 173 //sys   Chown(path string, uid int, gid int) (err error)
 174 //sys   Chroot(path string) (err error)
 175 //sys   Close(fd int) (err error)
 176 //sys   closedir(dir uintptr) (err error)
 177 //sys   Dup(fd int) (nfd int, err error)
 178 //sys   Dup2(from int, to int) (err error)
 179 //sys   Exchangedata(path1 string, path2 string, options int) (err error)
 180 //sys   Fchdir(fd int) (err error)
 181 //sys   Fchflags(fd int, flags int) (err error)
 182 //sys   Fchmod(fd int, mode uint32) (err error)
 183 //sys   Fchown(fd int, uid int, gid int) (err error)
 184 //sys   Flock(fd int, how int) (err error)
 185 //sys   Fpathconf(fd int, name int) (val int, err error)
 186 //sys   Fsync(fd int) (err error)
 187 //  Fsync is not called for os.File.Sync(). Please see internal/poll/fd_fsync_darwin.go
 188 //sys   Ftruncate(fd int, length int64) (err error)
 189 //sys   Getdtablesize() (size int)
 190 //sysnb Getegid() (egid int)
 191 //sysnb Geteuid() (uid int)
 192 //sysnb Getgid() (gid int)
 193 //sysnb Getpgid(pid int) (pgid int, err error)
 194 //sysnb Getpgrp() (pgrp int)
 195 //sysnb Getpid() (pid int)
 196 //sysnb Getppid() (ppid int)
 197 //sys   Getpriority(which int, who int) (prio int, err error)
 198 //sysnb Getrlimit(which int, lim *Rlimit) (err error)
 199 //sysnb Getrusage(who int, rusage *Rusage) (err error)
 200 //sysnb Getsid(pid int) (sid int, err error)
 201 //sysnb Getuid() (uid int)
 202 //sysnb Issetugid() (tainted bool)
 203 //sys   Kqueue() (fd int, err error)
 204 //sys   Lchown(path string, uid int, gid int) (err error)
 205 //sys   Link(path string, link string) (err error)
 206 //sys   Listen(s int, backlog int) (err error)
 207 //sys   Mkdir(path string, mode uint32) (err error)
 208 //sys   Mkfifo(path string, mode uint32) (err error)
 209 //sys   Mknod(path string, mode uint32, dev int) (err error)
 210 //sys   Mlock(b []byte) (err error)
 211 //sys   Mlockall(flags int) (err error)
 212 //sys   Mprotect(b []byte, prot int) (err error)
 213 //sys   Munlock(b []byte) (err error)
 214 //sys   Munlockall() (err error)
 215 //sys   Open(path string, mode int, perm uint32) (fd int, err error)
 216 //sys   Pathconf(path string, name int) (val int, err error)
 217 //sys   Pread(fd int, p []byte, offset int64) (n int, err error)
 218 //sys   Pwrite(fd int, p []byte, offset int64) (n int, err error)
 219 //sys   read(fd int, p []byte) (n int, err error)
 220 //sys   readdir_r(dir uintptr, entry *Dirent, result **Dirent) (res Errno)
 221 //sys   Readlink(path string, buf []byte) (n int, err error)
 222 //sys   Rename(from string, to string) (err error)
 223 //sys   Revoke(path string) (err error)
 224 //sys   Rmdir(path string) (err error)
 225 //sys   Seek(fd int, offset int64, whence int) (newoffset int64, err error) = SYS_lseek
 226 //sys   Select(n int, r *FdSet, w *FdSet, e *FdSet, timeout *Timeval) (err error)
 227 //sys   Setegid(egid int) (err error)
 228 //sysnb Seteuid(euid int) (err error)
 229 //sysnb Setgid(gid int) (err error)
 230 //sys   Setlogin(name string) (err error)
 231 //sysnb Setpgid(pid int, pgid int) (err error)
 232 //sys   Setpriority(which int, who int, prio int) (err error)
 233 //sys   Setprivexec(flag int) (err error)
 234 //sysnb Setregid(rgid int, egid int) (err error)
 235 //sysnb Setreuid(ruid int, euid int) (err error)
 236 //sysnb Setrlimit(which int, lim *Rlimit) (err error)
 237 //sysnb Setsid() (pid int, err error)
 238 //sysnb Settimeofday(tp *Timeval) (err error)
 239 //sysnb Setuid(uid int) (err error)
 240 //sys   Symlink(path string, link string) (err error)
 241 //sys   Sync() (err error)
 242 //sys   Truncate(path string, length int64) (err error)
 243 //sys   Umask(newmask int) (oldmask int)
 244 //sys   Undelete(path string) (err error)
 245 //sys   Unlink(path string) (err error)
 246 //sys   Unmount(path string, flags int) (err error)
 247 //sys   write(fd int, p []byte) (n int, err error)
 248 //sys   writev(fd int, iovecs []Iovec) (cnt uintptr, err error)
 249 //sys   mmap(addr uintptr, length uintptr, prot int, flag int, fd int, pos int64) (ret uintptr, err error)
 250 //sys   munmap(addr uintptr, length uintptr) (err error)
 251 //sysnb fork() (pid int, err error)
 252 //sysnb ioctl(fd int, req int, arg int) (err error)
 253 //sysnb ioctlPtr(fd int, req uint, arg unsafe.Pointer) (err error) = SYS_ioctl
 254 //sysnb execve(path *byte, argv **byte, envp **byte) (err error)
 255 //sysnb exit(res int) (err error)
 256 //sys   sysctl(mib []_C_int, old *byte, oldlen *uintptr, new *byte, newlen uintptr) (err error)
 257 //sys   fcntlPtr(fd int, cmd int, arg unsafe.Pointer) (val int, err error) = SYS_fcntl
 258 //sys   unlinkat(fd int, path string, flags int) (err error)
 259 //sys   openat(fd int, path string, flags int, perm uint32) (fdret int, err error)
 260 //sys   getcwd(buf []byte) (n int, err error)
 261
 262 func init() {
 263         execveDarwin = execve
 264 }
 265
 266 func fdopendir(fd int) (dir uintptr, err error) {
 267         r0, _, e1 := syscallPtr(funcPC(libc_fdopendir_trampoline), uintptr(fd), 0, 0)
 268         dir = uintptr(r0)
 269         if e1 != 0 {
 270                 err = errnoErr(e1)
 271         }
 272         return
 273 }
 274
 275 func libc_fdopendir_trampoline()
 276
 277 //go:cgo_import_dynamic libc_fdopendir fdopendir "/usr/lib/libSystem.B.dylib"
 278
 279 func readlen(fd int, buf *byte, nbuf int) (n int, err error) {
 280         r0, _, e1 := syscall(funcPC(libc_read_trampoline), uintptr(fd), uintptr(unsafe.Pointer(buf)), uintptr(nbuf))
 281         n = int(r0)
 282         if e1 != 0 {
 283                 err = errnoErr(e1)
 284         }
 285         return
 286 }
 287
 288 func writelen(fd int, buf *byte, nbuf int) (n int, err error) {
 289         r0, _, e1 := syscall(funcPC(libc_write_trampoline), uintptr(fd), uintptr(unsafe.Pointer(buf)), uintptr(nbuf))
 290         n = int(r0)
 291         if e1 != 0 {
 292                 err = errnoErr(e1)
 293         }
 294         return
 295 }
 296
 297 func Getdirentries(fd int, buf []byte, basep *uintptr) (n int, err error) {
 298         // Simulate Getdirentries using fdopendir/readdir_r/closedir.
 299         // We store the number of entries to skip in the seek
 300         // offset of fd. See issue #31368.
 301         // It's not the full required semantics, but should handle the case
 302         // of calling Getdirentries or ReadDirent repeatedly.
 303         // It won't handle assigning the results of lseek to *basep, or handle
 304         // the directory being edited underfoot.
 305         skip, err := Seek(fd, 0, 1 /* SEEK_CUR */)
 306         if err != nil {
 307                 return 0, err
 308         }
 309
 310         // We need to duplicate the incoming file descriptor
 311         // because the caller expects to retain control of it, but
 312         // fdopendir expects to take control of its argument.
 313         // Just Dup'ing the file descriptor is not enough, as the
 314         // result shares underlying state. Use openat to make a really
 315         // new file descriptor referring to the same directory.
 316         fd2, err := openat(fd, ".", O_RDONLY, 0)
 317         if err != nil {
 318                 return 0, err
 319         }
 320         d, err := fdopendir(fd2)
 321         if err != nil {
 322                 Close(fd2)
 323                 return 0, err
 324         }
 325         defer closedir(d)
 326
 327         var cnt int64
 328         for {
 329                 var entry Dirent
 330                 var entryp *Dirent
 331                 e := readdir_r(d, &entry, &entryp)
 332                 if e != 0 {
 333                         return n, errnoErr(e)
 334                 }
 335                 if entryp == nil {
 336                         break
 337                 }
 338                 if skip > 0 {
 339                         skip--
 340                         cnt++
 341                         continue
 342                 }
 343                 reclen := int(entry.Reclen)
 344                 if reclen > len(buf) {
 345                         // Not enough room. Return for now.
 346                         // The counter will let us know where we should start up again.
 347                         // Note: this strategy for suspending in the middle and
 348                         // restarting is O(n^2) in the length of the directory. Oh well.
 349                         break
 350                 }
 351                 // Copy entry into return buffer.
 352                 s := struct {
 353                         ptr unsafe.Pointer
 354                         siz int
 355                         cap int
 356                 }{ptr: unsafe.Pointer(&entry), siz: reclen, cap: reclen}
 357                 copy(buf, *(*[]byte)(unsafe.Pointer(&s)))
 358                 buf = buf[reclen:]
 359                 n += reclen
 360                 cnt++
 361         }
 362         // Set the seek offset of the input fd to record
 363         // how many files we've already returned.
 364         _, err = Seek(fd, cnt, 0 /* SEEK_SET */)
 365         if err != nil {
 366                 return n, err
 367         }
 368
 369         return n, nil
 370 }
 371
 372 // Implemented in the runtime package (runtime/sys_darwin.go)
 373 func syscall(fn, a1, a2, a3 uintptr) (r1, r2 uintptr, err Errno)
 374 func syscall6(fn, a1, a2, a3, a4, a5, a6 uintptr) (r1, r2 uintptr, err Errno)
 375 func syscall6X(fn, a1, a2, a3, a4, a5, a6 uintptr) (r1, r2 uintptr, err Errno)
 376 func rawSyscall(fn, a1, a2, a3 uintptr) (r1, r2 uintptr, err Errno)
 377 func rawSyscall6(fn, a1, a2, a3, a4, a5, a6 uintptr) (r1, r2 uintptr, err Errno)
 378 func syscallPtr(fn, a1, a2, a3 uintptr) (r1, r2 uintptr, err Errno)
 379
 380 // Find the entry point for f. See comments in runtime/proc.go for the
 381 // function of the same name.
 382 //go:nosplit
 383 func funcPC(f func()) uintptr {
 384         return **(**uintptr)(unsafe.Pointer(&f))
 385 }