allocation_flag.hpp

Go to the documentation of this file.

/*
 * Copyright 2019, Intel Corporation
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 *     * 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.
 *
 *     * Neither the name of the copyright holder nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 THE COPYRIGHT
 * OWNER 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 LIBPMEMOBJ_CPP_ALLOCATION_FLAG_HPP
#define LIBPMEMOBJ_CPP_ALLOCATION_FLAG_HPP

#include <libpmemobj/base.h>

namespace pmem
{

namespace obj
{

struct allocation_flag {
    explicit allocation_flag(uint64_t val) : value(val)
    {
    }

    static allocation_flag
    class_id(uint64_t id)
    {
        return allocation_flag(POBJ_CLASS_ID(id));
    }

    static allocation_flag
    no_flush()
    {
        return allocation_flag(POBJ_XALLOC_NO_FLUSH);
    }

    static allocation_flag
    none()
    {
        return allocation_flag(0);
    }

    bool
    is_set(const allocation_flag &rhs)
    {
        return (value & rhs.value) != 0;
    }

    allocation_flag
    operator|(const allocation_flag &rhs)
    {
        return allocation_flag(value | rhs.value);
    }

    uint64_t value;
};

struct allocation_flag_atomic {
    explicit allocation_flag_atomic(uint64_t val) : value(val)
    {
    }

    static allocation_flag_atomic
    class_id(uint64_t id)
    {
        return allocation_flag_atomic(POBJ_CLASS_ID(id));
    }

    static allocation_flag_atomic
    none()
    {
        return allocation_flag_atomic(0);
    }

    bool
    is_set(const allocation_flag_atomic &rhs)
    {
        return (value & rhs.value) != 0;
    }

    allocation_flag_atomic
    operator|(const allocation_flag_atomic &rhs)
    {
        return allocation_flag_atomic(value | rhs.value);
    }

    uint64_t value;
};

} /* namespace obj */

} /* namespace pmem */

#endif /* LIBPMEMOBJ_CPP_ALLOCATION_FLAG_HPP */