xref: /aosp_15_r20/bionic/libc/include/bits/fortify/poll.h (revision 8d67ca893c1523eb926b9080dbe4e2ffd2a27ba1)
1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *    the documentation and/or other materials provided with the
13  *    distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _POLL_H_
30 #error "Never include this file directly; instead, include <poll.h>"
31 #endif
32 
33 
34 #if __BIONIC_AVAILABILITY_GUARD(23)
35 int __poll_chk(struct pollfd* _Nullable, nfds_t, int, size_t) __INTRODUCED_IN(23);
36 int __ppoll_chk(struct pollfd* _Nullable, nfds_t, const struct timespec* _Nullable, const sigset_t* _Nullable, size_t) __INTRODUCED_IN(23);
37 #endif /* __BIONIC_AVAILABILITY_GUARD(23) */
38 
39 
40 #if __BIONIC_AVAILABILITY_GUARD(28)
41 int __ppoll64_chk(struct pollfd* _Nullable, nfds_t, const struct timespec* _Nullable, const sigset64_t* _Nullable, size_t) __INTRODUCED_IN(28);
42 #endif /* __BIONIC_AVAILABILITY_GUARD(28) */
43 
44 
45 #if defined(__BIONIC_FORTIFY)
46 #define __bos_fd_count_trivially_safe(bos_val, fds, fd_count)              \
47   __bos_dynamic_check_impl_and((bos_val), >=, (sizeof(*fds) * (fd_count)), \
48                                (fd_count) <= __BIONIC_CAST(static_cast, nfds_t, -1) / sizeof(*fds))
49 
50 __BIONIC_FORTIFY_INLINE
poll(struct pollfd * _Nullable const fds __pass_object_size,nfds_t fd_count,int timeout)51 int poll(struct pollfd* _Nullable const fds __pass_object_size, nfds_t fd_count, int timeout)
52     __overloadable
53     __clang_error_if(__bos_unevaluated_lt(__bos(fds), sizeof(*fds) * fd_count),
54                      "in call to 'poll', fd_count is larger than the given buffer") {
55 #if __ANDROID_API__ >= 23 && __BIONIC_FORTIFY_RUNTIME_CHECKS_ENABLED
56   size_t bos_fds = __bos(fds);
57 
58   if (!__bos_fd_count_trivially_safe(bos_fds, fds, fd_count)) {
59     return __poll_chk(fds, fd_count, timeout, bos_fds);
60   }
61 #endif
62   return __call_bypassing_fortify(poll)(fds, fd_count, timeout);
63 }
64 
65 __BIONIC_FORTIFY_INLINE
ppoll(struct pollfd * _Nullable const fds __pass_object_size,nfds_t fd_count,const struct timespec * _Nullable timeout,const sigset_t * _Nullable mask)66 int ppoll(struct pollfd* _Nullable const fds __pass_object_size, nfds_t fd_count, const struct timespec* _Nullable timeout, const sigset_t* _Nullable mask)
67     __overloadable
68     __clang_error_if(__bos_unevaluated_lt(__bos(fds), sizeof(*fds) * fd_count),
69                      "in call to 'ppoll', fd_count is larger than the given buffer") {
70 #if __ANDROID_API__ >= 23 && __BIONIC_FORTIFY_RUNTIME_CHECKS_ENABLED
71   size_t bos_fds = __bos(fds);
72 
73   if (!__bos_fd_count_trivially_safe(bos_fds, fds, fd_count)) {
74     return __ppoll_chk(fds, fd_count, timeout, mask, bos_fds);
75   }
76 #endif
77   return __call_bypassing_fortify(ppoll)(fds, fd_count, timeout, mask);
78 }
79 
80 #if __ANDROID_API__ >= 28
81 __BIONIC_FORTIFY_INLINE
ppoll64(struct pollfd * _Nullable const fds __pass_object_size,nfds_t fd_count,const struct timespec * _Nullable timeout,const sigset64_t * _Nullable mask)82 int ppoll64(struct pollfd* _Nullable const fds __pass_object_size, nfds_t fd_count, const struct timespec* _Nullable timeout, const sigset64_t* _Nullable mask)
83     __overloadable
84     __clang_error_if(__bos_unevaluated_lt(__bos(fds), sizeof(*fds) * fd_count),
85                      "in call to 'ppoll64', fd_count is larger than the given buffer") {
86 #if __BIONIC_FORTIFY_RUNTIME_CHECKS_ENABLED
87   size_t bos_fds = __bos(fds);
88 
89   if (!__bos_fd_count_trivially_safe(bos_fds, fds, fd_count)) {
90     return __ppoll64_chk(fds, fd_count, timeout, mask, bos_fds);
91   }
92 #endif
93   return __call_bypassing_fortify(ppoll64)(fds, fd_count, timeout, mask);
94 }
95 #endif /* __ANDROID_API__ >= 28 */
96 
97 #undef __bos_fd_count_trivially_safe
98 
99 #endif /* defined(__BIONIC_FORTIFY) */
100