flags.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Daniel R. Carvalho
 * Copyright (c) 2008 The Hewlett-Packard Development Company
 * All rights reserved.
 *
 * 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 holders 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 __BASE_FLAGS_HH__
#define __BASE_FLAGS_HH__
 
#include <type_traits>
 
namespace gem5
{
 
template <typename T>
class Flags
{
  private:
    static_assert(std::is_unsigned_v<T>, "Flag type must be unsigned");
 
    T _flags;
 
  public:
    typedef T Type;
 
    Flags(Type flags=0) : _flags(flags) {}
 
    operator const Type() const { return _flags; }
 
    const Flags<T> &
    operator=(T flags)
    {
        _flags = flags;
        return *this;
    }
 
    bool isSet(Type mask) const { return (_flags & mask); }
 
    bool allSet(Type mask) const { return (_flags & mask) == mask; }
 
    bool noneSet(Type mask) const { return (_flags & mask) == 0; }
 
    void clear() { _flags = 0; }
 
    void clear(Type mask) { _flags &= ~mask; }
 
    void set(Type mask) { _flags |= mask; }
 
    void
    set(Type mask, bool condition)
    {
        condition ? set(mask) : clear(mask);
    }
 
    void
    replace(Type flags, Type mask)
    {
        _flags = (_flags & ~mask) | (flags & mask);
    } // end of api_flags
};
 
} // namespace gem5
 
#endif // __BASE_FLAGS_HH__