Skip to content

Commit ec49b93

Browse files
committed
socket(9): document sooptcopy{in,out}ptr
1 parent 38d732d commit ec49b93

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

share/man/man9/Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2153,7 +2153,9 @@ MLINKS+=socket.9 soabort.9 \
21532153
socket.9 solisten_proto_check.9 \
21542154
socket.9 sonewconn.9 \
21552155
socket.9 sooptcopyin.9 \
2156+
socket.9 sooptcopyinptr.9 \
21562157
socket.9 sooptcopyout.9 \
2158+
socket.9 sooptcopyoutptr.9 \
21572159
socket.9 sopoll.9 \
21582160
socket.9 sopoll_generic.9 \
21592161
socket.9 soreceive.9 \

share/man/man9/socket.9

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2525
.\" SUCH DAMAGE.
2626
.\"
27-
.Dd September 6, 2022
27+
.Dd December 9, 2025
2828
.Dt SOCKET 9
2929
.Os
3030
.Sh NAME
@@ -146,7 +146,10 @@
146146
.Ft int
147147
.Fn sooptcopyin "struct sockopt *sopt" "void *buf" "size_t len" "size_t minlen"
148148
.Ft int
149+
.Fn sooptcopyinptr "struct sockopt *sopt" "void *buf" "size_t len" "size_t minlen"
150+
.Ft int
149151
.Fn sooptcopyout "struct sockopt *sopt" "const void *buf" "size_t len"
152+
.Fn sooptcopyoutptr "struct sockopt *sopt" "const void *buf" "size_t len"
150153
.Sh DESCRIPTION
151154
The kernel
152155
.Nm
@@ -577,6 +580,12 @@ and
577580
are useful for transferring
578581
.Vt struct sockopt
579582
data between user and kernel code.
583+
They do not preserve pointer provenance.
584+
If the copied data contains pointers, the
585+
.Fn sooptcopyinptr
586+
and
587+
.Fn sooptcopyoutptr
588+
functions must be used instead.
580589
.Sh SEE ALSO
581590
.Xr bind 2 ,
582591
.Xr close 2 ,

0 commit comments

Comments
 (0)