Source/bmalloc/libpas/src/libpas/pas_local_allocator_result.h

/*
 * Copyright (c) 2018 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_LOCAL_ALLOCATOR_RESULT_H
#define PAS_LOCAL_ALLOCATOR_RESULT_H

#include "pas_utils.h"

PAS_BEGIN_EXTERN_C;

struct pas_local_allocator_result;
typedef struct pas_local_allocator_result pas_local_allocator_result;

/* This exists to allow jump-threading of success. */
struct pas_local_allocator_result {
    bool did_succeed;
    void* allocator; /* Could really be a local_allocator or a local_view_cache. */
};

static inline pas_local_allocator_result pas_local_allocator_result_create_failure(void)
{
    pas_local_allocator_result result;
    result.did_succeed = false;
    result.allocator = NULL;
    return result;
}

static inline pas_local_allocator_result pas_local_allocator_result_create_success(void* allocator)
{
    pas_local_allocator_result result;
    result.did_succeed = true;
    result.allocator = allocator;
    return result;
}

PAS_END_EXTERN_C;

#endif /* PAS_LOCAL_ALLOCATOR_RESULT_H */