GitLab

Matthew Pickering pushed to branch wip/stable-ipe-info at Glasgow Haskell Compiler / GHC

Commits:

59f62065

by Matthew Pickering at 2025-07-03T16:01:26+01:00

ipe: Use stable IDs for IPE entries

IPEs have historically been indexed and reported by their address.
This makes it impossible to compare profiles between runs, since the
addresses may change (due to ASLR) and also makes it tricky to separate
out the IPE map from the binary.

This small patch adds a stable identifier for each IPE entry.

The stable identifier is a single 64 bit word. The high-bits are a
per-module identifier and the low bits identify which entry in each
module.

1. When a node is added into the IPE buffer it is assigned a unique
   identifier from an incrementing global counter.
2. Each entry already has an index by it's position in the
   `IpeBufferListNode`.

The two are combined together by the `IPE_ENTRY_KEY` macro.

Info table profiling uses the stable identifier rather than the address
of the info table.

The benefits of this change are:

* Profiles from different runs can be easily compared
* The metadata can be extracted from the binary (via the eventlog for
  example) and then stripped from the executable.

Fixes #21766

5 changed files:

compiler/GHC/StgToCmm/InfoTableProv.hs
rts/IPE.c
rts/ProfHeap.c
rts/eventlog/EventLog.c
rts/include/rts/IPE.h

Changes:

compiler/GHC/StgToCmm/InfoTableProv.hs

@@ -158,6 +158,9 @@ emitIpeBufferListNode this_mod ents dus0 = do
            [ -- 'next' field
              zeroCLit platform
 +            -- 'node_id' field
 +          , zeroCLit platform
++
              -- 'compressed' field
            , int do_compress

rts/IPE.c

@@ -62,6 +62,22 @@ entry's containing IpeBufferListNode and its index in that node.
  When the user looks up an IPE entry, we convert it to the user-facing
  InfoProvEnt representation.
 +Note [Stable identifiers for IPE entries]
 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
++
 +Each IPE entry is given a stable identifier which remains the same across
 +different runs of the executable (unlike the address of the info table).
++
 +The identifier is a 64-bit word which consists of two parts.
++
 +* The high 32-bits are a per-node identifier.
 +* The low 32-bits are the index of the entry in the node.
++
 +When a node is queued in the pending list by `registerInfoProvList` it is
 +given a unique identifier from an incrementing global variable.
++
 +The unique key can be computed by using the `IPE_ENTRY_KEY` macro.
++
  */
  typedef struct {
@@ -69,6 +85,13 @@ typedef struct {
      uint32_t idx;
  } IpeMapEntry;
 +// See Note [Stable identifiers for IPE entries]
 +#define IPE_ENTRY_KEY(entry) \
 +    MAKE_IPE_KEY((entry).node->node_id, (entry).idx)
++
 +#define MAKE_IPE_KEY(module_id, idx) \
 +    ((((uint64_t)(module_id)) << 32) | ((uint64_t)(idx)))
++
  #if defined(THREADED_RTS)
  static Mutex ipeMapLock;
  #endif
@@ -78,6 +101,9 @@ static HashTable *ipeMap = NULL;
  // Accessed atomically
  static IpeBufferListNode *ipeBufferList = NULL;
 +// A global counter which is used to give an IPE entry a unique value across runs.
 +static StgWord next_module_id = 1; // Start at 1 to reserve 0 as "invalid"
++
  static void decompressIPEBufferListNodeIfCompressed(IpeBufferListNode*);
  static void updateIpeMap(void);
@@ -114,6 +140,7 @@ static InfoProvEnt ipeBufferEntryToIpe(const IpeBufferListNode *node, uint32_t i
      return (InfoProvEnt) {
              .info = node->tables[idx],
              .prov = {
 +                .info_prov_id  = MAKE_IPE_KEY(node->node_id, idx),
                  .table_name = &strings[ent->table_name],
                  .closure_desc = ent->closure_desc,
                  .ty_desc = &strings[ent->ty_desc],
@@ -181,9 +208,22 @@ A performance test for IPE registration and lookup can be found here:
  https://gitlab.haskell.org/ghc/ghc/-/merge_requests/5724#note_370806
  */
  void registerInfoProvList(IpeBufferListNode *node) {
++
 +        // Grab a fresh module_id
 +    uint32_t module_id;
 +    StgWord temp_module_id;
 +    while (true) {
 +        temp_module_id = next_module_id;
 +        if (cas(&next_module_id, temp_module_id, temp_module_id+1) == temp_module_id) {
 +            module_id = (uint32_t) temp_module_id;
 +            break;
 +        }
++
 +    }
      while (true) {
          IpeBufferListNode *old = RELAXED_LOAD(&ipeBufferList);
          node->next = old;
 +        node->node_id = module_id;
          if (cas_ptr((volatile void **) &ipeBufferList, old, node) == (void *) old) {
              return;
+         }
@@ -205,6 +245,18 @@ bool lookupIPE(const StgInfoTable *info, InfoProvEnt *out) {
+     }
+ }
 +// Returns 0 when the info table is not present in the info table map.
 +// See Note [Stable identifiers for IPE entries]
 +uint64_t lookupIPEId(const StgInfoTable *info) {
 +    updateIpeMap();
 +    IpeMapEntry *map_ent = (IpeMapEntry *) lookupHashTable(ipeMap, (StgWord)(info));
 +    if (map_ent){
 +        return IPE_ENTRY_KEY(*map_ent);
 +    } else {
 +        return 0;
 +    }
 +}
++
  void updateIpeMap(void) {
      // Check if there's any work at all. If not so, we can circumvent locking,
      // which decreases performance.

rts/ProfHeap.c

@@ -23,6 +23,7 @@
  #include "Printer.h"
  #include "Trace.h"
  #include "sm/GCThread.h"
 +#include "IPE.h"
  #include <fs_rts.h>
  #include <string.h>
@@ -230,9 +231,10 @@ closureIdentity( const StgClosure *p )
              return closure_type_names[info->type];
+         }
+     }
 -    case HEAP_BY_INFO_TABLE: {
 -        return get_itbl(p);
 -        }
 +    case HEAP_BY_INFO_TABLE:
 +    {
 +        return (void *) (p->header.info);
 +    }
      default:
          barf("closureIdentity");
@@ -853,6 +855,20 @@ aggregateCensusInfo( void )
+ }
  #endif
 +static void
 +recordIPEHeapSample(FILE *hp_file, uint64_t table_id, size_t count)
 +{
 +    // Print to heap profile file
 +    fprintf(hp_file, "0x%" PRIx64, table_id);
++
 +    // Create label string for tracing
 +    char str[100];
 +    sprintf(str, "0x%" PRIx64, table_id);
++
 +    // Emit the profiling sample (convert count to bytes)
 +    traceHeapProfSampleString(0, str, count * sizeof(W_));
 +}
++
  /* -----------------------------------------------------------------------------
   * Print out the results of a heap census.
   * -------------------------------------------------------------------------- */
@@ -915,6 +931,11 @@ dumpCensus( Census *census )
+     }
  #endif
 +    // Census entries which we need to group together.
 +    // Used by IPE profiling to group together bands which don't have IPE information.
 +    // Printing at the end in the 0 band
 +    uint64_t uncategorised_count = 0;
++
      for (ctr = census->ctrs; ctr != NULL; ctr = ctr->next) {
  #if defined(PROFILING)
@@ -944,12 +965,15 @@ dumpCensus( Census *census )
              traceHeapProfSampleString(0, (char *)ctr->identity,
                                        count * sizeof(W_));
              break;
 -        case HEAP_BY_INFO_TABLE:
 -            fprintf(hp_file, "%p", ctr->identity);
 -            char str[100];
 -            sprintf(str, "%p", ctr->identity);
 -            traceHeapProfSampleString(0, str, count * sizeof(W_));
 +        case HEAP_BY_INFO_TABLE: {
 +            uint64_t table_id = lookupIPEId(ctr->identity);
 +            if (! table_id) {
 +              uncategorised_count += count;
 +              continue;
 +            }
 +            recordIPEHeapSample(hp_file, table_id, count);
              break;
 +            }
  #if defined(PROFILING)
          case HEAP_BY_CCS:
              fprint_ccs(hp_file, (CostCentreStack *)ctr->identity,
@@ -999,9 +1023,21 @@ dumpCensus( Census *census )
              barf("dumpCensus; doHeapProfile");
+         }
++
++
          fprintf(hp_file, "\t%" FMT_Word "\n", (W_)count * sizeof(W_));
+     }
 +    // Print the unallocated data into the 0 band for info table profiling.
 +    switch (RtsFlags.ProfFlags.doHeapProfile) {
 +        case HEAP_BY_INFO_TABLE:
 +            recordIPEHeapSample(hp_file, 0, uncategorised_count);
 +            break;
 +        default:
 +            ASSERT(uncategorised_count == 0);
 +            break;
 +    }
++
      traceHeapProfSampleEnd(era);
      printSample(false, census->time);

rts/eventlog/EventLog.c

@@ -1472,7 +1472,7 @@ void postIPE(const InfoProvEnt *ipe)
      CHECK(!ensureRoomForVariableEvent(&eventBuf, len));
      postEventHeader(&eventBuf, EVENT_IPE);
      postPayloadSize(&eventBuf, len);
 -    postWord64(&eventBuf, (StgWord) INFO_PTR_TO_STRUCT(ipe->info));
 +    postWord64(&eventBuf, (StgWord) (ipe->prov.info_prov_id));
      postStringLen(&eventBuf, ipe->prov.table_name, table_name_len);
      postStringLen(&eventBuf, closure_desc_buf, closure_desc_len);
      postStringLen(&eventBuf, ipe->prov.ty_desc, ty_desc_len);

rts/include/rts/IPE.h

@@ -14,6 +14,7 @@
  #pragma once
  typedef struct InfoProv_ {
 +    uint64_t   info_prov_id;
      const char *table_name;
      uint32_t closure_desc; // closure type
      const char *ty_desc;
@@ -67,19 +68,33 @@ GHC_STATIC_ASSERT(sizeof(IpeBufferEntry) % (WORD_SIZE_IN_BITS / 8) == 0, "sizeof
  // See Note [IPE Stripping and magic words]
  #define IPE_MAGIC_WORD 0x4950450049504500UL
 +// Heap profiling currently requires a 32 bit pointer.. so for now just truncate
 +// the key to fit. It should still be big enough.
 +#if SIZEOF_VOID_P == 4
 +// On 32-bit systems: keep lower 16 bits of module_id and idx
 +#define IPE_PROF_KEY(key64) \
 +    (uint32_t)((((key64) >> 16) & 0xFFFF0000) | ((key64) & 0x0000FFFF))
 +#else
 +// On 64-bit systems: use full key
 +#define IPE_PROF_KEY(key64) (key64)
 +#endif
++
  typedef struct {
 -    StgWord magic;          // Must be IPE_MAGIC_WORD
 +    StgWord64 magic;          // Must be IPE_MAGIC_WORD
      IpeBufferEntry entries[]; // Flexible array member
  } IpeBufferEntryBlock;
  typedef struct {
 -    StgWord magic;          // Must be IPE_MAGIC_WORD
 +    StgWord64 magic;          // Must be IPE_MAGIC_WORD
      char string_table[];    // Flexible array member for string table
  } IpeStringTableBlock;
  typedef struct IpeBufferListNode_ {
      struct IpeBufferListNode_ *next;
 +    // This field is filled in when the node is registered.
 +    uint32_t node_id;
++
      // Everything below is read-only and generated by the codegen
      // This flag should be treated as a boolean
@@ -112,6 +127,8 @@ void formatClosureDescIpe(const InfoProvEnt *ipe_buf, char *str_buf);
  // Returns true on success, initializes `out`.
  bool lookupIPE(const StgInfoTable *info, InfoProvEnt *out);
 +uint64_t lookupIPEId(const StgInfoTable *info);
++
  #if defined(DEBUG)
  void printIPE(const StgInfoTable *info);
  #endif