syscall_unix.go 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486
  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.
  4. //go:build aix || darwin || dragonfly || freebsd || linux || netbsd || openbsd || solaris
  5. // +build aix darwin dragonfly freebsd linux netbsd openbsd solaris
  6. package unix
  7. import (
  8. "bytes"
  9. "sort"
  10. "sync"
  11. "syscall"
  12. "unsafe"
  13. "golang.org/x/sys/internal/unsafeheader"
  14. )
  15. var (
  16. Stdin = 0
  17. Stdout = 1
  18. Stderr = 2
  19. )
  20. // Do the interface allocations only once for common
  21. // Errno values.
  22. var (
  23. errEAGAIN error = syscall.EAGAIN
  24. errEINVAL error = syscall.EINVAL
  25. errENOENT error = syscall.ENOENT
  26. )
  27. var (
  28. signalNameMapOnce sync.Once
  29. signalNameMap map[string]syscall.Signal
  30. )
  31. // errnoErr returns common boxed Errno values, to prevent
  32. // allocations at runtime.
  33. func errnoErr(e syscall.Errno) error {
  34. switch e {
  35. case 0:
  36. return nil
  37. case EAGAIN:
  38. return errEAGAIN
  39. case EINVAL:
  40. return errEINVAL
  41. case ENOENT:
  42. return errENOENT
  43. }
  44. return e
  45. }
  46. // ErrnoName returns the error name for error number e.
  47. func ErrnoName(e syscall.Errno) string {
  48. i := sort.Search(len(errorList), func(i int) bool {
  49. return errorList[i].num >= e
  50. })
  51. if i < len(errorList) && errorList[i].num == e {
  52. return errorList[i].name
  53. }
  54. return ""
  55. }
  56. // SignalName returns the signal name for signal number s.
  57. func SignalName(s syscall.Signal) string {
  58. i := sort.Search(len(signalList), func(i int) bool {
  59. return signalList[i].num >= s
  60. })
  61. if i < len(signalList) && signalList[i].num == s {
  62. return signalList[i].name
  63. }
  64. return ""
  65. }
  66. // SignalNum returns the syscall.Signal for signal named s,
  67. // or 0 if a signal with such name is not found.
  68. // The signal name should start with "SIG".
  69. func SignalNum(s string) syscall.Signal {
  70. signalNameMapOnce.Do(func() {
  71. signalNameMap = make(map[string]syscall.Signal, len(signalList))
  72. for _, signal := range signalList {
  73. signalNameMap[signal.name] = signal.num
  74. }
  75. })
  76. return signalNameMap[s]
  77. }
  78. // clen returns the index of the first NULL byte in n or len(n) if n contains no NULL byte.
  79. func clen(n []byte) int {
  80. i := bytes.IndexByte(n, 0)
  81. if i == -1 {
  82. i = len(n)
  83. }
  84. return i
  85. }
  86. // Mmap manager, for use by operating system-specific implementations.
  87. type mmapper struct {
  88. sync.Mutex
  89. active map[*byte][]byte // active mappings; key is last byte in mapping
  90. mmap func(addr, length uintptr, prot, flags, fd int, offset int64) (uintptr, error)
  91. munmap func(addr uintptr, length uintptr) error
  92. }
  93. func (m *mmapper) Mmap(fd int, offset int64, length int, prot int, flags int) (data []byte, err error) {
  94. if length <= 0 {
  95. return nil, EINVAL
  96. }
  97. // Map the requested memory.
  98. addr, errno := m.mmap(0, uintptr(length), prot, flags, fd, offset)
  99. if errno != nil {
  100. return nil, errno
  101. }
  102. // Use unsafe to convert addr into a []byte.
  103. var b []byte
  104. hdr := (*unsafeheader.Slice)(unsafe.Pointer(&b))
  105. hdr.Data = unsafe.Pointer(addr)
  106. hdr.Cap = length
  107. hdr.Len = length
  108. // Register mapping in m and return it.
  109. p := &b[cap(b)-1]
  110. m.Lock()
  111. defer m.Unlock()
  112. m.active[p] = b
  113. return b, nil
  114. }
  115. func (m *mmapper) Munmap(data []byte) (err error) {
  116. if len(data) == 0 || len(data) != cap(data) {
  117. return EINVAL
  118. }
  119. // Find the base of the mapping.
  120. p := &data[cap(data)-1]
  121. m.Lock()
  122. defer m.Unlock()
  123. b := m.active[p]
  124. if b == nil || &b[0] != &data[0] {
  125. return EINVAL
  126. }
  127. // Unmap the memory and update m.
  128. if errno := m.munmap(uintptr(unsafe.Pointer(&b[0])), uintptr(len(b))); errno != nil {
  129. return errno
  130. }
  131. delete(m.active, p)
  132. return nil
  133. }
  134. func Read(fd int, p []byte) (n int, err error) {
  135. n, err = read(fd, p)
  136. if raceenabled {
  137. if n > 0 {
  138. raceWriteRange(unsafe.Pointer(&p[0]), n)
  139. }
  140. if err == nil {
  141. raceAcquire(unsafe.Pointer(&ioSync))
  142. }
  143. }
  144. return
  145. }
  146. func Write(fd int, p []byte) (n int, err error) {
  147. if raceenabled {
  148. raceReleaseMerge(unsafe.Pointer(&ioSync))
  149. }
  150. n, err = write(fd, p)
  151. if raceenabled && n > 0 {
  152. raceReadRange(unsafe.Pointer(&p[0]), n)
  153. }
  154. return
  155. }
  156. func Pread(fd int, p []byte, offset int64) (n int, err error) {
  157. n, err = pread(fd, p, offset)
  158. if raceenabled {
  159. if n > 0 {
  160. raceWriteRange(unsafe.Pointer(&p[0]), n)
  161. }
  162. if err == nil {
  163. raceAcquire(unsafe.Pointer(&ioSync))
  164. }
  165. }
  166. return
  167. }
  168. func Pwrite(fd int, p []byte, offset int64) (n int, err error) {
  169. if raceenabled {
  170. raceReleaseMerge(unsafe.Pointer(&ioSync))
  171. }
  172. n, err = pwrite(fd, p, offset)
  173. if raceenabled && n > 0 {
  174. raceReadRange(unsafe.Pointer(&p[0]), n)
  175. }
  176. return
  177. }
  178. // For testing: clients can set this flag to force
  179. // creation of IPv6 sockets to return EAFNOSUPPORT.
  180. var SocketDisableIPv6 bool
  181. // Sockaddr represents a socket address.
  182. type Sockaddr interface {
  183. sockaddr() (ptr unsafe.Pointer, len _Socklen, err error) // lowercase; only we can define Sockaddrs
  184. }
  185. // SockaddrInet4 implements the Sockaddr interface for AF_INET type sockets.
  186. type SockaddrInet4 struct {
  187. Port int
  188. Addr [4]byte
  189. raw RawSockaddrInet4
  190. }
  191. // SockaddrInet6 implements the Sockaddr interface for AF_INET6 type sockets.
  192. type SockaddrInet6 struct {
  193. Port int
  194. ZoneId uint32
  195. Addr [16]byte
  196. raw RawSockaddrInet6
  197. }
  198. // SockaddrUnix implements the Sockaddr interface for AF_UNIX type sockets.
  199. type SockaddrUnix struct {
  200. Name string
  201. raw RawSockaddrUnix
  202. }
  203. func Bind(fd int, sa Sockaddr) (err error) {
  204. ptr, n, err := sa.sockaddr()
  205. if err != nil {
  206. return err
  207. }
  208. return bind(fd, ptr, n)
  209. }
  210. func Connect(fd int, sa Sockaddr) (err error) {
  211. ptr, n, err := sa.sockaddr()
  212. if err != nil {
  213. return err
  214. }
  215. return connect(fd, ptr, n)
  216. }
  217. func Getpeername(fd int) (sa Sockaddr, err error) {
  218. var rsa RawSockaddrAny
  219. var len _Socklen = SizeofSockaddrAny
  220. if err = getpeername(fd, &rsa, &len); err != nil {
  221. return
  222. }
  223. return anyToSockaddr(fd, &rsa)
  224. }
  225. func GetsockoptByte(fd, level, opt int) (value byte, err error) {
  226. var n byte
  227. vallen := _Socklen(1)
  228. err = getsockopt(fd, level, opt, unsafe.Pointer(&n), &vallen)
  229. return n, err
  230. }
  231. func GetsockoptInt(fd, level, opt int) (value int, err error) {
  232. var n int32
  233. vallen := _Socklen(4)
  234. err = getsockopt(fd, level, opt, unsafe.Pointer(&n), &vallen)
  235. return int(n), err
  236. }
  237. func GetsockoptInet4Addr(fd, level, opt int) (value [4]byte, err error) {
  238. vallen := _Socklen(4)
  239. err = getsockopt(fd, level, opt, unsafe.Pointer(&value[0]), &vallen)
  240. return value, err
  241. }
  242. func GetsockoptIPMreq(fd, level, opt int) (*IPMreq, error) {
  243. var value IPMreq
  244. vallen := _Socklen(SizeofIPMreq)
  245. err := getsockopt(fd, level, opt, unsafe.Pointer(&value), &vallen)
  246. return &value, err
  247. }
  248. func GetsockoptIPv6Mreq(fd, level, opt int) (*IPv6Mreq, error) {
  249. var value IPv6Mreq
  250. vallen := _Socklen(SizeofIPv6Mreq)
  251. err := getsockopt(fd, level, opt, unsafe.Pointer(&value), &vallen)
  252. return &value, err
  253. }
  254. func GetsockoptIPv6MTUInfo(fd, level, opt int) (*IPv6MTUInfo, error) {
  255. var value IPv6MTUInfo
  256. vallen := _Socklen(SizeofIPv6MTUInfo)
  257. err := getsockopt(fd, level, opt, unsafe.Pointer(&value), &vallen)
  258. return &value, err
  259. }
  260. func GetsockoptICMPv6Filter(fd, level, opt int) (*ICMPv6Filter, error) {
  261. var value ICMPv6Filter
  262. vallen := _Socklen(SizeofICMPv6Filter)
  263. err := getsockopt(fd, level, opt, unsafe.Pointer(&value), &vallen)
  264. return &value, err
  265. }
  266. func GetsockoptLinger(fd, level, opt int) (*Linger, error) {
  267. var linger Linger
  268. vallen := _Socklen(SizeofLinger)
  269. err := getsockopt(fd, level, opt, unsafe.Pointer(&linger), &vallen)
  270. return &linger, err
  271. }
  272. func GetsockoptTimeval(fd, level, opt int) (*Timeval, error) {
  273. var tv Timeval
  274. vallen := _Socklen(unsafe.Sizeof(tv))
  275. err := getsockopt(fd, level, opt, unsafe.Pointer(&tv), &vallen)
  276. return &tv, err
  277. }
  278. func GetsockoptUint64(fd, level, opt int) (value uint64, err error) {
  279. var n uint64
  280. vallen := _Socklen(8)
  281. err = getsockopt(fd, level, opt, unsafe.Pointer(&n), &vallen)
  282. return n, err
  283. }
  284. func Recvfrom(fd int, p []byte, flags int) (n int, from Sockaddr, err error) {
  285. var rsa RawSockaddrAny
  286. var len _Socklen = SizeofSockaddrAny
  287. if n, err = recvfrom(fd, p, flags, &rsa, &len); err != nil {
  288. return
  289. }
  290. if rsa.Addr.Family != AF_UNSPEC {
  291. from, err = anyToSockaddr(fd, &rsa)
  292. }
  293. return
  294. }
  295. func Recvmsg(fd int, p, oob []byte, flags int) (n, oobn int, recvflags int, from Sockaddr, err error) {
  296. var rsa RawSockaddrAny
  297. n, oobn, recvflags, err = recvmsgRaw(fd, p, oob, flags, &rsa)
  298. // source address is only specified if the socket is unconnected
  299. if rsa.Addr.Family != AF_UNSPEC {
  300. from, err = anyToSockaddr(fd, &rsa)
  301. }
  302. return
  303. }
  304. func Sendmsg(fd int, p, oob []byte, to Sockaddr, flags int) (err error) {
  305. _, err = SendmsgN(fd, p, oob, to, flags)
  306. return
  307. }
  308. func SendmsgN(fd int, p, oob []byte, to Sockaddr, flags int) (n int, err error) {
  309. var ptr unsafe.Pointer
  310. var salen _Socklen
  311. if to != nil {
  312. ptr, salen, err = to.sockaddr()
  313. if err != nil {
  314. return 0, err
  315. }
  316. }
  317. return sendmsgN(fd, p, oob, ptr, salen, flags)
  318. }
  319. func Send(s int, buf []byte, flags int) (err error) {
  320. return sendto(s, buf, flags, nil, 0)
  321. }
  322. func Sendto(fd int, p []byte, flags int, to Sockaddr) (err error) {
  323. ptr, n, err := to.sockaddr()
  324. if err != nil {
  325. return err
  326. }
  327. return sendto(fd, p, flags, ptr, n)
  328. }
  329. func SetsockoptByte(fd, level, opt int, value byte) (err error) {
  330. return setsockopt(fd, level, opt, unsafe.Pointer(&value), 1)
  331. }
  332. func SetsockoptInt(fd, level, opt int, value int) (err error) {
  333. var n = int32(value)
  334. return setsockopt(fd, level, opt, unsafe.Pointer(&n), 4)
  335. }
  336. func SetsockoptInet4Addr(fd, level, opt int, value [4]byte) (err error) {
  337. return setsockopt(fd, level, opt, unsafe.Pointer(&value[0]), 4)
  338. }
  339. func SetsockoptIPMreq(fd, level, opt int, mreq *IPMreq) (err error) {
  340. return setsockopt(fd, level, opt, unsafe.Pointer(mreq), SizeofIPMreq)
  341. }
  342. func SetsockoptIPv6Mreq(fd, level, opt int, mreq *IPv6Mreq) (err error) {
  343. return setsockopt(fd, level, opt, unsafe.Pointer(mreq), SizeofIPv6Mreq)
  344. }
  345. func SetsockoptICMPv6Filter(fd, level, opt int, filter *ICMPv6Filter) error {
  346. return setsockopt(fd, level, opt, unsafe.Pointer(filter), SizeofICMPv6Filter)
  347. }
  348. func SetsockoptLinger(fd, level, opt int, l *Linger) (err error) {
  349. return setsockopt(fd, level, opt, unsafe.Pointer(l), SizeofLinger)
  350. }
  351. func SetsockoptString(fd, level, opt int, s string) (err error) {
  352. var p unsafe.Pointer
  353. if len(s) > 0 {
  354. p = unsafe.Pointer(&[]byte(s)[0])
  355. }
  356. return setsockopt(fd, level, opt, p, uintptr(len(s)))
  357. }
  358. func SetsockoptTimeval(fd, level, opt int, tv *Timeval) (err error) {
  359. return setsockopt(fd, level, opt, unsafe.Pointer(tv), unsafe.Sizeof(*tv))
  360. }
  361. func SetsockoptUint64(fd, level, opt int, value uint64) (err error) {
  362. return setsockopt(fd, level, opt, unsafe.Pointer(&value), 8)
  363. }
  364. func Socket(domain, typ, proto int) (fd int, err error) {
  365. if domain == AF_INET6 && SocketDisableIPv6 {
  366. return -1, EAFNOSUPPORT
  367. }
  368. fd, err = socket(domain, typ, proto)
  369. return
  370. }
  371. func Socketpair(domain, typ, proto int) (fd [2]int, err error) {
  372. var fdx [2]int32
  373. err = socketpair(domain, typ, proto, &fdx)
  374. if err == nil {
  375. fd[0] = int(fdx[0])
  376. fd[1] = int(fdx[1])
  377. }
  378. return
  379. }
  380. var ioSync int64
  381. func CloseOnExec(fd int) { fcntl(fd, F_SETFD, FD_CLOEXEC) }
  382. func SetNonblock(fd int, nonblocking bool) (err error) {
  383. flag, err := fcntl(fd, F_GETFL, 0)
  384. if err != nil {
  385. return err
  386. }
  387. if nonblocking {
  388. flag |= O_NONBLOCK
  389. } else {
  390. flag &= ^O_NONBLOCK
  391. }
  392. _, err = fcntl(fd, F_SETFL, flag)
  393. return err
  394. }
  395. // Exec calls execve(2), which replaces the calling executable in the process
  396. // tree. argv0 should be the full path to an executable ("/bin/ls") and the
  397. // executable name should also be the first argument in argv (["ls", "-l"]).
  398. // envv are the environment variables that should be passed to the new
  399. // process (["USER=go", "PWD=/tmp"]).
  400. func Exec(argv0 string, argv []string, envv []string) error {
  401. return syscall.Exec(argv0, argv, envv)
  402. }
  403. // Lutimes sets the access and modification times tv on path. If path refers to
  404. // a symlink, it is not dereferenced and the timestamps are set on the symlink.
  405. // If tv is nil, the access and modification times are set to the current time.
  406. // Otherwise tv must contain exactly 2 elements, with access time as the first
  407. // element and modification time as the second element.
  408. func Lutimes(path string, tv []Timeval) error {
  409. if tv == nil {
  410. return UtimesNanoAt(AT_FDCWD, path, nil, AT_SYMLINK_NOFOLLOW)
  411. }
  412. if len(tv) != 2 {
  413. return EINVAL
  414. }
  415. ts := []Timespec{
  416. NsecToTimespec(TimevalToNsec(tv[0])),
  417. NsecToTimespec(TimevalToNsec(tv[1])),
  418. }
  419. return UtimesNanoAt(AT_FDCWD, path, ts, AT_SYMLINK_NOFOLLOW)
  420. }