annotate vendor/golang.org/x/sys/unix/sockcmsg_unix.go @ 68:4b79810863f6 draft

Ready to release 0.6.0 Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>
author yakumo.izuru
date Wed, 13 Sep 2023 10:49:50 +0000
parents 787b5ee0289d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
66
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
1 // Copyright 2011 The Go Authors. All rights reserved.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
2 // Use of this source code is governed by a BSD-style
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
3 // license that can be found in the LICENSE file.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
4
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
5 //go:build aix || darwin || dragonfly || freebsd || linux || netbsd || openbsd || solaris || zos
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
6 // +build aix darwin dragonfly freebsd linux netbsd openbsd solaris zos
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
7
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
8 // Socket control messages
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
9
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
10 package unix
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
11
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
12 import (
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
13 "unsafe"
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
14 )
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
15
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
16 // CmsgLen returns the value to store in the Len field of the Cmsghdr
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
17 // structure, taking into account any necessary alignment.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
18 func CmsgLen(datalen int) int {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
19 return cmsgAlignOf(SizeofCmsghdr) + datalen
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
20 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
21
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
22 // CmsgSpace returns the number of bytes an ancillary element with
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
23 // payload of the passed data length occupies.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
24 func CmsgSpace(datalen int) int {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
25 return cmsgAlignOf(SizeofCmsghdr) + cmsgAlignOf(datalen)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
26 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
27
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
28 func (h *Cmsghdr) data(offset uintptr) unsafe.Pointer {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
29 return unsafe.Pointer(uintptr(unsafe.Pointer(h)) + uintptr(cmsgAlignOf(SizeofCmsghdr)) + offset)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
30 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
31
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
32 // SocketControlMessage represents a socket control message.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
33 type SocketControlMessage struct {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
34 Header Cmsghdr
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
35 Data []byte
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
36 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
37
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
38 // ParseSocketControlMessage parses b as an array of socket control
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
39 // messages.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
40 func ParseSocketControlMessage(b []byte) ([]SocketControlMessage, error) {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
41 var msgs []SocketControlMessage
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
42 i := 0
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
43 for i+CmsgLen(0) <= len(b) {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
44 h, dbuf, err := socketControlMessageHeaderAndData(b[i:])
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
45 if err != nil {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
46 return nil, err
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
47 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
48 m := SocketControlMessage{Header: *h, Data: dbuf}
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
49 msgs = append(msgs, m)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
50 i += cmsgAlignOf(int(h.Len))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
51 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
52 return msgs, nil
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
53 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
54
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
55 func socketControlMessageHeaderAndData(b []byte) (*Cmsghdr, []byte, error) {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
56 h := (*Cmsghdr)(unsafe.Pointer(&b[0]))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
57 if h.Len < SizeofCmsghdr || uint64(h.Len) > uint64(len(b)) {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
58 return nil, nil, EINVAL
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
59 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
60 return h, b[cmsgAlignOf(SizeofCmsghdr):h.Len], nil
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
61 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
62
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
63 // UnixRights encodes a set of open file descriptors into a socket
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
64 // control message for sending to another process.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
65 func UnixRights(fds ...int) []byte {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
66 datalen := len(fds) * 4
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
67 b := make([]byte, CmsgSpace(datalen))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
68 h := (*Cmsghdr)(unsafe.Pointer(&b[0]))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
69 h.Level = SOL_SOCKET
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
70 h.Type = SCM_RIGHTS
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
71 h.SetLen(CmsgLen(datalen))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
72 for i, fd := range fds {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
73 *(*int32)(h.data(4 * uintptr(i))) = int32(fd)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
74 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
75 return b
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
76 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
77
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
78 // ParseUnixRights decodes a socket control message that contains an
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
79 // integer array of open file descriptors from another process.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
80 func ParseUnixRights(m *SocketControlMessage) ([]int, error) {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
81 if m.Header.Level != SOL_SOCKET {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
82 return nil, EINVAL
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
83 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
84 if m.Header.Type != SCM_RIGHTS {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
85 return nil, EINVAL
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
86 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
87 fds := make([]int, len(m.Data)>>2)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
88 for i, j := 0, 0; i < len(m.Data); i += 4 {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
89 fds[j] = int(*(*int32)(unsafe.Pointer(&m.Data[i])))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
90 j++
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
91 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
92 return fds, nil
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
93 }