CodeCacheTypes.hpp

/*******************************************************************************
 * 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 CODECACHETYPES_INCL
#define CODECACHETYPES_INCL

#ifdef OMRZTPF
#define __TPF_DO_NOT_MAP_ATOE_REMOVE
#endif

#undef CODECACHE_DEBUG

#include <stddef.h>
#include <stdint.h>
#if defined(CODECACHE_DEBUG)
#include <stdio.h>
#endif /* CODECACHE_DEBUG */

#include "runtime/MethodExceptionData.hpp"

/*
 *  Debugging help
 */
#if defined(CODECACHE_DEBUG)
#define mcc_printf(fmt, ...) printf(fmt, ##__VA_ARGS__)
#else
#define mcc_printf(fmt, ...) ((void)0)
#endif

class TR_OpaqueMethodBlock;
namespace TR { class CodeCacheManager; }

namespace OMR
{

typedef void CodeCacheTrampolineCode;

struct CodeCacheErrorCode {
   // error codes are negative numbers
   enum ErrorCode
      {
      ERRORCODE_SUCCESS           = 0,
      ERRORCODE_INSUFFICIENTSPACE = -1,
      ERRORCODE_FATALERROR        = -2
      };
   };


enum CodeCacheFlags
   {
   CODECACHE_FULL_SYNC_REQUIRED =   0x00000001,   // Force synchronization of all permanent trampolines
   CODECACHE_CACHE_IS_FULL      =   0x00000002,   // Code cache is marked/considered full
   CODECACHE_TRAMP_REPORTED =       0x00000004,   // Code cache tramp region has been reported.
   CODECACHE_CCPRELOADED_REPORTED = 0x00000008,   // Code cache pre loaded code region has been reported.
   };


class CodeCacheHashEntrySlab
   {
public:
   CodeCacheHashEntrySlab() { }

   void *operator new(size_t s, CodeCacheHashEntrySlab *slab) { return slab; }

   void operator delete(void *ptr, CodeCacheHashEntrySlab *slab) { /* do nothing */ }

   static CodeCacheHashEntrySlab *allocate(TR::CodeCacheManager *manager, size_t slabSize);
   void free(TR::CodeCacheManager *manager);

   uint8_t                *_segment;
   uint8_t                *_heapAlloc;
   uint8_t                *_heapTop;
   CodeCacheHashEntrySlab *_next;
   };

typedef size_t CodeCacheHashKey;
struct CodeCacheHashEntry
   {
   CodeCacheHashEntry *_next;
   CodeCacheHashKey _key;
   union
      {
      struct
         {
         TR_OpaqueMethodBlock *_method;
         void *_currentStartPC;
         void *_currentTrampoline;
         } _resolved;
      struct
         {
         void *_constPool;
         int32_t _constPoolIndex;
         } _unresolved;
      } _info;
   };

class CodeCacheHashTable
   {
public:
   CodeCacheHashTable() { }

   void *operator new(size_t s, CodeCacheHashTable *table) { return table; }
   void operator delete(void *p, CodeCacheHashTable *table) { /* do nothing */ }

   static CodeCacheHashTable *allocate(TR::CodeCacheManager *codeCacheManager);
   static size_t hashUnresolvedMethod(void *constPool, int32_t constPoolIndex);
   static size_t hashResolvedMethod(TR_OpaqueMethodBlock *method);

   CodeCacheHashEntry *findUnresolvedMethod(void *constPool, int32_t constPoolIndex);
   CodeCacheHashEntry *findResolvedMethod(TR_OpaqueMethodBlock *method);

   void dumpHashUnresolvedMethod(void);
   void reloHashUnresolvedMethod(void *constPoolOld,void *constPoolNew, int32_t cpIndex);

   void add(CodeCacheHashEntry *entry);
   bool remove(CodeCacheHashEntry *entry);

   CodeCacheHashEntry **_buckets;
   size_t               _size;
   };


struct CodeCacheTempTrampolineSyncBlock
   {
   CodeCacheHashEntry              **_hashEntryArray;  /*!< a list of hash entries representing trampolines to be synchronized */
   int32_t                           _entryCount;      /*!< Number of temp trampolines in the list */
   int32_t                           _entryListSize;   /*!< maximum size of the list */
   CodeCacheTempTrampolineSyncBlock *_next;            /*!< next list to handle overflow */
   };


struct CodeCacheMethodHeader
   {
   uint32_t _size;
   char _eyeCatcher[4];
   OMR::MethodExceptionData *_metaData;
   };

CodeCacheMethodHeader *getCodeCacheMethodHeader(char *p, int searchLimit, MethodExceptionData *metaData);


struct CodeCacheFreeCacheBlock
   {
   size_t _size;
   CodeCacheFreeCacheBlock *_next;
   };
#define MIN_SIZE_BLOCK (sizeof(CodeCacheFreeCacheBlock) > 96 ? sizeof(CodeCacheFreeCacheBlock) : 96)


struct FaintCacheBlock
   {
   FaintCacheBlock *_next;
   OMR::MethodExceptionData *_metaData;
   uint8_t _bytesToSaveAtStart;
   bool _isStillLive;
   };

#define addFreeBlock2(start, end) addFreeBlock2WithCallSite((start), (end), __FILE__, __LINE__)

}

#endif // CODECAHCETYPES_INCL