Debian Codegraph @

upstream/debian-trixie/man2/PR_SVE_GET_VL.2const

raw
1 .\" Copyright 2020, Dave Martin <[email protected]>
2 .\" Copyright 2020, Michael Kerrisk <[email protected]>
3 .\" Copyright 2024, Alejandro Colomar <[email protected]>
4 .\"
5 .\" SPDX-License-Identifier: Linux-man-pages-copyleft
6 .\"
7 .TH PR_SVE_GET_VL 2const 2024-06-02 "Linux man-pages 6.9.1"
8 .SH NAME
9 PR_SVE_GET_VL
10 \-
11 get the thread's SVE vector length
12 .SH LIBRARY
13 Standard C library
14 .RI ( libc ", " \-lc )
15 .SH SYNOPSIS
16 .nf
17 .BR "#include <linux/prctl.h>" " /* Definition of " PR_* " constants */"
18 .B #include <sys/prctl.h>
19 .P
20 .B int prctl(PR_SVE_GET_VL);
21 .fi
22 .SH DESCRIPTION
23 Get the thread's current SVE vector length configuration.
24 .P
25 This operation returns
26 a nonnegative value that describes the
27 .I current
28 configuration.
29 The bits corresponding to
30 .B PR_SVE_VL_LEN_MASK
31 contain the currently configured vector length in bytes.
32 The bit corresponding to
33 .B PR_SVE_VL_INHERIT
34 indicates whether the vector length will be inherited
35 across
36 .BR execve (2).
37 .SH RETURN VALUE
38 On success,
39 .BR PR_SVE_GET_VL ,
40 return the nonnegative values described above.
41 On error, \-1 is returned, and
42 .I errno
43 is set to indicate the error.
44 .SH ERRORS
45 .TP
46 .B EINVAL
47 SVE is not available on this platform.
48 .SH STANDARDS
49 Linux.
50 arm64 only.
51 .SH HISTORY
52 Linux 4.15 (arm64).
53 .SH CAVEATS
54 There is no way to determine whether there is
55 a pending vector length change that has not yet taken effect.
56 .SH SEE ALSO
57 .BR prctl (2),
58 .BR PR_SVE_SET_VL (2const)
59 .P
60 For more information, see the kernel source file
61 .I Documentation/arm64/sve.rst
62 .\"commit b693d0b372afb39432e1c49ad7b3454855bc6bed
63 (or
64 .I Documentation/arm64/sve.txt
65 before Linux 5.3).