/* -*- Mode: C++; c-basic-offset: 4; indent-tabs-mode: t; tab-width: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Initial Developer of the Original Code is
 * University of Szeged.
 * All Rights Reserved.
 *
 * Contributor(s):
 *   Department of Software Engineering
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifdef ENABLE_PROFILE_ARM
#ifndef ARMProfiler_h
#define ARMProfiler_h

// Provides integer types
//    uint32_t
//    uint64_t
#include <stdint.h>
// Alternatively, they can be defined here, if <stdint.h> is not supported

// provides FILE structure
#include <stdio.h>

namespace ARMProfiler {

// Add a new event and returns its index
uint32_t addProfileEvent(const char* functionName, const char* opcodeDescriptor);
// Print profile statistics and free memory (called at the end of each thread)
void printProfile(FILE* output);

// helper: auto-free memory blocks with free()
//   can be used for free functionNames passed to addProfileEvent
void autoFreeMemory(void* ptr);

// Called from JIT Engines:

// The following code should be generated (and should not break by any instruction):
//   push { r0, r1, r2, r3, ip, lr }   @ 0xe92d500f - it keeps the 8 byte alignment
//   ldr r0, [pc, #4]                  @ 0xe59f0004
//   add lr, pc, #8                    @ 0xe28fe008
//   ldr pc, [pc]                      @ 0xe59ff000
//   [ index word ]                    @ the index returned by addProfileEvent
//   [ &sampling ]                     @ function address
//   pop { r0, r1, r2, r3, ip, lr }    @ 0xe8bd500f
// 28 bytes

// Push a new entry to the call stack and init counters
void startSampling(uint32_t index);

// Update profile, which belongs to the last index, and reset counters
// If index is StopSampling, the current entry is popped from the stack
enum { StopSampling = 0x0fffffff };
void endSampling(uint32_t index);

// Pops entries from the stack in case of an exception
// (must be called from the exception handler)
void popCallStack(uint32_t level);

} // namespace ARMProfiler

#endif // ARMProfiler_h
#endif // ENABLE_PROFILE_ARM