/*******************************************************************************
 * Copyright IBM Corp. and others 2000
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution
 * and is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License, v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception [1] and GNU General Public
 * License, version 2 with the OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] https://openjdk.org/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
 *******************************************************************************/

#ifndef OMR_CODECACHEMEMORYSEGMENT_INCL
#define OMR_CODECACHEMEMORYSEGMENT_INCL

/*
 * The following #defines and typedefs must appear before any #includes in this file
 */

#ifndef OMR_CODECACHEMEMORYSEGMENT_CONNECTOR
#define OMR_CODECACHEMEMORYSEGMENT_CONNECTOR

namespace OMR {
class CodeCacheMemorySegment;
typedef CodeCacheMemorySegment CodeCacheMemorySegmentConnector;
} // namespace OMR
#endif

#include <stddef.h>
#include <stdint.h>
#include "infra/Annotations.hpp"
#include "runtime/CodeCacheTypes.hpp"

namespace TR {
class CodeCacheMemorySegment;
class CodeCacheManager;
} // namespace TR

namespace OMR {

class OMR_EXTENSIBLE CodeCacheMemorySegment {
public:
    CodeCacheMemorySegment()
        : _base(NULL)
        , _alloc(NULL)
        , _top(NULL)
    {}

    CodeCacheMemorySegment(uint8_t *memory, size_t size)
        : _base(memory)
        , _alloc(memory)
        , _top(memory + size)
    {}

    CodeCacheMemorySegment(uint8_t *memory, uint8_t *top)
        : _base(memory)
        , _alloc(memory)
        , _top(top)
    {}

    TR::CodeCacheMemorySegment *self();

    void *operator new(size_t size, TR::CodeCacheMemorySegment *segment) { return segment; }

    void operator delete(void *pmem, TR::CodeCacheMemorySegment *segment) { /* do nothing */ }

    uint8_t *segmentBase() const { return _base; }

    uint8_t *segmentAlloc() const { return _alloc; }

    uint8_t *segmentTop() const { return _top; }

    void adjustAlloc(int64_t adjust);

    void setSegmentBase(uint8_t *newBase);
    void setSegmentAlloc(uint8_t *newAlloc);
    void setSegmentTop(uint8_t *newTop);

    // memory is backed by something else
    void free(TR::CodeCacheManager *manager);

    uint8_t *_base;
    uint8_t *_alloc;
    uint8_t *_top;
};

} // namespace OMR

#endif
