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 //go: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.
20 const ImplementsGetwd = true
22 func Getwd() (string, error) {
24 _, err := getcwd(buf[:])
32 return string(buf[:n]), nil
39 //sysnb getgroups(ngid int, gid *_Gid_t) (n int, err error)
40 //sysnb setgroups(ngid int, gid *_Gid_t) (err error)
42 func Getgroups() (gids []int, err error) {
43 n, err := getgroups(0, nil)
51 // Sanity check group count. Max is 16 on BSD.
52 if n < 0 || n > 1000 {
56 a := make([]_Gid_t, n)
57 n, err = getgroups(n, &a[0])
62 for i, v := range a[0:n] {
68 func Setgroups(gids []int) (err error) {
70 return setgroups(0, nil)
73 a := make([]_Gid_t, len(gids))
74 for i, v := range gids {
77 return setgroups(len(a), &a[0])
80 func ReadDirent(fd int, buf []byte) (n int, err error) {
81 // Final argument is (basep *uintptr) and the syscall doesn't take nil.
82 // 64 bits should be enough. (32 bits isn't even on 386). Since the
83 // actual system call is getdirentries64, 64 is a good guess.
84 // TODO(rsc): Can we use a single global basep for all calls?
85 var base = (*uintptr)(unsafe.Pointer(new(uint64)))
86 return Getdirentries(fd, buf, base)
89 // Wait status is 7 bits at bottom, either 0 (exited),
90 // 0x7F (stopped), or a signal number that caused an exit.
91 // The 0x80 bit is whether there was a core dump.
92 // An extra number (exit code, signal causing a stop)
93 // is in the high bits.
95 type WaitStatus uint32
106 func (w WaitStatus) Exited() bool { return w&mask == exited }
108 func (w WaitStatus) ExitStatus() int {
109 if w&mask != exited {
112 return int(w >> shift)
115 func (w WaitStatus) Signaled() bool { return w&mask != stopped && w&mask != 0 }
117 func (w WaitStatus) Signal() Signal {
118 sig := Signal(w & mask)
119 if sig == stopped || sig == 0 {
125 func (w WaitStatus) CoreDump() bool { return w.Signaled() && w&core != 0 }
127 func (w WaitStatus) Stopped() bool { return w&mask == stopped && Signal(w>>shift) != SIGSTOP }
129 func (w WaitStatus) Continued() bool { return w&mask == stopped && Signal(w>>shift) == SIGSTOP }
131 func (w WaitStatus) StopSignal() Signal {
135 return Signal(w>>shift) & 0xFF
138 func (w WaitStatus) TrapCause() int { return -1 }
140 //sys wait4(pid int, wstatus *_C_int, options int, rusage *Rusage) (wpid int, err error)
142 func Wait4(pid int, wstatus *WaitStatus, options int, rusage *Rusage) (wpid int, err error) {
144 wpid, err = wait4(pid, &status, options, rusage)
146 *wstatus = WaitStatus(status)
151 //sys accept(s int, rsa *RawSockaddrAny, addrlen *_Socklen) (fd int, err error)
152 //sys bind(s int, addr unsafe.Pointer, addrlen _Socklen) (err error)
153 //sys connect(s int, addr unsafe.Pointer, addrlen _Socklen) (err error)
154 //sysnb socket(domain int, typ int, proto int) (fd int, err error)
155 //sys getsockopt(s int, level int, name int, val unsafe.Pointer, vallen *_Socklen) (err error)
156 //sys setsockopt(s int, level int, name int, val unsafe.Pointer, vallen uintptr) (err error)
157 //sysnb getpeername(fd int, rsa *RawSockaddrAny, addrlen *_Socklen) (err error)
158 //sysnb getsockname(fd int, rsa *RawSockaddrAny, addrlen *_Socklen) (err error)
159 //sys Shutdown(s int, how int) (err error)
161 func (sa *SockaddrInet4) sockaddr() (unsafe.Pointer, _Socklen, error) {
162 if sa.Port < 0 || sa.Port > 0xFFFF {
163 return nil, 0, EINVAL
165 sa.raw.Len = SizeofSockaddrInet4
166 sa.raw.Family = AF_INET
167 p := (*[2]byte)(unsafe.Pointer(&sa.raw.Port))
168 p[0] = byte(sa.Port >> 8)
170 sa.raw.Addr = sa.Addr
171 return unsafe.Pointer(&sa.raw), _Socklen(sa.raw.Len), nil
174 func (sa *SockaddrInet6) sockaddr() (unsafe.Pointer, _Socklen, error) {
175 if sa.Port < 0 || sa.Port > 0xFFFF {
176 return nil, 0, EINVAL
178 sa.raw.Len = SizeofSockaddrInet6
179 sa.raw.Family = AF_INET6
180 p := (*[2]byte)(unsafe.Pointer(&sa.raw.Port))
181 p[0] = byte(sa.Port >> 8)
183 sa.raw.Scope_id = sa.ZoneId
184 sa.raw.Addr = sa.Addr
185 return unsafe.Pointer(&sa.raw), _Socklen(sa.raw.Len), nil
188 func (sa *SockaddrUnix) sockaddr() (unsafe.Pointer, _Socklen, error) {
191 if n >= len(sa.raw.Path) || n == 0 {
192 return nil, 0, EINVAL
194 sa.raw.Len = byte(3 + n) // 2 for Family, Len; 1 for NUL
195 sa.raw.Family = AF_UNIX
196 for i := 0; i < n; i++ {
197 sa.raw.Path[i] = int8(name[i])
199 return unsafe.Pointer(&sa.raw), _Socklen(sa.raw.Len), nil
202 func (sa *SockaddrDatalink) sockaddr() (unsafe.Pointer, _Socklen, error) {
204 return nil, 0, EINVAL
207 sa.raw.Family = AF_LINK
208 sa.raw.Index = sa.Index
209 sa.raw.Type = sa.Type
210 sa.raw.Nlen = sa.Nlen
211 sa.raw.Alen = sa.Alen
212 sa.raw.Slen = sa.Slen
213 sa.raw.Data = sa.Data
214 return unsafe.Pointer(&sa.raw), SizeofSockaddrDatalink, nil
217 func anyToSockaddr(rsa *RawSockaddrAny) (Sockaddr, error) {
218 switch rsa.Addr.Family {
220 pp := (*RawSockaddrDatalink)(unsafe.Pointer(rsa))
221 sa := new(SockaddrDatalink)
223 sa.Family = pp.Family
233 pp := (*RawSockaddrUnix)(unsafe.Pointer(rsa))
234 if pp.Len < 2 || pp.Len > SizeofSockaddrUnix {
237 sa := new(SockaddrUnix)
239 // Some BSDs include the trailing NUL in the length, whereas
240 // others do not. Work around this by subtracting the leading
241 // family and len. The path is then scanned to see if a NUL
242 // terminator still exists within the length.
243 n := int(pp.Len) - 2 // subtract leading Family, Len
244 for i := 0; i < n; i++ {
246 // found early NUL; assume Len included the NUL
247 // or was overestimating.
252 sa.Name = string(unsafe.Slice((*byte)(unsafe.Pointer(&pp.Path[0])), n))
256 pp := (*RawSockaddrInet4)(unsafe.Pointer(rsa))
257 sa := new(SockaddrInet4)
258 p := (*[2]byte)(unsafe.Pointer(&pp.Port))
259 sa.Port = int(p[0])<<8 + int(p[1])
264 pp := (*RawSockaddrInet6)(unsafe.Pointer(rsa))
265 sa := new(SockaddrInet6)
266 p := (*[2]byte)(unsafe.Pointer(&pp.Port))
267 sa.Port = int(p[0])<<8 + int(p[1])
268 sa.ZoneId = pp.Scope_id
272 return nil, EAFNOSUPPORT
275 func Accept(fd int) (nfd int, sa Sockaddr, err error) {
276 var rsa RawSockaddrAny
277 var len _Socklen = SizeofSockaddrAny
278 nfd, err = accept(fd, &rsa, &len)
282 if (runtime.GOOS == "darwin" || runtime.GOOS == "ios") && len == 0 {
283 // Accepted socket has no address.
284 // This is likely due to a bug in xnu kernels,
285 // where instead of ECONNABORTED error socket
286 // is accepted, but has no address.
288 return 0, nil, ECONNABORTED
290 sa, err = anyToSockaddr(&rsa)
298 func Getsockname(fd int) (sa Sockaddr, err error) {
299 var rsa RawSockaddrAny
300 var len _Socklen = SizeofSockaddrAny
301 if err = getsockname(fd, &rsa, &len); err != nil {
304 // TODO(jsing): DragonFly has a "bug" (see issue 3349), which should be
305 // reported upstream.
306 if runtime.GOOS == "dragonfly" && rsa.Addr.Family == AF_UNSPEC && rsa.Addr.Len == 0 {
307 rsa.Addr.Family = AF_UNIX
308 rsa.Addr.Len = SizeofSockaddrUnix
310 return anyToSockaddr(&rsa)
313 //sysnb socketpair(domain int, typ int, proto int, fd *[2]int32) (err error)
315 func GetsockoptByte(fd, level, opt int) (value byte, err error) {
317 vallen := _Socklen(1)
318 err = getsockopt(fd, level, opt, unsafe.Pointer(&n), &vallen)
322 func GetsockoptInet4Addr(fd, level, opt int) (value [4]byte, err error) {
323 vallen := _Socklen(4)
324 err = getsockopt(fd, level, opt, unsafe.Pointer(&value[0]), &vallen)
328 func GetsockoptIPMreq(fd, level, opt int) (*IPMreq, error) {
330 vallen := _Socklen(SizeofIPMreq)
331 err := getsockopt(fd, level, opt, unsafe.Pointer(&value), &vallen)
335 func GetsockoptIPv6Mreq(fd, level, opt int) (*IPv6Mreq, error) {
337 vallen := _Socklen(SizeofIPv6Mreq)
338 err := getsockopt(fd, level, opt, unsafe.Pointer(&value), &vallen)
342 func GetsockoptIPv6MTUInfo(fd, level, opt int) (*IPv6MTUInfo, error) {
343 var value IPv6MTUInfo
344 vallen := _Socklen(SizeofIPv6MTUInfo)
345 err := getsockopt(fd, level, opt, unsafe.Pointer(&value), &vallen)
349 func GetsockoptICMPv6Filter(fd, level, opt int) (*ICMPv6Filter, error) {
350 var value ICMPv6Filter
351 vallen := _Socklen(SizeofICMPv6Filter)
352 err := getsockopt(fd, level, opt, unsafe.Pointer(&value), &vallen)
356 //sys recvfrom(fd int, p []byte, flags int, from *RawSockaddrAny, fromlen *_Socklen) (n int, err error)
357 //sys sendto(s int, buf []byte, flags int, to unsafe.Pointer, addrlen _Socklen) (err error)
358 //sys recvmsg(s int, msg *Msghdr, flags int) (n int, err error)
360 func recvmsgRaw(fd int, p, oob []byte, flags int, rsa *RawSockaddrAny) (n, oobn int, recvflags int, err error) {
362 msg.Name = (*byte)(unsafe.Pointer(rsa))
363 msg.Namelen = uint32(SizeofSockaddrAny)
371 // receive at least one normal byte
376 msg.Control = &oob[0]
377 msg.SetControllen(len(oob))
381 if n, err = recvmsg(fd, &msg, flags); err != nil {
384 oobn = int(msg.Controllen)
385 recvflags = int(msg.Flags)
389 //sys sendmsg(s int, msg *Msghdr, flags int) (n int, err error)
391 func sendmsgN(fd int, p, oob []byte, ptr unsafe.Pointer, salen _Socklen, flags int) (n int, err error) {
393 msg.Name = (*byte)(ptr)
394 msg.Namelen = uint32(salen)
402 // send at least one normal byte
407 msg.Control = &oob[0]
408 msg.SetControllen(len(oob))
412 if n, err = sendmsg(fd, &msg, flags); err != nil {
415 if len(oob) > 0 && len(p) == 0 {
421 //sys kevent(kq int, change unsafe.Pointer, nchange int, event unsafe.Pointer, nevent int, timeout *Timespec) (n int, err error)
423 func Kevent(kq int, changes, events []Kevent_t, timeout *Timespec) (n int, err error) {
424 var change, event unsafe.Pointer
425 if len(changes) > 0 {
426 change = unsafe.Pointer(&changes[0])
429 event = unsafe.Pointer(&events[0])
431 return kevent(kq, change, len(changes), event, len(events), timeout)
434 func Sysctl(name string) (value string, err error) {
435 // Translate name to mib number.
436 mib, err := nametomib(name)
443 if err = sysctl(mib, nil, &n, nil, 0); err != nil {
450 // Read into buffer of that size.
451 buf := make([]byte, n)
452 if err = sysctl(mib, &buf[0], &n, nil, 0); err != nil {
456 // Throw away terminating NUL.
457 if n > 0 && buf[n-1] == '\x00' {
460 return string(buf[0:n]), nil
463 func SysctlUint32(name string) (value uint32, err error) {
464 // Translate name to mib number.
465 mib, err := nametomib(name)
470 // Read into buffer of that size.
472 buf := make([]byte, 4)
473 if err = sysctl(mib, &buf[0], &n, nil, 0); err != nil {
479 return *(*uint32)(unsafe.Pointer(&buf[0])), nil
482 //sys utimes(path string, timeval *[2]Timeval) (err error)
484 func Utimes(path string, tv []Timeval) (err error) {
488 return utimes(path, (*[2]Timeval)(unsafe.Pointer(&tv[0])))
491 func UtimesNano(path string, ts []Timespec) error {
495 err := utimensat(_AT_FDCWD, path, (*[2]Timespec)(unsafe.Pointer(&ts[0])), 0)
499 // Not as efficient as it could be because Timespec and
500 // Timeval have different types in the different OSes
502 NsecToTimeval(TimespecToNsec(ts[0])),
503 NsecToTimeval(TimespecToNsec(ts[1])),
505 return utimes(path, (*[2]Timeval)(unsafe.Pointer(&tv[0])))
508 //sys futimes(fd int, timeval *[2]Timeval) (err error)
510 func Futimes(fd int, tv []Timeval) (err error) {
514 return futimes(fd, (*[2]Timeval)(unsafe.Pointer(&tv[0])))
517 //sys fcntl(fd int, cmd int, arg int) (val int, err error)
518 //sys fcntlPtr(fd int, cmd int, arg unsafe.Pointer) (val int, err error) = SYS_FCNTL
519 //sysnb ioctl(fd int, req int, arg int) (err error)
520 //sysnb ioctlPtr(fd int, req uint, arg unsafe.Pointer) (err error) = SYS_IOCTL
522 var mapper = &mmapper{
523 active: make(map[*byte][]byte),
528 func Mmap(fd int, offset int64, length int, prot int, flags int) (data []byte, err error) {
529 return mapper.Mmap(fd, offset, length, prot, flags)
532 func Munmap(b []byte) (err error) {
533 return mapper.Munmap(b)