1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
.\" Copyright (c) 1980, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" @(#)ioctl.2 8.2 (Berkeley) 12/11/93
.\"
.\" %FreeBSD: src/lib/libc/sys/ioctl.2,v 1.7.2.2 2000/05/06 13:34:14 phantom Exp %
.\"
.Dd December 11, 1993
.Dt IOCTL 2
.Os BSD 4
.Sh 名称
.Nm ioctl
.Nd デバイスを制御する
.Sh ライブラリ
.Lb libc
.Sh 書式
.Fd #include <sys/ioctl.h>
.Ft int
.Fn ioctl "int d" "unsigned long request" ...
.Sh 解説
.Fn ioctl
関数は特殊ファイルの下層となっているデバイスのパラメータを操作します。
特に、キャラクタ型特殊ファイル (たとえば、端末) の多数の操作属性は
.Fn ioctl
で制御できます。引数
.Fa d
は開いているファイル記述子である必要があります。
.Pp
.Nm
への 3 番めの引数は従来から
.Ar "char *argp"
と名前付けられています。しかし、
.Fx 3.0
での
.Nm
のほとんどの使用法では、3 番めの引数が
.Ar caddr_t
または
.Ar int
である必要があります。
.Pp
ioctl の
.Fa request
は、引数が
.Dq in
パラメータなのか
.Dq out
パラメータなのかということと、引数
.Fa argp
のサイズ (バイト単位) をエンコードします。
ioctl の
.Fa request
を指定するのに使用されるマクロと定義
はファイル
.Ao Pa sys/ioctl.h Ac
の中にあります。
.Sh 実装に関する注
.Pp
非スレッドライブラリ
.Fn ioctl
は、
.Va ioctl
システムコールとして実装されています。
.Pp
スレッドライブラリの場合、
.Va ioctl
システムコールは
.Fn _thread_sys_ioctl
にアセンブルされ、
.Fn ioctl
は、読み書きについて
.Va d
をロックしてから
.Fn _thread_sys_ioctl
呼び出す関数として実装されています。戻る前に
.Fn ioctl
は
.Va d
をアンロックします。
.Sh 戻り値
エラーが起きた場合は -1 が返され、エラーを示すために
.Va errno
が設定されます。
.Sh エラー
.Fn Ioctl
は次の場合に失敗します。
.Bl -tag -width Er
.It Bq Er EBADF
.Fa d
が有効な記述子ではありません。
.It Bq Er ENOTTY
.Fa d
がキャラクタ型特殊デバイスに対応していません。
.It Bq Er ENOTTY
指定された要求は記述子
.Fa d
が参照する種類のオブジェクトには適用されません。
.It Bq Er EINVAL
.Fa request
または
.Fa argp
が有効ではありません。
.El
.Sh 関連項目
.Xr mt 1 ,
.Xr execve 2 ,
.Xr fcntl 2 ,
.Xr intro 4 ,
.Xr tty 4
.Sh 歴史
.Fn ioctl
関数は
.At v7
ではじめて登場しました。
|
