| blob | 1e16877e155d5f9499414029ac89eff8a8fee90b |
1 '\" t
2 .\" Copyright (C) 2001 Andries Brouwer <aeb@cwi.nl>.
3 .\"
4 .\" SPDX-License-Identifier: Linux-man-pages-copyleft
5 .\"
6 .TH unlocked_stdio 3 (date) "Linux man-pages (unreleased)"
7 .SH NAME
8 getc_unlocked, getchar_unlocked, putc_unlocked,
9 putchar_unlocked \- nonlocking stdio functions
10 .SH LIBRARY
11 Standard C library
12 .RI ( libc ", " \-lc )
13 .SH SYNOPSIS
14 .nf
15 .B #include <stdio.h>
16 .P
17 .BI "int getc_unlocked(FILE *" stream );
18 .B "int getchar_unlocked(void);"
19 .BI "int putc_unlocked(int " c ", FILE *" stream );
20 .BI "int putchar_unlocked(int " c );
21 .P
22 .BI "void clearerr_unlocked(FILE *" stream );
23 .BI "int feof_unlocked(FILE *" stream );
24 .BI "int ferror_unlocked(FILE *" stream );
25 .BI "int fileno_unlocked(FILE *" stream );
26 .BI "int fflush_unlocked(FILE *_Nullable " stream );
27 .P
28 .BI "int fgetc_unlocked(FILE *" stream );
29 .BI "int fputc_unlocked(int " c ", FILE *" stream );
30 .P
31 .BI "size_t fread_unlocked(void " ptr "[restrict ." size " * ." n ],
32 .BI " size_t " size ", size_t " n ,
33 .BI " FILE *restrict " stream );
34 .BI "size_t fwrite_unlocked(const void " ptr "[restrict ." size " * ." n ],
35 .BI " size_t " size ", size_t " n ,
36 .BI " FILE *restrict " stream );
37 .P
38 .BI "char *fgets_unlocked(char " s "[restrict ." n "], int " n \
39 ", FILE *restrict " stream );
40 .BI "int fputs_unlocked(const char *restrict " s ", FILE *restrict " stream );
41 .P
42 .B #include <wchar.h>
43 .P
44 .BI "wint_t getwc_unlocked(FILE *" stream );
45 .B "wint_t getwchar_unlocked(void);"
46 .BI "wint_t fgetwc_unlocked(FILE *" stream );
47 .P
48 .BI "wint_t fputwc_unlocked(wchar_t " wc ", FILE *" stream );
49 .BI "wint_t putwc_unlocked(wchar_t " wc ", FILE *" stream );
50 .BI "wint_t putwchar_unlocked(wchar_t " wc );
51 .P
52 .BI "wchar_t *fgetws_unlocked(wchar_t " ws "[restrict ." n "], int " n ,
53 .BI " FILE *restrict " stream );
54 .BI "int fputws_unlocked(const wchar_t *restrict " ws ,
55 .BI " FILE *restrict " stream );
56 .fi
57 .P
58 .RS -4
59 Feature Test Macro Requirements for glibc (see
60 .BR feature_test_macros (7)):
61 .RE
62 .P
63 .BR \%getc_unlocked (),
64 .BR \%getchar_unlocked (),
65 .BR \%putc_unlocked (),
66 .BR \%putchar_unlocked ():
67 .nf
68 /* glibc >= 2.24: */ _POSIX_C_SOURCE >= 199309L
69 || /* glibc <= 2.23: */ _POSIX_C_SOURCE
70 || /* glibc <= 2.19: */ _SVID_SOURCE || _BSD_SOURCE
71 .fi
72 .P
73 .BR \%clearerr_unlocked (),
74 .BR \%feof_unlocked (),
75 .BR \%ferror_unlocked (),
76 .BR \%fileno_unlocked (),
77 .BR \%fflush_unlocked (),
78 .BR \%fgetc_unlocked (),
79 .BR \%fputc_unlocked (),
80 .BR \%fread_unlocked (),
81 .BR \%fwrite_unlocked ():
82 .nf
83 /* glibc >= 2.19: */ _DEFAULT_SOURCE
84 || /* glibc <= 2.19: */ _SVID_SOURCE || _BSD_SOURCE
85 .fi
86 .P
87 .BR \%fgets_unlocked (),
88 .BR \%fputs_unlocked (),
89 .BR \%getwc_unlocked (),
90 .BR \%getwchar_unlocked (),
91 .BR \%fgetwc_unlocked (),
92 .BR \%fputwc_unlocked (),
93 .BR \%putwchar_unlocked (),
94 .BR \%fgetws_unlocked (),
95 .BR \%fputws_unlocked ():
96 .nf
97 _GNU_SOURCE
98 .fi
99 .SH DESCRIPTION
100 Each of these functions has the same behavior as its counterpart
101 without the "_unlocked" suffix, except that they do not use locking
102 (they do not set locks themselves, and do not test for the presence
103 of locks set by others) and hence are thread-unsafe.
104 See
105 .BR flockfile (3).
106 .SH ATTRIBUTES
107 For an explanation of the terms used in this section, see
108 .BR attributes (7).
109 .TS
110 allbox;
111 lb lb lbx
112 l l l.
113 Interface Attribute Value
114 T{
115 .na
116 .nh
117 .BR getc_unlocked (),
118 .BR putc_unlocked (),
119 .BR clearerr_unlocked (),
120 .BR fflush_unlocked (),
121 .BR fgetc_unlocked (),
122 .BR fputc_unlocked (),
123 .BR fread_unlocked (),
124 .BR fwrite_unlocked (),
125 .BR fgets_unlocked (),
126 .BR fputs_unlocked (),
127 .BR getwc_unlocked (),
128 .BR fgetwc_unlocked (),
129 .BR fputwc_unlocked (),
130 .BR putwc_unlocked (),
131 .BR fgetws_unlocked (),
132 .BR fputws_unlocked ()
133 T} Thread safety T{
134 .na
135 .nh
136 MT-Safe race:stream
137 T}
138 T{
139 .na
140 .nh
141 .BR getchar_unlocked (),
142 .BR getwchar_unlocked ()
143 T} Thread safety T{
144 .na
145 .nh
146 MT-Unsafe race:stdin
147 T}
148 T{
149 .na
150 .nh
151 .BR putchar_unlocked (),
152 .BR putwchar_unlocked ()
153 T} Thread safety T{
154 .na
155 .nh
156 MT-Unsafe race:stdout
157 T}
158 T{
159 .na
160 .nh
161 .BR feof_unlocked (),
162 .BR ferror_unlocked (),
163 .BR fileno_unlocked ()
164 T} Thread safety MT-Safe
165 .TE
166 .SH STANDARDS
167 .TP
168 .BR getc_unlocked ()
169 .TQ
170 .BR getchar_unlocked ()
171 .TQ
172 .BR putc_unlocked ()
173 .TQ
174 .BR putchar_unlocked ()
175 POSIX.1-2008.
176 .TP
177 Others:
178 None.
179 .SH HISTORY
180 .TP
181 .BR getc_unlocked ()
182 .TQ
183 .BR getchar_unlocked ()
184 .TQ
185 .BR putc_unlocked ()
186 .TQ
187 .BR putchar_unlocked ()
188 POSIX.1-2001.
189 .\" E.g., in HP-UX 10.0. In HP-UX 10.30 they are called obsolescent, and
190 .\" moved to a compatibility library.
191 .\" Available in HP-UX 10.0: clearerr_unlocked, fclose_unlocked,
192 .\" feof_unlocked, ferror_unlocked, fflush_unlocked, fgets_unlocked,
193 .\" fgetwc_unlocked, fgetws_unlocked, fileno_unlocked, fputs_unlocked,
194 .\" fputwc_unlocked, fputws_unlocked, fread_unlocked, fseek_unlocked,
195 .\" ftell_unlocked, fwrite_unlocked, getc_unlocked, getchar_unlocked,
196 .\" getw_unlocked, getwc_unlocked, getwchar_unlocked, putc_unlocked,
197 .\" putchar_unlocked, puts_unlocked, putws_unlocked, putw_unlocked,
198 .\" putwc_unlocked, putwchar_unlocked, rewind_unlocked, setvbuf_unlocked,
199 .\" ungetc_unlocked, ungetwc_unlocked.
200 .SH SEE ALSO
201 .BR flockfile (3),
202 .BR stdio (3)