annotate vendor/golang.org/x/sys/unix/ioctl.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
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 2018 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
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
6 // +build aix darwin dragonfly freebsd linux netbsd openbsd solaris
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
7
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
8 package unix
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
9
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
10 import (
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
11 "runtime"
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
12 "unsafe"
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
13 )
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
14
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
15 // ioctl itself should not be exposed directly, but additional get/set
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
16 // functions for specific types are permissible.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
17
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
18 // IoctlSetInt performs an ioctl operation which sets an integer value
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
19 // on fd, using the specified request number.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
20 func IoctlSetInt(fd int, req uint, value int) error {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
21 return ioctl(fd, req, uintptr(value))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
22 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
23
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
24 // IoctlSetPointerInt performs an ioctl operation which sets an
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
25 // integer value on fd, using the specified request number. The ioctl
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
26 // argument is called with a pointer to the integer value, rather than
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
27 // passing the integer value directly.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
28 func IoctlSetPointerInt(fd int, req uint, value int) error {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
29 v := int32(value)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
30 return ioctl(fd, req, uintptr(unsafe.Pointer(&v)))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
31 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
32
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
33 // IoctlSetWinsize performs an ioctl on fd with a *Winsize argument.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
34 //
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
35 // To change fd's window size, the req argument should be TIOCSWINSZ.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
36 func IoctlSetWinsize(fd int, req uint, value *Winsize) error {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
37 // TODO: if we get the chance, remove the req parameter and
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
38 // hardcode TIOCSWINSZ.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
39 err := ioctl(fd, req, uintptr(unsafe.Pointer(value)))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
40 runtime.KeepAlive(value)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
41 return err
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
42 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
43
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
44 // IoctlSetTermios performs an ioctl on fd with a *Termios.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
45 //
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
46 // The req value will usually be TCSETA or TIOCSETA.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
47 func IoctlSetTermios(fd int, req uint, value *Termios) error {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
48 // TODO: if we get the chance, remove the req parameter.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
49 err := ioctl(fd, req, uintptr(unsafe.Pointer(value)))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
50 runtime.KeepAlive(value)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
51 return err
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
52 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
53
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
54 // IoctlGetInt performs an ioctl operation which gets an integer value
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
55 // from fd, using the specified request number.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
56 //
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
57 // A few ioctl requests use the return value as an output parameter;
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
58 // for those, IoctlRetInt should be used instead of this function.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
59 func IoctlGetInt(fd int, req uint) (int, error) {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
60 var value int
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
61 err := ioctl(fd, req, uintptr(unsafe.Pointer(&value)))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
62 return value, err
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
63 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
64
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
65 func IoctlGetWinsize(fd int, req uint) (*Winsize, error) {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
66 var value Winsize
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
67 err := ioctl(fd, req, uintptr(unsafe.Pointer(&value)))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
68 return &value, err
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
69 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
70
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
71 func IoctlGetTermios(fd int, req uint) (*Termios, error) {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
72 var value Termios
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
73 err := ioctl(fd, req, uintptr(unsafe.Pointer(&value)))
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
74 return &value, err
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
75 }