blob: 3559e5dcb29ee112d2f0703985dc154591efe518 [file] [log] [blame]
Scott Baker2d897982019-09-24 11:50:08 -07001// Copyright 2018 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// +build aix darwin dragonfly freebsd linux netbsd openbsd solaris
6
7package unix
8
Scott Baker8487c5d2019-10-18 12:49:46 -07009import (
10 "runtime"
11 "unsafe"
12)
13
14// ioctl itself should not be exposed directly, but additional get/set
15// functions for specific types are permissible.
16
17// IoctlSetInt performs an ioctl operation which sets an integer value
18// on fd, using the specified request number.
19func IoctlSetInt(fd int, req uint, value int) error {
20 return ioctl(fd, req, uintptr(value))
21}
Scott Baker2d897982019-09-24 11:50:08 -070022
23// IoctlSetWinsize performs an ioctl on fd with a *Winsize argument.
24//
25// To change fd's window size, the req argument should be TIOCSWINSZ.
26func IoctlSetWinsize(fd int, req uint, value *Winsize) error {
27 // TODO: if we get the chance, remove the req parameter and
28 // hardcode TIOCSWINSZ.
Scott Baker8487c5d2019-10-18 12:49:46 -070029 err := ioctl(fd, req, uintptr(unsafe.Pointer(value)))
Scott Baker2d897982019-09-24 11:50:08 -070030 runtime.KeepAlive(value)
31 return err
32}
33
34// IoctlSetTermios performs an ioctl on fd with a *Termios.
35//
36// The req value will usually be TCSETA or TIOCSETA.
37func IoctlSetTermios(fd int, req uint, value *Termios) error {
38 // TODO: if we get the chance, remove the req parameter.
Scott Baker8487c5d2019-10-18 12:49:46 -070039 err := ioctl(fd, req, uintptr(unsafe.Pointer(value)))
Scott Baker2d897982019-09-24 11:50:08 -070040 runtime.KeepAlive(value)
41 return err
42}
Scott Baker8487c5d2019-10-18 12:49:46 -070043
44// IoctlGetInt performs an ioctl operation which gets an integer value
45// from fd, using the specified request number.
46//
47// A few ioctl requests use the return value as an output parameter;
48// for those, IoctlRetInt should be used instead of this function.
49func IoctlGetInt(fd int, req uint) (int, error) {
50 var value int
51 err := ioctl(fd, req, uintptr(unsafe.Pointer(&value)))
52 return value, err
53}
54
55func IoctlGetWinsize(fd int, req uint) (*Winsize, error) {
56 var value Winsize
57 err := ioctl(fd, req, uintptr(unsafe.Pointer(&value)))
58 return &value, err
59}
60
61func IoctlGetTermios(fd int, req uint) (*Termios, error) {
62 var value Termios
63 err := ioctl(fd, req, uintptr(unsafe.Pointer(&value)))
64 return &value, err
65}