Source/bmalloc/libpas/src/libpas/pas_object_size_mode.h

/*
 * Copyright (c) 2018-2019 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_OBJECT_SIZE_MODE_H
#define PAS_OBJECT_SIZE_MODE_H

#include "pas_utils.h"

PAS_BEGIN_EXTERN_C;

enum pas_object_size_mode {
    pas_large_object_size,
    pas_medium_object_size,
    pas_small_object_size
};

typedef enum pas_object_size_mode pas_object_size_mode;

#define PAS_NUM_OBJECT_SIZE_MODES 3

/* Use this like so:
   
       pas_object_size_mode object_size;
   
       for (PAS_EACH_OBJECT_SIZE_MODE_DOWN_FROM(object_size, pas_medium_object_size))
           ... do things to object_size ...
   
   That way it's easy to iterate over all modes from medium down to small. */
#define PAS_EACH_OBJECT_SIZE_MODE_DOWN_FROM(variable, start)  \
    variable = (start); \
    variable <= pas_small_object_size; \
    variable = (pas_object_size_mode)((unsigned)variable + 1)

/* Like PAS_EACH_OBJECT_SIZE_MODE_DOWN_FROM but for all of them. */
#define PAS_EACH_OBJECT_SIZE_MODE(variable) \
    PAS_EACH_OBJECT_SIZE_MODE_DOWN_FROM(variable, pas_large_object_size)

#define PAS_EACH_OBJECT_SIZE_MODE_UP_TO(variable, end) \
    variable = pas_small_object_size; \
    (int)variable >= (int)(end); \
    variable = (pas_object_size_mode)((unsigned)variable - 1)

static inline const char* pas_object_size_mode_get_string(pas_object_size_mode object_size)
{
    switch (object_size) {
    case pas_large_object_size:
        return "large";
    case pas_medium_object_size:
        return "medium";
    case pas_small_object_size:
        return "small";
    }
    PAS_ASSERT(!"Should not be reached");
    return NULL;
}

PAS_END_EXTERN_C;

#endif /* PAS_OBJECT_SIZE_MODE_H */