source: trunk/soclib/soclib/lib/segment/include/segment.h @ 2200

/* -*- c++ -*-
 *
 * SOCLIB_LGPL_HEADER_BEGIN
 * 
 * This file is part of SoCLib, GNU LGPLv2.1.
 * 
 * SoCLib is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; version 2.1 of the License.
 * 
 * SoCLib is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with SoCLib; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 * 
 * SOCLIB_LGPL_HEADER_END
 *
 * Copyright (c) UPMC, Lip6, Asim
 *         Nicolas Pouillon <nipo@ssji.net>, 2007
 *
 * Based on previous works by Francois Pecheux & Alain Greiner
 *
 * Maintainers: nipo
 */
#ifndef SOCLIB_SEGMENT_H_
#define SOCLIB_SEGMENT_H_

#include "exception.h"
#include "int_tab.h"
#include "stdint.h"
#include <string>

namespace soclib { namespace common {

class Segment
{
    typedef uint64_t addr_t;
    
    std::string m_name;
    addr_t m_base_address;
    size_t m_size;
    IntTab m_target_index;
    bool   m_cacheability;
    bool   m_initiator;
    IntTab m_initiator_index;

public:
    Segment( const std::string &name,
             addr_t base_address,
             size_t size,
             const IntTab &target_index,
             bool cacheability,
             bool initiator = false,
             const IntTab &initiator_index = soclib::common::IntTab() )
            : m_name(name), m_base_address(base_address),
              m_size(size), m_target_index(target_index),
              m_cacheability(cacheability),
              m_initiator(initiator),
              m_initiator_index(initiator_index)
    {
    }

    const Segment &operator=( const Segment &ref )
    {
        if ( &ref == this )
            return *this;

        m_name = ref.m_name;
        m_base_address = ref.m_base_address;
        m_size = ref.m_size;
        m_target_index = ref.m_target_index;
        m_cacheability = ref.m_cacheability;
        m_initiator = ref.m_initiator;
        m_initiator_index = ref.m_initiator_index;

        return *this;
    }

    inline addr_t baseAddress() const
    {
        return m_base_address;
    }

    inline size_t size() const
    {
        return m_size;
    }

    inline bool cacheable() const
    {
        return m_cacheability;
    }

    inline bool initiator() const
    {
        return m_initiator;
    }

    inline const std::string &name() const
    {
        return m_name;
    }

    inline const IntTab &index() const
    {
        return m_target_index;
    }

    inline const IntTab &initiator_index() const
    {
        return m_initiator_index;
    }

    bool isOverlapping( const Segment &other ) const;

    void print( std::ostream &o ) const;

    friend std::ostream &operator << (std::ostream &o, const Segment &s)
    {
        s.print(o);
        return o;
    }

    inline bool contains( addr_t addr ) const
    {
        return ( addr >= m_base_address &&
                 ( addr < m_base_address+m_size
                   || m_base_address+m_size < m_base_address) );
    }

    inline Segment masked( addr_t addr ) const
    {
        Segment s = *this;
        s.m_base_address &= addr;
        return s;
    }
};

}}

#endif /* SOCLIB_SEGMENT_H_ */

// Local Variables:
// tab-width: 4
// c-basic-offset: 4
// c-file-offsets:((innamespace . 0)(inline-open . 0))
// indent-tabs-mode: nil
// End:

// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=4:softtabstop=4