| /* |
| * Copyright (c) 2018-2021 Apple Inc. 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. |
| * |
| * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``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 APPLE INC. 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. |
| */ |
| |
| #ifndef PAS_ALLOCATION_RESULT_H |
| #define PAS_ALLOCATION_RESULT_H |
| |
| #include <errno.h> |
| #include "pas_utils.h" |
| #include "pas_zero_mode.h" |
| |
| PAS_BEGIN_EXTERN_C; |
| |
| struct pas_allocation_result; |
| typedef struct pas_allocation_result pas_allocation_result; |
| |
| /* Normally, we just return NULL to mean that allocation failed. But in some cases it's better |
| to separate out the allocation result status from the pointer to make compiler transformations |
| on the allocation fast path work. */ |
| struct pas_allocation_result { |
| uintptr_t begin; |
| bool did_succeed; |
| pas_zero_mode zero_mode; |
| }; |
| |
| typedef pas_allocation_result (*pas_allocation_result_filter)(pas_allocation_result result); |
| |
| static inline pas_allocation_result pas_allocation_result_create_failure(void) |
| { |
| pas_allocation_result result; |
| result.did_succeed = false; |
| result.zero_mode = pas_zero_mode_may_have_non_zero; |
| result.begin = 0; |
| return result; |
| } |
| |
| static inline pas_allocation_result |
| pas_allocation_result_create_success_with_zero_mode(uintptr_t begin, |
| pas_zero_mode zero_mode) |
| { |
| pas_allocation_result result; |
| result.did_succeed = true; |
| result.zero_mode = zero_mode; |
| result.begin = begin; |
| return result; |
| } |
| |
| static inline pas_allocation_result pas_allocation_result_create_success(uintptr_t begin) |
| { |
| return pas_allocation_result_create_success_with_zero_mode( |
| begin, pas_zero_mode_may_have_non_zero); |
| } |
| |
| static PAS_ALWAYS_INLINE pas_allocation_result |
| pas_allocation_result_identity(pas_allocation_result result) |
| { |
| return result; |
| } |
| |
| static PAS_ALWAYS_INLINE pas_allocation_result |
| pas_allocation_result_zero(pas_allocation_result result, |
| size_t size) |
| { |
| if (result.did_succeed |
| && result.zero_mode == pas_zero_mode_may_have_non_zero) { |
| pas_zero_memory((void*)result.begin, size); |
| return pas_allocation_result_create_success_with_zero_mode( |
| result.begin, pas_zero_mode_is_all_zero); |
| } |
| return result; |
| } |
| |
| static PAS_ALWAYS_INLINE pas_allocation_result |
| pas_allocation_result_set_errno(pas_allocation_result result) |
| { |
| if (!result.did_succeed) |
| errno = ENOMEM; |
| return result; |
| } |
| |
| static PAS_ALWAYS_INLINE pas_allocation_result |
| pas_allocation_result_crash_on_error(pas_allocation_result result) |
| { |
| PAS_ASSERT(result.did_succeed); |
| return result; |
| } |
| |
| PAS_END_EXTERN_C; |
| |
| #endif /* PAS_ALLOCATION_RESULT_H */ |