Replace _symbolTypes hash table with std::map

Replaced custom hash table implementation, TR_HashTabString, with
std::map for storing mappings of symbols to their corresponding types
in MethodBuilder. This guarantees better type safety, alongside
helping to simplify the JitBuilder interfaces.

Signed-off-by: Sajid Ahmed <Syed.Sajid.Ahmed23@ibm.com>

Author: sajidahmed21

compiler/ilgen/MethodBuilder.cpp

@@ -35,6 +35,7 @@
 #include "compile/Compilation.hpp"
 #include "compile/SymbolReferenceTable.hpp"
 #include "control/Recompilation.hpp"
+#include "infra/Assert.hpp"
 #include "infra/Cfg.hpp"
 #include "infra/HashTab.hpp"
 #include "infra/STLUtils.hpp"
@@ -101,7 +102,7 @@ MethodBuilder::MethodBuilder(TR::TypeDictionary *types, OMR::VirtualMachineState
    _numParameters(0),
    _symbols(new (*_memoryRegion) TR_HashTabString(_trMemory)),
    _parameterSlot(str_comparator, *_memoryRegion),
-   _symbolTypes(new (*_memoryRegion) TR_HashTabString(_trMemory)),
+   _symbolTypes(str_comparator, *_memoryRegion),
    _symbolNameFromSlot(new (*_memoryRegion) TR_HashTabInt(_trMemory)),
    _symbolIsArray(new (*_memoryRegion) TR_HashTabString(_trMemory)),
    _memoryLocations(new (*_memoryRegion) TR_HashTabString(_trMemory)),
@@ -155,6 +156,7 @@ MethodBuilder::~MethodBuilder()
    {
    // Cleanup allocations in _memoryRegion *before* its destroyed below (see note in constructor)
    _parameterSlot.clear();
+   _symbolTypes.clear();
    _functions.clear();
 
    _trMemory->~TR_Memory();
@@ -345,24 +347,26 @@ MethodBuilder::connectTrees()
 bool
 MethodBuilder::symbolDefined(const char *name)
    {
-   TR_HashId id=0, typeID=0;
    // _symbols not good enough because symbol can be defined even if it has
    // never been stored to, but _symbolTypes will contain all symbols, even
    // if they have never been used. See ::DefineLocal, for example, which can
    // be called in a MethodBuilder contructor. In contrast, ::DefineSymbol
    // which inserts into _symbols, can only be called from within a MethodBuilder's
    // ::buildIL() method ).
-   return (_symbolTypes->locate(name, typeID));
+   return _symbolTypes.find(name) != _symbolTypes.end();
    }
 
 void
 MethodBuilder::defineSymbol(const char *name, TR::SymbolReference *symRef)
    {
-   TR_HashId id1=0, id2=0, id3;
+   TR_HashId id1=0, id2=0;
 
    _symbols->add(name, id1, (void *)symRef);
    _symbolNameFromSlot->add(symRef->getCPIndex(), id2, (void *)name);
-   _symbolTypes->add(name, id3, (void *)(uintptr_t) symRef->getSymbol()->getDataType());
+   
+   TR::IlType *type = typeDictionary()->PrimitiveType(symRef->getSymbol()->getDataType());
+   _symbolTypes.insert(std::make_pair(name, type));
+
    if (!_newSymbolsAreTemps)
       _methodSymbol->setFirstJitTempIndex(_methodSymbol->getTempIndex());
    }
@@ -376,23 +380,25 @@ MethodBuilder::lookupSymbol(const char *name)
       return (TR::SymbolReference *)_symbols->getData(symbolsID);
 
    TR::SymbolReference *symRef;
-   TR_HashId typesID;
-   _symbolTypes->locate(name, typesID);
+   SymbolTypeMap::iterator symTypesIterator =  _symbolTypes.find(name);
+
+   TR_ASSERT_FATAL(symTypesIterator != _symbolTypes.end(), "Symbol '%s' doesn't exist", name);
 
-   TR::DataType type = ((TR::IlType *)(_symbolTypes->getData(typesID)))->getPrimitiveType();
+   TR::IlType *symbolType = symTypesIterator->second;
+   TR::DataType primitiveType = symbolType->getPrimitiveType();
 
-   ParameterMap::iterator it = _parameterSlot.find(name);
-   if (it != _parameterSlot.end())
+   ParameterMap::iterator paramSlotsIterator = _parameterSlot.find(name);
+   if (paramSlotsIterator != _parameterSlot.end())
       {
-      int32_t slot = it->second;
+      int32_t slot = paramSlotsIterator->second;
       symRef = symRefTab()->findOrCreateAutoSymbol(_methodSymbol,
                                                    slot,
-                                                   type,
+                                                   primitiveType,
                                                    true, false, true);
       }
    else
       {
-      symRef = symRefTab()->createTemporary(_methodSymbol, type);
+      symRef = symRefTab()->createTemporary(_methodSymbol, primitiveType);
       symRef->getSymbol()->getAutoSymbol()->setName(name);
       TR_HashId nameFromSlotID;
       _symbolNameFromSlot->add(symRef->getCPIndex(), nameFromSlotID, (void *)name);
@@ -459,16 +465,14 @@ void
 MethodBuilder::DefineLocal(const char *name, TR::IlType *dt)
    {
    MB_REPLAY("DefineLocal(\"%s\", %s);", name, REPLAY_TYPE(dt));
-   TR_HashId typesID;
-   _symbolTypes->add(name, typesID, (void *)dt);
+   _symbolTypes.insert(std::make_pair(name, dt));
    }
 
 void
 MethodBuilder::DefineMemory(const char *name, TR::IlType *dt, void *location)
    {
    MB_REPLAY("DefineMemory(\"%s\", %s, " REPLAY_POINTER_FMT ");", name, REPLAY_TYPE(dt), REPLAY_POINTER(location, name));
-   TR_HashId typesID;
-   _symbolTypes->add(name, typesID, (void *) dt);
+   _symbolTypes.insert(std::make_pair(name, dt));
 
    TR_HashId locationsID;
    _memoryLocations->add(name, locationsID, location);
@@ -483,8 +487,7 @@ MethodBuilder::DefineParameter(const char *name, TR::IlType *dt)
    TR_HashId nameFromSlotID;
    _symbolNameFromSlot->add(_numParameters, nameFromSlotID, (void *) name);
 
-   TR_HashId typesID;
-   _symbolTypes->add(name, typesID, (void *) dt);
+   _symbolTypes.insert(std::make_pair(name, dt));
 
    _numParameters++;
    }
@@ -585,9 +588,11 @@ MethodBuilder::getParameterTypes()
       _symbolNameFromSlot->locate(p, nameFromSlotID);
       const char *name = (const char *) _symbolNameFromSlot->getData(nameFromSlotID);
 
-      TR_HashId typesID;
-      _symbolTypes->locate(name, typesID);
-      paramTypesArray[p] = (TR::IlType *) _symbolTypes->getData(typesID);
+      std::map<const char *, TR::IlType *, StrComparator>::iterator it = _symbolTypes.find(name);
+
+      TR_ASSERT_FATAL(it != _symbolTypes.end(), "No matching symbol type for parameter '%s'", name);
+
+      paramTypesArray[p] = it->second;
       }
 
    _cachedParameterTypes = paramTypesArray;

compiler/ilgen/MethodBuilder.hpp

@@ -196,7 +196,10 @@ class MethodBuilder : public TR::IlBuilder
    typedef std::map<const char *, int32_t, StrComparator, ParameterMapAllocator> ParameterMap;
    ParameterMap                _parameterSlot;
 
-   TR_HashTabString          * _symbolTypes;
+   typedef TR::typed_allocator<std::pair<const char *, TR::IlType *>, TR::Region &> SymbolTypeMapAllocator;
+   typedef std::map<const char *, TR::IlType *, StrComparator, SymbolTypeMapAllocator> SymbolTypeMap;
+   SymbolTypeMap               _symbolTypes;
+
    TR_HashTabInt             * _symbolNameFromSlot;
    TR_HashTabString          * _symbolIsArray;
    TR_HashTabString          * _memoryLocations;