1 // Copyright 2009 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.
5 // +build darwin dragonfly freebsd netbsd openbsd
7 // BSD system call wrappers shared by *BSD based systems
8 // including OS X (Darwin) and FreeBSD. Like the other
9 // syscall_*.go files it is compiled as Go code but also
10 // used as input to mksyscall which parses the //sys
11 // lines and generates system call stubs.
21 const ImplementsGetwd = true
23 func Getwd() (string, error) {
25 _, err := Getcwd(buf[0:])
33 return string(buf[:n]), nil
40 //sysnb getgroups(ngid int, gid *_Gid_t) (n int, err error)
41 //sysnb setgroups(ngid int, gid *_Gid_t) (err error)
43 func Getgroups() (gids []int, err error) {
44 n, err := getgroups(0, nil)
52 // Sanity check group count. Max is 16 on BSD.
53 if n < 0 || n > 1000 {
57 a := make([]_Gid_t, n)
58 n, err = getgroups(n, &a[0])
63 for i, v := range a[0:n] {
69 func Setgroups(gids []int) (err error) {
71 return setgroups(0, nil)
74 a := make([]_Gid_t, len(gids))
75 for i, v := range gids {
78 return setgroups(len(a), &a[0])
81 // Wait status is 7 bits at bottom, either 0 (exited),
82 // 0x7F (stopped), or a signal number that caused an exit.
83 // The 0x80 bit is whether there was a core dump.
84 // An extra number (exit code, signal causing a stop)
85 // is in the high bits.
87 type WaitStatus uint32
99 func (w WaitStatus) Exited() bool { return w&mask == exited }
101 func (w WaitStatus) ExitStatus() int {
102 if w&mask != exited {
105 return int(w >> shift)
108 func (w WaitStatus) Signaled() bool { return w&mask != stopped && w&mask != 0 }
110 func (w WaitStatus) Signal() syscall.Signal {
111 sig := syscall.Signal(w & mask)
112 if sig == stopped || sig == 0 {
118 func (w WaitStatus) CoreDump() bool { return w.Signaled() && w&core != 0 }
120 func (w WaitStatus) Stopped() bool { return w&mask == stopped && syscall.Signal(w>>shift) != SIGSTOP }
122 func (w WaitStatus) Killed() bool { return w&mask == killed && syscall.Signal(w>>shift) != SIGKILL }
124 func (w WaitStatus) Continued() bool { return w&mask == stopped && syscall.Signal(w>>shift) == SIGSTOP }
126 func (w WaitStatus) StopSignal() syscall.Signal {
130 return syscall.Signal(w>>shift) & 0xFF
133 func (w WaitStatus) TrapCause() int { return -1 }
135 //sys wait4(pid int, wstatus *_C_int, options int, rusage *Rusage) (wpid int, err error)
137 func Wait4(pid int, wstatus *WaitStatus, options int, rusage *Rusage) (wpid int, err error) {
139 wpid, err = wait4(pid, &status, options, rusage)
141 *wstatus = WaitStatus(status)
146 //sys accept(s int, rsa *RawSockaddrAny, addrlen *_Socklen) (fd int, err error)
147 //sys bind(s int, addr unsafe.Pointer, addrlen _Socklen) (err error)
148 //sys connect(s int, addr unsafe.Pointer, addrlen _Socklen) (err error)
149 //sysnb socket(domain int, typ int, proto int) (fd int, err error)
150 //sys getsockopt(s int, level int, name int, val unsafe.Pointer, vallen *_Socklen) (err error)
151 //sys setsockopt(s int, level int, name int, val unsafe.Pointer, vallen uintptr) (err error)
152 //sysnb getpeername(fd int, rsa *RawSockaddrAny, addrlen *_Socklen) (err error)
153 //sysnb getsockname(fd int, rsa *RawSockaddrAny, addrlen *_Socklen) (err error)
154 //sys Shutdown(s int, how int) (err error)
156 func (sa *SockaddrInet4) sockaddr() (unsafe.Pointer, _Socklen, error) {
157 if sa.Port < 0 || sa.Port > 0xFFFF {
158 return nil, 0, EINVAL
160 sa.raw.Len = SizeofSockaddrInet4
161 sa.raw.Family = AF_INET
162 p := (*[2]byte)(unsafe.Pointer(&sa.raw.Port))
163 p[0] = byte(sa.Port >> 8)
165 for i := 0; i < len(sa.Addr); i++ {
166 sa.raw.Addr[i] = sa.Addr[i]
168 return unsafe.Pointer(&sa.raw), _Socklen(sa.raw.Len), nil
171 func (sa *SockaddrInet6) sockaddr() (unsafe.Pointer, _Socklen, error) {
172 if sa.Port < 0 || sa.Port > 0xFFFF {
173 return nil, 0, EINVAL
175 sa.raw.Len = SizeofSockaddrInet6
176 sa.raw.Family = AF_INET6
177 p := (*[2]byte)(unsafe.Pointer(&sa.raw.Port))
178 p[0] = byte(sa.Port >> 8)
180 sa.raw.Scope_id = sa.ZoneId
181 for i := 0; i < len(sa.Addr); i++ {
182 sa.raw.Addr[i] = sa.Addr[i]
184 return unsafe.Pointer(&sa.raw), _Socklen(sa.raw.Len), nil
187 func (sa *SockaddrUnix) sockaddr() (unsafe.Pointer, _Socklen, error) {
190 if n >= len(sa.raw.Path) || n == 0 {
191 return nil, 0, EINVAL
193 sa.raw.Len = byte(3 + n) // 2 for Family, Len; 1 for NUL
194 sa.raw.Family = AF_UNIX
195 for i := 0; i < n; i++ {
196 sa.raw.Path[i] = int8(name[i])
198 return unsafe.Pointer(&sa.raw), _Socklen(sa.raw.Len), nil
201 func (sa *SockaddrDatalink) sockaddr() (unsafe.Pointer, _Socklen, error) {
203 return nil, 0, EINVAL
206 sa.raw.Family = AF_LINK
207 sa.raw.Index = sa.Index
208 sa.raw.Type = sa.Type
209 sa.raw.Nlen = sa.Nlen
210 sa.raw.Alen = sa.Alen
211 sa.raw.Slen = sa.Slen
212 for i := 0; i < len(sa.raw.Data); i++ {
213 sa.raw.Data[i] = sa.Data[i]
215 return unsafe.Pointer(&sa.raw), SizeofSockaddrDatalink, nil
218 func anyToSockaddr(fd int, rsa *RawSockaddrAny) (Sockaddr, error) {
219 switch rsa.Addr.Family {
221 pp := (*RawSockaddrDatalink)(unsafe.Pointer(rsa))
222 sa := new(SockaddrDatalink)
224 sa.Family = pp.Family
230 for i := 0; i < len(sa.Data); i++ {
231 sa.Data[i] = pp.Data[i]
236 pp := (*RawSockaddrUnix)(unsafe.Pointer(rsa))
237 if pp.Len < 2 || pp.Len > SizeofSockaddrUnix {
240 sa := new(SockaddrUnix)
242 // Some BSDs include the trailing NUL in the length, whereas
243 // others do not. Work around this by subtracting the leading
244 // family and len. The path is then scanned to see if a NUL
245 // terminator still exists within the length.
246 n := int(pp.Len) - 2 // subtract leading Family, Len
247 for i := 0; i < n; i++ {
249 // found early NUL; assume Len included the NUL
250 // or was overestimating.
255 bytes := (*[len(pp.Path)]byte)(unsafe.Pointer(&pp.Path[0]))[0:n]
256 sa.Name = string(bytes)
260 pp := (*RawSockaddrInet4)(unsafe.Pointer(rsa))
261 sa := new(SockaddrInet4)
262 p := (*[2]byte)(unsafe.Pointer(&pp.Port))
263 sa.Port = int(p[0])<<8 + int(p[1])
264 for i := 0; i < len(sa.Addr); i++ {
265 sa.Addr[i] = pp.Addr[i]
270 pp := (*RawSockaddrInet6)(unsafe.Pointer(rsa))
271 sa := new(SockaddrInet6)
272 p := (*[2]byte)(unsafe.Pointer(&pp.Port))
273 sa.Port = int(p[0])<<8 + int(p[1])
274 sa.ZoneId = pp.Scope_id
275 for i := 0; i < len(sa.Addr); i++ {
276 sa.Addr[i] = pp.Addr[i]
280 return anyToSockaddrGOOS(fd, rsa)
283 func Accept(fd int) (nfd int, sa Sockaddr, err error) {
284 var rsa RawSockaddrAny
285 var len _Socklen = SizeofSockaddrAny
286 nfd, err = accept(fd, &rsa, &len)
290 if (runtime.GOOS == "darwin" || runtime.GOOS == "ios") && len == 0 {
291 // Accepted socket has no address.
292 // This is likely due to a bug in xnu kernels,
293 // where instead of ECONNABORTED error socket
294 // is accepted, but has no address.
296 return 0, nil, ECONNABORTED
298 sa, err = anyToSockaddr(fd, &rsa)
306 func Getsockname(fd int) (sa Sockaddr, err error) {
307 var rsa RawSockaddrAny
308 var len _Socklen = SizeofSockaddrAny
309 if err = getsockname(fd, &rsa, &len); err != nil {
312 // TODO(jsing): DragonFly has a "bug" (see issue 3349), which should be
313 // reported upstream.
314 if runtime.GOOS == "dragonfly" && rsa.Addr.Family == AF_UNSPEC && rsa.Addr.Len == 0 {
315 rsa.Addr.Family = AF_UNIX
316 rsa.Addr.Len = SizeofSockaddrUnix
318 return anyToSockaddr(fd, &rsa)
321 //sysnb socketpair(domain int, typ int, proto int, fd *[2]int32) (err error)
323 // GetsockoptString returns the string value of the socket option opt for the
324 // socket associated with fd at the given socket level.
325 func GetsockoptString(fd, level, opt int) (string, error) {
326 buf := make([]byte, 256)
327 vallen := _Socklen(len(buf))
328 err := getsockopt(fd, level, opt, unsafe.Pointer(&buf[0]), &vallen)
332 return string(buf[:vallen-1]), nil
335 //sys recvfrom(fd int, p []byte, flags int, from *RawSockaddrAny, fromlen *_Socklen) (n int, err error)
336 //sys sendto(s int, buf []byte, flags int, to unsafe.Pointer, addrlen _Socklen) (err error)
337 //sys recvmsg(s int, msg *Msghdr, flags int) (n int, err error)
339 func Recvmsg(fd int, p, oob []byte, flags int) (n, oobn int, recvflags int, from Sockaddr, err error) {
341 var rsa RawSockaddrAny
342 msg.Name = (*byte)(unsafe.Pointer(&rsa))
343 msg.Namelen = uint32(SizeofSockaddrAny)
346 iov.Base = (*byte)(unsafe.Pointer(&p[0]))
351 // receive at least one normal byte
356 msg.Control = (*byte)(unsafe.Pointer(&oob[0]))
357 msg.SetControllen(len(oob))
361 if n, err = recvmsg(fd, &msg, flags); err != nil {
364 oobn = int(msg.Controllen)
365 recvflags = int(msg.Flags)
366 // source address is only specified if the socket is unconnected
367 if rsa.Addr.Family != AF_UNSPEC {
368 from, err = anyToSockaddr(fd, &rsa)
373 //sys sendmsg(s int, msg *Msghdr, flags int) (n int, err error)
375 func Sendmsg(fd int, p, oob []byte, to Sockaddr, flags int) (err error) {
376 _, err = SendmsgN(fd, p, oob, to, flags)
380 func SendmsgN(fd int, p, oob []byte, to Sockaddr, flags int) (n int, err error) {
381 var ptr unsafe.Pointer
384 ptr, salen, err = to.sockaddr()
390 msg.Name = (*byte)(unsafe.Pointer(ptr))
391 msg.Namelen = uint32(salen)
394 iov.Base = (*byte)(unsafe.Pointer(&p[0]))
399 // send at least one normal byte
404 msg.Control = (*byte)(unsafe.Pointer(&oob[0]))
405 msg.SetControllen(len(oob))
409 if n, err = sendmsg(fd, &msg, flags); err != nil {
412 if len(oob) > 0 && len(p) == 0 {
418 //sys kevent(kq int, change unsafe.Pointer, nchange int, event unsafe.Pointer, nevent int, timeout *Timespec) (n int, err error)
420 func Kevent(kq int, changes, events []Kevent_t, timeout *Timespec) (n int, err error) {
421 var change, event unsafe.Pointer
422 if len(changes) > 0 {
423 change = unsafe.Pointer(&changes[0])
426 event = unsafe.Pointer(&events[0])
428 return kevent(kq, change, len(changes), event, len(events), timeout)
431 // sysctlmib translates name to mib number and appends any additional args.
432 func sysctlmib(name string, args ...int) ([]_C_int, error) {
433 // Translate name to mib number.
434 mib, err := nametomib(name)
439 for _, a := range args {
440 mib = append(mib, _C_int(a))
446 func Sysctl(name string) (string, error) {
447 return SysctlArgs(name)
450 func SysctlArgs(name string, args ...int) (string, error) {
451 buf, err := SysctlRaw(name, args...)
457 // Throw away terminating NUL.
458 if n > 0 && buf[n-1] == '\x00' {
461 return string(buf[0:n]), nil
464 func SysctlUint32(name string) (uint32, error) {
465 return SysctlUint32Args(name)
468 func SysctlUint32Args(name string, args ...int) (uint32, error) {
469 mib, err := sysctlmib(name, args...)
475 buf := make([]byte, 4)
476 if err := sysctl(mib, &buf[0], &n, nil, 0); err != nil {
482 return *(*uint32)(unsafe.Pointer(&buf[0])), nil
485 func SysctlUint64(name string, args ...int) (uint64, error) {
486 mib, err := sysctlmib(name, args...)
492 buf := make([]byte, 8)
493 if err := sysctl(mib, &buf[0], &n, nil, 0); err != nil {
499 return *(*uint64)(unsafe.Pointer(&buf[0])), nil
502 func SysctlRaw(name string, args ...int) ([]byte, error) {
503 mib, err := sysctlmib(name, args...)
510 if err := sysctl(mib, nil, &n, nil, 0); err != nil {
517 // Read into buffer of that size.
518 buf := make([]byte, n)
519 if err := sysctl(mib, &buf[0], &n, nil, 0); err != nil {
523 // The actual call may return less than the original reported required
524 // size so ensure we deal with that.
528 func SysctlClockinfo(name string) (*Clockinfo, error) {
529 mib, err := sysctlmib(name)
534 n := uintptr(SizeofClockinfo)
536 if err := sysctl(mib, (*byte)(unsafe.Pointer(&ci)), &n, nil, 0); err != nil {
539 if n != SizeofClockinfo {
545 func SysctlTimeval(name string) (*Timeval, error) {
546 mib, err := sysctlmib(name)
552 n := uintptr(unsafe.Sizeof(tv))
553 if err := sysctl(mib, (*byte)(unsafe.Pointer(&tv)), &n, nil, 0); err != nil {
556 if n != unsafe.Sizeof(tv) {
562 //sys utimes(path string, timeval *[2]Timeval) (err error)
564 func Utimes(path string, tv []Timeval) error {
566 return utimes(path, nil)
571 return utimes(path, (*[2]Timeval)(unsafe.Pointer(&tv[0])))
574 func UtimesNano(path string, ts []Timespec) error {
576 err := utimensat(AT_FDCWD, path, nil, 0)
580 return utimes(path, nil)
585 // Darwin setattrlist can set nanosecond timestamps
586 err := setattrlistTimes(path, ts, 0)
590 err = utimensat(AT_FDCWD, path, (*[2]Timespec)(unsafe.Pointer(&ts[0])), 0)
594 // Not as efficient as it could be because Timespec and
595 // Timeval have different types in the different OSes
597 NsecToTimeval(TimespecToNsec(ts[0])),
598 NsecToTimeval(TimespecToNsec(ts[1])),
600 return utimes(path, (*[2]Timeval)(unsafe.Pointer(&tv[0])))
603 func UtimesNanoAt(dirfd int, path string, ts []Timespec, flags int) error {
605 return utimensat(dirfd, path, nil, flags)
610 err := setattrlistTimes(path, ts, flags)
614 return utimensat(dirfd, path, (*[2]Timespec)(unsafe.Pointer(&ts[0])), flags)
617 //sys futimes(fd int, timeval *[2]Timeval) (err error)
619 func Futimes(fd int, tv []Timeval) error {
621 return futimes(fd, nil)
626 return futimes(fd, (*[2]Timeval)(unsafe.Pointer(&tv[0])))
629 //sys poll(fds *PollFd, nfds int, timeout int) (n int, err error)
631 func Poll(fds []PollFd, timeout int) (n int, err error) {
633 return poll(nil, 0, timeout)
635 return poll(&fds[0], len(fds), timeout)
639 // Acct(name nil-string) (err error)
640 // Gethostuuid(uuid *byte, timeout *Timespec) (err error)
641 // Ptrace(req int, pid int, addr uintptr, data int) (ret uintptr, err error)
643 var mapper = &mmapper{
644 active: make(map[*byte][]byte),
649 func Mmap(fd int, offset int64, length int, prot int, flags int) (data []byte, err error) {
650 return mapper.Mmap(fd, offset, length, prot, flags)
653 func Munmap(b []byte) (err error) {
654 return mapper.Munmap(b)
657 //sys Madvise(b []byte, behav int) (err error)
658 //sys Mlock(b []byte) (err error)
659 //sys Mlockall(flags int) (err error)
660 //sys Mprotect(b []byte, prot int) (err error)
661 //sys Msync(b []byte, flags int) (err error)
662 //sys Munlock(b []byte) (err error)
663 //sys Munlockall() (err error)