Update copyright notices with scripts/update-copyrights
[glibc.git] / posix / bits / unistd.h
blob336b928b405886e1179f034efce8eae3380f7cd9
1 /* Checking macros for unistd functions.
2 Copyright (C) 2005-2014 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, see
17 <http://www.gnu.org/licenses/>. */
19 #ifndef _UNISTD_H
20 # error "Never include <bits/unistd.h> directly; use <unistd.h> instead."
21 #endif
23 extern ssize_t __read_chk (int __fd, void *__buf, size_t __nbytes,
24 size_t __buflen) __wur;
25 extern ssize_t __REDIRECT (__read_alias, (int __fd, void *__buf,
26 size_t __nbytes), read) __wur;
27 extern ssize_t __REDIRECT (__read_chk_warn,
28 (int __fd, void *__buf, size_t __nbytes,
29 size_t __buflen), __read_chk)
30 __wur __warnattr ("read called with bigger length than size of "
31 "the destination buffer");
33 __fortify_function __wur ssize_t
34 read (int __fd, void *__buf, size_t __nbytes)
36 if (__bos0 (__buf) != (size_t) -1)
38 if (!__builtin_constant_p (__nbytes))
39 return __read_chk (__fd, __buf, __nbytes, __bos0 (__buf));
41 if (__nbytes > __bos0 (__buf))
42 return __read_chk_warn (__fd, __buf, __nbytes, __bos0 (__buf));
44 return __read_alias (__fd, __buf, __nbytes);
47 #ifdef __USE_UNIX98
48 extern ssize_t __pread_chk (int __fd, void *__buf, size_t __nbytes,
49 __off_t __offset, size_t __bufsize) __wur;
50 extern ssize_t __pread64_chk (int __fd, void *__buf, size_t __nbytes,
51 __off64_t __offset, size_t __bufsize) __wur;
52 extern ssize_t __REDIRECT (__pread_alias,
53 (int __fd, void *__buf, size_t __nbytes,
54 __off_t __offset), pread) __wur;
55 extern ssize_t __REDIRECT (__pread64_alias,
56 (int __fd, void *__buf, size_t __nbytes,
57 __off64_t __offset), pread64) __wur;
58 extern ssize_t __REDIRECT (__pread_chk_warn,
59 (int __fd, void *__buf, size_t __nbytes,
60 __off_t __offset, size_t __bufsize), __pread_chk)
61 __wur __warnattr ("pread called with bigger length than size of "
62 "the destination buffer");
63 extern ssize_t __REDIRECT (__pread64_chk_warn,
64 (int __fd, void *__buf, size_t __nbytes,
65 __off64_t __offset, size_t __bufsize),
66 __pread64_chk)
67 __wur __warnattr ("pread64 called with bigger length than size of "
68 "the destination buffer");
70 # ifndef __USE_FILE_OFFSET64
71 __fortify_function __wur ssize_t
72 pread (int __fd, void *__buf, size_t __nbytes, __off_t __offset)
74 if (__bos0 (__buf) != (size_t) -1)
76 if (!__builtin_constant_p (__nbytes))
77 return __pread_chk (__fd, __buf, __nbytes, __offset, __bos0 (__buf));
79 if ( __nbytes > __bos0 (__buf))
80 return __pread_chk_warn (__fd, __buf, __nbytes, __offset,
81 __bos0 (__buf));
83 return __pread_alias (__fd, __buf, __nbytes, __offset);
85 # else
86 __fortify_function __wur ssize_t
87 pread (int __fd, void *__buf, size_t __nbytes, __off64_t __offset)
89 if (__bos0 (__buf) != (size_t) -1)
91 if (!__builtin_constant_p (__nbytes))
92 return __pread64_chk (__fd, __buf, __nbytes, __offset, __bos0 (__buf));
94 if ( __nbytes > __bos0 (__buf))
95 return __pread64_chk_warn (__fd, __buf, __nbytes, __offset,
96 __bos0 (__buf));
99 return __pread64_alias (__fd, __buf, __nbytes, __offset);
101 # endif
103 # ifdef __USE_LARGEFILE64
104 __fortify_function __wur ssize_t
105 pread64 (int __fd, void *__buf, size_t __nbytes, __off64_t __offset)
107 if (__bos0 (__buf) != (size_t) -1)
109 if (!__builtin_constant_p (__nbytes))
110 return __pread64_chk (__fd, __buf, __nbytes, __offset, __bos0 (__buf));
112 if ( __nbytes > __bos0 (__buf))
113 return __pread64_chk_warn (__fd, __buf, __nbytes, __offset,
114 __bos0 (__buf));
117 return __pread64_alias (__fd, __buf, __nbytes, __offset);
119 # endif
120 #endif
122 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K
123 extern ssize_t __readlink_chk (const char *__restrict __path,
124 char *__restrict __buf, size_t __len,
125 size_t __buflen)
126 __THROW __nonnull ((1, 2)) __wur;
127 extern ssize_t __REDIRECT_NTH (__readlink_alias,
128 (const char *__restrict __path,
129 char *__restrict __buf, size_t __len), readlink)
130 __nonnull ((1, 2)) __wur;
131 extern ssize_t __REDIRECT_NTH (__readlink_chk_warn,
132 (const char *__restrict __path,
133 char *__restrict __buf, size_t __len,
134 size_t __buflen), __readlink_chk)
135 __nonnull ((1, 2)) __wur __warnattr ("readlink called with bigger length "
136 "than size of destination buffer");
138 __fortify_function __nonnull ((1, 2)) __wur ssize_t
139 __NTH (readlink (const char *__restrict __path, char *__restrict __buf,
140 size_t __len))
142 if (__bos (__buf) != (size_t) -1)
144 if (!__builtin_constant_p (__len))
145 return __readlink_chk (__path, __buf, __len, __bos (__buf));
147 if ( __len > __bos (__buf))
148 return __readlink_chk_warn (__path, __buf, __len, __bos (__buf));
150 return __readlink_alias (__path, __buf, __len);
152 #endif
154 #ifdef __USE_ATFILE
155 extern ssize_t __readlinkat_chk (int __fd, const char *__restrict __path,
156 char *__restrict __buf, size_t __len,
157 size_t __buflen)
158 __THROW __nonnull ((2, 3)) __wur;
159 extern ssize_t __REDIRECT_NTH (__readlinkat_alias,
160 (int __fd, const char *__restrict __path,
161 char *__restrict __buf, size_t __len),
162 readlinkat)
163 __nonnull ((2, 3)) __wur;
164 extern ssize_t __REDIRECT_NTH (__readlinkat_chk_warn,
165 (int __fd, const char *__restrict __path,
166 char *__restrict __buf, size_t __len,
167 size_t __buflen), __readlinkat_chk)
168 __nonnull ((2, 3)) __wur __warnattr ("readlinkat called with bigger "
169 "length than size of destination "
170 "buffer");
172 __fortify_function __nonnull ((2, 3)) __wur ssize_t
173 __NTH (readlinkat (int __fd, const char *__restrict __path,
174 char *__restrict __buf, size_t __len))
176 if (__bos (__buf) != (size_t) -1)
178 if (!__builtin_constant_p (__len))
179 return __readlinkat_chk (__fd, __path, __buf, __len, __bos (__buf));
181 if (__len > __bos (__buf))
182 return __readlinkat_chk_warn (__fd, __path, __buf, __len,
183 __bos (__buf));
185 return __readlinkat_alias (__fd, __path, __buf, __len);
187 #endif
189 extern char *__getcwd_chk (char *__buf, size_t __size, size_t __buflen)
190 __THROW __wur;
191 extern char *__REDIRECT_NTH (__getcwd_alias,
192 (char *__buf, size_t __size), getcwd) __wur;
193 extern char *__REDIRECT_NTH (__getcwd_chk_warn,
194 (char *__buf, size_t __size, size_t __buflen),
195 __getcwd_chk)
196 __wur __warnattr ("getcwd caller with bigger length than size of "
197 "destination buffer");
199 __fortify_function __wur char *
200 __NTH (getcwd (char *__buf, size_t __size))
202 if (__bos (__buf) != (size_t) -1)
204 if (!__builtin_constant_p (__size))
205 return __getcwd_chk (__buf, __size, __bos (__buf));
207 if (__size > __bos (__buf))
208 return __getcwd_chk_warn (__buf, __size, __bos (__buf));
210 return __getcwd_alias (__buf, __size);
213 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
214 extern char *__getwd_chk (char *__buf, size_t buflen)
215 __THROW __nonnull ((1)) __wur;
216 extern char *__REDIRECT_NTH (__getwd_warn, (char *__buf), getwd)
217 __nonnull ((1)) __wur __warnattr ("please use getcwd instead, as getwd "
218 "doesn't specify buffer size");
220 __fortify_function __nonnull ((1)) __attribute_deprecated__ __wur char *
221 __NTH (getwd (char *__buf))
223 if (__bos (__buf) != (size_t) -1)
224 return __getwd_chk (__buf, __bos (__buf));
225 return __getwd_warn (__buf);
227 #endif
229 extern size_t __confstr_chk (int __name, char *__buf, size_t __len,
230 size_t __buflen) __THROW;
231 extern size_t __REDIRECT_NTH (__confstr_alias, (int __name, char *__buf,
232 size_t __len), confstr);
233 extern size_t __REDIRECT_NTH (__confstr_chk_warn,
234 (int __name, char *__buf, size_t __len,
235 size_t __buflen), __confstr_chk)
236 __warnattr ("confstr called with bigger length than size of destination "
237 "buffer");
239 __fortify_function size_t
240 __NTH (confstr (int __name, char *__buf, size_t __len))
242 if (__bos (__buf) != (size_t) -1)
244 if (!__builtin_constant_p (__len))
245 return __confstr_chk (__name, __buf, __len, __bos (__buf));
247 if (__bos (__buf) < __len)
248 return __confstr_chk_warn (__name, __buf, __len, __bos (__buf));
250 return __confstr_alias (__name, __buf, __len);
254 extern int __getgroups_chk (int __size, __gid_t __list[], size_t __listlen)
255 __THROW __wur;
256 extern int __REDIRECT_NTH (__getgroups_alias, (int __size, __gid_t __list[]),
257 getgroups) __wur;
258 extern int __REDIRECT_NTH (__getgroups_chk_warn,
259 (int __size, __gid_t __list[], size_t __listlen),
260 __getgroups_chk)
261 __wur __warnattr ("getgroups called with bigger group count than what "
262 "can fit into destination buffer");
264 __fortify_function int
265 __NTH (getgroups (int __size, __gid_t __list[]))
267 if (__bos (__list) != (size_t) -1)
269 if (!__builtin_constant_p (__size) || __size < 0)
270 return __getgroups_chk (__size, __list, __bos (__list));
272 if (__size * sizeof (__gid_t) > __bos (__list))
273 return __getgroups_chk_warn (__size, __list, __bos (__list));
275 return __getgroups_alias (__size, __list);
279 extern int __ttyname_r_chk (int __fd, char *__buf, size_t __buflen,
280 size_t __nreal) __THROW __nonnull ((2));
281 extern int __REDIRECT_NTH (__ttyname_r_alias, (int __fd, char *__buf,
282 size_t __buflen), ttyname_r)
283 __nonnull ((2));
284 extern int __REDIRECT_NTH (__ttyname_r_chk_warn,
285 (int __fd, char *__buf, size_t __buflen,
286 size_t __nreal), __ttyname_r_chk)
287 __nonnull ((2)) __warnattr ("ttyname_r called with bigger buflen than "
288 "size of destination buffer");
290 __fortify_function int
291 __NTH (ttyname_r (int __fd, char *__buf, size_t __buflen))
293 if (__bos (__buf) != (size_t) -1)
295 if (!__builtin_constant_p (__buflen))
296 return __ttyname_r_chk (__fd, __buf, __buflen, __bos (__buf));
298 if (__buflen > __bos (__buf))
299 return __ttyname_r_chk_warn (__fd, __buf, __buflen, __bos (__buf));
301 return __ttyname_r_alias (__fd, __buf, __buflen);
305 #if defined __USE_REENTRANT || defined __USE_POSIX199506
306 extern int __getlogin_r_chk (char *__buf, size_t __buflen, size_t __nreal)
307 __nonnull ((1));
308 extern int __REDIRECT (__getlogin_r_alias, (char *__buf, size_t __buflen),
309 getlogin_r) __nonnull ((1));
310 extern int __REDIRECT (__getlogin_r_chk_warn,
311 (char *__buf, size_t __buflen, size_t __nreal),
312 __getlogin_r_chk)
313 __nonnull ((1)) __warnattr ("getlogin_r called with bigger buflen than "
314 "size of destination buffer");
316 __fortify_function int
317 getlogin_r (char *__buf, size_t __buflen)
319 if (__bos (__buf) != (size_t) -1)
321 if (!__builtin_constant_p (__buflen))
322 return __getlogin_r_chk (__buf, __buflen, __bos (__buf));
324 if (__buflen > __bos (__buf))
325 return __getlogin_r_chk_warn (__buf, __buflen, __bos (__buf));
327 return __getlogin_r_alias (__buf, __buflen);
329 #endif
332 #if defined __USE_BSD || defined __USE_UNIX98
333 extern int __gethostname_chk (char *__buf, size_t __buflen, size_t __nreal)
334 __THROW __nonnull ((1));
335 extern int __REDIRECT_NTH (__gethostname_alias, (char *__buf, size_t __buflen),
336 gethostname) __nonnull ((1));
337 extern int __REDIRECT_NTH (__gethostname_chk_warn,
338 (char *__buf, size_t __buflen, size_t __nreal),
339 __gethostname_chk)
340 __nonnull ((1)) __warnattr ("gethostname called with bigger buflen than "
341 "size of destination buffer");
343 __fortify_function int
344 __NTH (gethostname (char *__buf, size_t __buflen))
346 if (__bos (__buf) != (size_t) -1)
348 if (!__builtin_constant_p (__buflen))
349 return __gethostname_chk (__buf, __buflen, __bos (__buf));
351 if (__buflen > __bos (__buf))
352 return __gethostname_chk_warn (__buf, __buflen, __bos (__buf));
354 return __gethostname_alias (__buf, __buflen);
356 #endif
359 #if defined __USE_BSD || (defined __USE_XOPEN && !defined __USE_UNIX98)
360 extern int __getdomainname_chk (char *__buf, size_t __buflen, size_t __nreal)
361 __THROW __nonnull ((1)) __wur;
362 extern int __REDIRECT_NTH (__getdomainname_alias, (char *__buf,
363 size_t __buflen),
364 getdomainname) __nonnull ((1)) __wur;
365 extern int __REDIRECT_NTH (__getdomainname_chk_warn,
366 (char *__buf, size_t __buflen, size_t __nreal),
367 __getdomainname_chk)
368 __nonnull ((1)) __wur __warnattr ("getdomainname called with bigger "
369 "buflen than size of destination "
370 "buffer");
372 __fortify_function int
373 __NTH (getdomainname (char *__buf, size_t __buflen))
375 if (__bos (__buf) != (size_t) -1)
377 if (!__builtin_constant_p (__buflen))
378 return __getdomainname_chk (__buf, __buflen, __bos (__buf));
380 if (__buflen > __bos (__buf))
381 return __getdomainname_chk_warn (__buf, __buflen, __bos (__buf));
383 return __getdomainname_alias (__buf, __buflen);
385 #endif