comparison vendor/golang.org/x/sys/unix/syscall_unix.go @ 66:787b5ee0289d draft

Use vendored modules Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>
author yakumo.izuru
date Sun, 23 Jul 2023 13:18:53 +0000
parents
children 4b79810863f6
comparison
equal deleted inserted replaced
65:6d985efa0f7a 66:787b5ee0289d
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
5 //go:build aix || darwin || dragonfly || freebsd || linux || netbsd || openbsd || solaris
6 // +build aix darwin dragonfly freebsd linux netbsd openbsd solaris
7
8 package unix
9
10 import (
11 "bytes"
12 "sort"
13 "sync"
14 "syscall"
15 "unsafe"
16
17 "golang.org/x/sys/internal/unsafeheader"
18 )
19
20 var (
21 Stdin = 0
22 Stdout = 1
23 Stderr = 2
24 )
25
26 // Do the interface allocations only once for common
27 // Errno values.
28 var (
29 errEAGAIN error = syscall.EAGAIN
30 errEINVAL error = syscall.EINVAL
31 errENOENT error = syscall.ENOENT
32 )
33
34 var (
35 signalNameMapOnce sync.Once
36 signalNameMap map[string]syscall.Signal
37 )
38
39 // errnoErr returns common boxed Errno values, to prevent
40 // allocations at runtime.
41 func errnoErr(e syscall.Errno) error {
42 switch e {
43 case 0:
44 return nil
45 case EAGAIN:
46 return errEAGAIN
47 case EINVAL:
48 return errEINVAL
49 case ENOENT:
50 return errENOENT
51 }
52 return e
53 }
54
55 // ErrnoName returns the error name for error number e.
56 func ErrnoName(e syscall.Errno) string {
57 i := sort.Search(len(errorList), func(i int) bool {
58 return errorList[i].num >= e
59 })
60 if i < len(errorList) && errorList[i].num == e {
61 return errorList[i].name
62 }
63 return ""
64 }
65
66 // SignalName returns the signal name for signal number s.
67 func SignalName(s syscall.Signal) string {
68 i := sort.Search(len(signalList), func(i int) bool {
69 return signalList[i].num >= s
70 })
71 if i < len(signalList) && signalList[i].num == s {
72 return signalList[i].name
73 }
74 return ""
75 }
76
77 // SignalNum returns the syscall.Signal for signal named s,
78 // or 0 if a signal with such name is not found.
79 // The signal name should start with "SIG".
80 func SignalNum(s string) syscall.Signal {
81 signalNameMapOnce.Do(func() {
82 signalNameMap = make(map[string]syscall.Signal, len(signalList))
83 for _, signal := range signalList {
84 signalNameMap[signal.name] = signal.num
85 }
86 })
87 return signalNameMap[s]
88 }
89
90 // clen returns the index of the first NULL byte in n or len(n) if n contains no NULL byte.
91 func clen(n []byte) int {
92 i := bytes.IndexByte(n, 0)
93 if i == -1 {
94 i = len(n)
95 }
96 return i
97 }
98
99 // Mmap manager, for use by operating system-specific implementations.
100
101 type mmapper struct {
102 sync.Mutex
103 active map[*byte][]byte // active mappings; key is last byte in mapping
104 mmap func(addr, length uintptr, prot, flags, fd int, offset int64) (uintptr, error)
105 munmap func(addr uintptr, length uintptr) error
106 }
107
108 func (m *mmapper) Mmap(fd int, offset int64, length int, prot int, flags int) (data []byte, err error) {
109 if length <= 0 {
110 return nil, EINVAL
111 }
112
113 // Map the requested memory.
114 addr, errno := m.mmap(0, uintptr(length), prot, flags, fd, offset)
115 if errno != nil {
116 return nil, errno
117 }
118
119 // Use unsafe to convert addr into a []byte.
120 var b []byte
121 hdr := (*unsafeheader.Slice)(unsafe.Pointer(&b))
122 hdr.Data = unsafe.Pointer(addr)
123 hdr.Cap = length
124 hdr.Len = length
125
126 // Register mapping in m and return it.
127 p := &b[cap(b)-1]
128 m.Lock()
129 defer m.Unlock()
130 m.active[p] = b
131 return b, nil
132 }
133
134 func (m *mmapper) Munmap(data []byte) (err error) {
135 if len(data) == 0 || len(data) != cap(data) {
136 return EINVAL
137 }
138
139 // Find the base of the mapping.
140 p := &data[cap(data)-1]
141 m.Lock()
142 defer m.Unlock()
143 b := m.active[p]
144 if b == nil || &b[0] != &data[0] {
145 return EINVAL
146 }
147
148 // Unmap the memory and update m.
149 if errno := m.munmap(uintptr(unsafe.Pointer(&b[0])), uintptr(len(b))); errno != nil {
150 return errno
151 }
152 delete(m.active, p)
153 return nil
154 }
155
156 func Read(fd int, p []byte) (n int, err error) {
157 n, err = read(fd, p)
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
169 func Write(fd int, p []byte) (n int, err error) {
170 if raceenabled {
171 raceReleaseMerge(unsafe.Pointer(&ioSync))
172 }
173 n, err = write(fd, p)
174 if raceenabled && n > 0 {
175 raceReadRange(unsafe.Pointer(&p[0]), n)
176 }
177 return
178 }
179
180 func Pread(fd int, p []byte, offset int64) (n int, err error) {
181 n, err = pread(fd, p, offset)
182 if raceenabled {
183 if n > 0 {
184 raceWriteRange(unsafe.Pointer(&p[0]), n)
185 }
186 if err == nil {
187 raceAcquire(unsafe.Pointer(&ioSync))
188 }
189 }
190 return
191 }
192
193 func Pwrite(fd int, p []byte, offset int64) (n int, err error) {
194 if raceenabled {
195 raceReleaseMerge(unsafe.Pointer(&ioSync))
196 }
197 n, err = pwrite(fd, p, offset)
198 if raceenabled && n > 0 {
199 raceReadRange(unsafe.Pointer(&p[0]), n)
200 }
201 return
202 }
203
204 // For testing: clients can set this flag to force
205 // creation of IPv6 sockets to return EAFNOSUPPORT.
206 var SocketDisableIPv6 bool
207
208 // Sockaddr represents a socket address.
209 type Sockaddr interface {
210 sockaddr() (ptr unsafe.Pointer, len _Socklen, err error) // lowercase; only we can define Sockaddrs
211 }
212
213 // SockaddrInet4 implements the Sockaddr interface for AF_INET type sockets.
214 type SockaddrInet4 struct {
215 Port int
216 Addr [4]byte
217 raw RawSockaddrInet4
218 }
219
220 // SockaddrInet6 implements the Sockaddr interface for AF_INET6 type sockets.
221 type SockaddrInet6 struct {
222 Port int
223 ZoneId uint32
224 Addr [16]byte
225 raw RawSockaddrInet6
226 }
227
228 // SockaddrUnix implements the Sockaddr interface for AF_UNIX type sockets.
229 type SockaddrUnix struct {
230 Name string
231 raw RawSockaddrUnix
232 }
233
234 func Bind(fd int, sa Sockaddr) (err error) {
235 ptr, n, err := sa.sockaddr()
236 if err != nil {
237 return err
238 }
239 return bind(fd, ptr, n)
240 }
241
242 func Connect(fd int, sa Sockaddr) (err error) {
243 ptr, n, err := sa.sockaddr()
244 if err != nil {
245 return err
246 }
247 return connect(fd, ptr, n)
248 }
249
250 func Getpeername(fd int) (sa Sockaddr, err error) {
251 var rsa RawSockaddrAny
252 var len _Socklen = SizeofSockaddrAny
253 if err = getpeername(fd, &rsa, &len); err != nil {
254 return
255 }
256 return anyToSockaddr(fd, &rsa)
257 }
258
259 func GetsockoptByte(fd, level, opt int) (value byte, err error) {
260 var n byte
261 vallen := _Socklen(1)
262 err = getsockopt(fd, level, opt, unsafe.Pointer(&n), &vallen)
263 return n, err
264 }
265
266 func GetsockoptInt(fd, level, opt int) (value int, err error) {
267 var n int32
268 vallen := _Socklen(4)
269 err = getsockopt(fd, level, opt, unsafe.Pointer(&n), &vallen)
270 return int(n), err
271 }
272
273 func GetsockoptInet4Addr(fd, level, opt int) (value [4]byte, err error) {
274 vallen := _Socklen(4)
275 err = getsockopt(fd, level, opt, unsafe.Pointer(&value[0]), &vallen)
276 return value, err
277 }
278
279 func GetsockoptIPMreq(fd, level, opt int) (*IPMreq, error) {
280 var value IPMreq
281 vallen := _Socklen(SizeofIPMreq)
282 err := getsockopt(fd, level, opt, unsafe.Pointer(&value), &vallen)
283 return &value, err
284 }
285
286 func GetsockoptIPv6Mreq(fd, level, opt int) (*IPv6Mreq, error) {
287 var value IPv6Mreq
288 vallen := _Socklen(SizeofIPv6Mreq)
289 err := getsockopt(fd, level, opt, unsafe.Pointer(&value), &vallen)
290 return &value, err
291 }
292
293 func GetsockoptIPv6MTUInfo(fd, level, opt int) (*IPv6MTUInfo, error) {
294 var value IPv6MTUInfo
295 vallen := _Socklen(SizeofIPv6MTUInfo)
296 err := getsockopt(fd, level, opt, unsafe.Pointer(&value), &vallen)
297 return &value, err
298 }
299
300 func GetsockoptICMPv6Filter(fd, level, opt int) (*ICMPv6Filter, error) {
301 var value ICMPv6Filter
302 vallen := _Socklen(SizeofICMPv6Filter)
303 err := getsockopt(fd, level, opt, unsafe.Pointer(&value), &vallen)
304 return &value, err
305 }
306
307 func GetsockoptLinger(fd, level, opt int) (*Linger, error) {
308 var linger Linger
309 vallen := _Socklen(SizeofLinger)
310 err := getsockopt(fd, level, opt, unsafe.Pointer(&linger), &vallen)
311 return &linger, err
312 }
313
314 func GetsockoptTimeval(fd, level, opt int) (*Timeval, error) {
315 var tv Timeval
316 vallen := _Socklen(unsafe.Sizeof(tv))
317 err := getsockopt(fd, level, opt, unsafe.Pointer(&tv), &vallen)
318 return &tv, err
319 }
320
321 func GetsockoptUint64(fd, level, opt int) (value uint64, err error) {
322 var n uint64
323 vallen := _Socklen(8)
324 err = getsockopt(fd, level, opt, unsafe.Pointer(&n), &vallen)
325 return n, err
326 }
327
328 func Recvfrom(fd int, p []byte, flags int) (n int, from Sockaddr, err error) {
329 var rsa RawSockaddrAny
330 var len _Socklen = SizeofSockaddrAny
331 if n, err = recvfrom(fd, p, flags, &rsa, &len); err != nil {
332 return
333 }
334 if rsa.Addr.Family != AF_UNSPEC {
335 from, err = anyToSockaddr(fd, &rsa)
336 }
337 return
338 }
339
340 func Recvmsg(fd int, p, oob []byte, flags int) (n, oobn int, recvflags int, from Sockaddr, err error) {
341 var iov [1]Iovec
342 if len(p) > 0 {
343 iov[0].Base = &p[0]
344 iov[0].SetLen(len(p))
345 }
346 var rsa RawSockaddrAny
347 n, oobn, recvflags, err = recvmsgRaw(fd, iov[:], oob, flags, &rsa)
348 // source address is only specified if the socket is unconnected
349 if rsa.Addr.Family != AF_UNSPEC {
350 from, err = anyToSockaddr(fd, &rsa)
351 }
352 return
353 }
354
355 // RecvmsgBuffers receives a message from a socket using the recvmsg
356 // system call. The flags are passed to recvmsg. Any non-control data
357 // read is scattered into the buffers slices. The results are:
358 // - n is the number of non-control data read into bufs
359 // - oobn is the number of control data read into oob; this may be interpreted using [ParseSocketControlMessage]
360 // - recvflags is flags returned by recvmsg
361 // - from is the address of the sender
362 func RecvmsgBuffers(fd int, buffers [][]byte, oob []byte, flags int) (n, oobn int, recvflags int, from Sockaddr, err error) {
363 iov := make([]Iovec, len(buffers))
364 for i := range buffers {
365 if len(buffers[i]) > 0 {
366 iov[i].Base = &buffers[i][0]
367 iov[i].SetLen(len(buffers[i]))
368 } else {
369 iov[i].Base = (*byte)(unsafe.Pointer(&_zero))
370 }
371 }
372 var rsa RawSockaddrAny
373 n, oobn, recvflags, err = recvmsgRaw(fd, iov, oob, flags, &rsa)
374 if err == nil && rsa.Addr.Family != AF_UNSPEC {
375 from, err = anyToSockaddr(fd, &rsa)
376 }
377 return
378 }
379
380 func Sendmsg(fd int, p, oob []byte, to Sockaddr, flags int) (err error) {
381 _, err = SendmsgN(fd, p, oob, to, flags)
382 return
383 }
384
385 func SendmsgN(fd int, p, oob []byte, to Sockaddr, flags int) (n int, err error) {
386 var iov [1]Iovec
387 if len(p) > 0 {
388 iov[0].Base = &p[0]
389 iov[0].SetLen(len(p))
390 }
391 var ptr unsafe.Pointer
392 var salen _Socklen
393 if to != nil {
394 ptr, salen, err = to.sockaddr()
395 if err != nil {
396 return 0, err
397 }
398 }
399 return sendmsgN(fd, iov[:], oob, ptr, salen, flags)
400 }
401
402 // SendmsgBuffers sends a message on a socket to an address using the sendmsg
403 // system call. The flags are passed to sendmsg. Any non-control data written
404 // is gathered from buffers. The function returns the number of bytes written
405 // to the socket.
406 func SendmsgBuffers(fd int, buffers [][]byte, oob []byte, to Sockaddr, flags int) (n int, err error) {
407 iov := make([]Iovec, len(buffers))
408 for i := range buffers {
409 if len(buffers[i]) > 0 {
410 iov[i].Base = &buffers[i][0]
411 iov[i].SetLen(len(buffers[i]))
412 } else {
413 iov[i].Base = (*byte)(unsafe.Pointer(&_zero))
414 }
415 }
416 var ptr unsafe.Pointer
417 var salen _Socklen
418 if to != nil {
419 ptr, salen, err = to.sockaddr()
420 if err != nil {
421 return 0, err
422 }
423 }
424 return sendmsgN(fd, iov, oob, ptr, salen, flags)
425 }
426
427 func Send(s int, buf []byte, flags int) (err error) {
428 return sendto(s, buf, flags, nil, 0)
429 }
430
431 func Sendto(fd int, p []byte, flags int, to Sockaddr) (err error) {
432 ptr, n, err := to.sockaddr()
433 if err != nil {
434 return err
435 }
436 return sendto(fd, p, flags, ptr, n)
437 }
438
439 func SetsockoptByte(fd, level, opt int, value byte) (err error) {
440 return setsockopt(fd, level, opt, unsafe.Pointer(&value), 1)
441 }
442
443 func SetsockoptInt(fd, level, opt int, value int) (err error) {
444 var n = int32(value)
445 return setsockopt(fd, level, opt, unsafe.Pointer(&n), 4)
446 }
447
448 func SetsockoptInet4Addr(fd, level, opt int, value [4]byte) (err error) {
449 return setsockopt(fd, level, opt, unsafe.Pointer(&value[0]), 4)
450 }
451
452 func SetsockoptIPMreq(fd, level, opt int, mreq *IPMreq) (err error) {
453 return setsockopt(fd, level, opt, unsafe.Pointer(mreq), SizeofIPMreq)
454 }
455
456 func SetsockoptIPv6Mreq(fd, level, opt int, mreq *IPv6Mreq) (err error) {
457 return setsockopt(fd, level, opt, unsafe.Pointer(mreq), SizeofIPv6Mreq)
458 }
459
460 func SetsockoptICMPv6Filter(fd, level, opt int, filter *ICMPv6Filter) error {
461 return setsockopt(fd, level, opt, unsafe.Pointer(filter), SizeofICMPv6Filter)
462 }
463
464 func SetsockoptLinger(fd, level, opt int, l *Linger) (err error) {
465 return setsockopt(fd, level, opt, unsafe.Pointer(l), SizeofLinger)
466 }
467
468 func SetsockoptString(fd, level, opt int, s string) (err error) {
469 var p unsafe.Pointer
470 if len(s) > 0 {
471 p = unsafe.Pointer(&[]byte(s)[0])
472 }
473 return setsockopt(fd, level, opt, p, uintptr(len(s)))
474 }
475
476 func SetsockoptTimeval(fd, level, opt int, tv *Timeval) (err error) {
477 return setsockopt(fd, level, opt, unsafe.Pointer(tv), unsafe.Sizeof(*tv))
478 }
479
480 func SetsockoptUint64(fd, level, opt int, value uint64) (err error) {
481 return setsockopt(fd, level, opt, unsafe.Pointer(&value), 8)
482 }
483
484 func Socket(domain, typ, proto int) (fd int, err error) {
485 if domain == AF_INET6 && SocketDisableIPv6 {
486 return -1, EAFNOSUPPORT
487 }
488 fd, err = socket(domain, typ, proto)
489 return
490 }
491
492 func Socketpair(domain, typ, proto int) (fd [2]int, err error) {
493 var fdx [2]int32
494 err = socketpair(domain, typ, proto, &fdx)
495 if err == nil {
496 fd[0] = int(fdx[0])
497 fd[1] = int(fdx[1])
498 }
499 return
500 }
501
502 var ioSync int64
503
504 func CloseOnExec(fd int) { fcntl(fd, F_SETFD, FD_CLOEXEC) }
505
506 func SetNonblock(fd int, nonblocking bool) (err error) {
507 flag, err := fcntl(fd, F_GETFL, 0)
508 if err != nil {
509 return err
510 }
511 if nonblocking {
512 flag |= O_NONBLOCK
513 } else {
514 flag &= ^O_NONBLOCK
515 }
516 _, err = fcntl(fd, F_SETFL, flag)
517 return err
518 }
519
520 // Exec calls execve(2), which replaces the calling executable in the process
521 // tree. argv0 should be the full path to an executable ("/bin/ls") and the
522 // executable name should also be the first argument in argv (["ls", "-l"]).
523 // envv are the environment variables that should be passed to the new
524 // process (["USER=go", "PWD=/tmp"]).
525 func Exec(argv0 string, argv []string, envv []string) error {
526 return syscall.Exec(argv0, argv, envv)
527 }
528
529 // Lutimes sets the access and modification times tv on path. If path refers to
530 // a symlink, it is not dereferenced and the timestamps are set on the symlink.
531 // If tv is nil, the access and modification times are set to the current time.
532 // Otherwise tv must contain exactly 2 elements, with access time as the first
533 // element and modification time as the second element.
534 func Lutimes(path string, tv []Timeval) error {
535 if tv == nil {
536 return UtimesNanoAt(AT_FDCWD, path, nil, AT_SYMLINK_NOFOLLOW)
537 }
538 if len(tv) != 2 {
539 return EINVAL
540 }
541 ts := []Timespec{
542 NsecToTimespec(TimevalToNsec(tv[0])),
543 NsecToTimespec(TimevalToNsec(tv[1])),
544 }
545 return UtimesNanoAt(AT_FDCWD, path, ts, AT_SYMLINK_NOFOLLOW)
546 }
547
548 // emptyIovec reports whether there are no bytes in the slice of Iovec.
549 func emptyIovecs(iov []Iovec) bool {
550 for i := range iov {
551 if iov[i].Len > 0 {
552 return false
553 }
554 }
555 return true
556 }