memutils_memorychunk.h File Reference

#include "utils/memutils_internal.h"

Include dependency graph for memutils_memorychunk.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	MemoryChunk

Macros
#define	MEMORYCHUNK_MAX_VALUE   UINT64CONST(0x3FFFFFFF)
#define	MEMORYCHUNK_MAX_BLOCKOFFSET   UINT64CONST(0x3FFFFFFF)
#define	MEMORYCHUNK_BLOCKOFFSET_MASK   UINT64CONST(0x3FFFFFFE)
#define	MEMORYCHUNK_EXTERNAL_BASEBIT   MEMORY_CONTEXT_METHODID_BITS
#define	MEMORYCHUNK_VALUE_BASEBIT   (MEMORYCHUNK_EXTERNAL_BASEBIT + 1)
#define	MEMORYCHUNK_BLOCKOFFSET_BASEBIT   (MEMORYCHUNK_VALUE_BASEBIT + 29)
#define	MEMORYCHUNK_MAGIC
#define	PointerGetMemoryChunk(p)    ((MemoryChunk *) ((char *) (p) - sizeof(MemoryChunk)))
#define	MemoryChunkGetPointer(c)    ((void *) ((char *) (c) + sizeof(MemoryChunk)))
#define	HdrMaskIsExternal(hdrmask)    ((hdrmask) & (((uint64) 1) << MEMORYCHUNK_EXTERNAL_BASEBIT))
#define	HdrMaskGetValue(hdrmask)    (((hdrmask) >> MEMORYCHUNK_VALUE_BASEBIT) & MEMORYCHUNK_MAX_VALUE)
#define	HdrMaskBlockOffset(hdrmask)    (((hdrmask) >> MEMORYCHUNK_BLOCKOFFSET_BASEBIT) & MEMORYCHUNK_BLOCKOFFSET_MASK)
#define	HdrMaskCheckMagic(hdrmask)

Typedefs
typedef struct MemoryChunk	MemoryChunk

Functions
static void	MemoryChunkSetHdrMask (MemoryChunk *chunk, void *block, Size value, MemoryContextMethodID methodid)
static void	MemoryChunkSetHdrMaskExternal (MemoryChunk *chunk, MemoryContextMethodID methodid)
static bool	MemoryChunkIsExternal (MemoryChunk *chunk)
static Size	MemoryChunkGetValue (MemoryChunk *chunk)
static void *	MemoryChunkGetBlock (MemoryChunk *chunk)

Macro Definition Documentation

HdrMaskBlockOffset

#define HdrMaskBlockOffset

(

hdrmask

)

(((hdrmask) >> MEMORYCHUNK_BLOCKOFFSET_BASEBIT) & MEMORYCHUNK_BLOCKOFFSET_MASK)

Definition at line 151 of file memutils_memorychunk.h.

{
    Size        blockoffset = (char *) chunk - (char *) block;
 
    Assert((char *) chunk >= (char *) block);
    Assert((blockoffset & MEMORYCHUNK_BLOCKOFFSET_MASK) == blockoffset);
    Assert(value <= MEMORYCHUNK_MAX_VALUE);
    Assert((int) methodid <= MEMORY_CONTEXT_METHODID_MASK);
 
    chunk->hdrmask = (((uint64) blockoffset) << MEMORYCHUNK_BLOCKOFFSET_BASEBIT) |
        (((uint64) value) << MEMORYCHUNK_VALUE_BASEBIT) |
        methodid;
}
 
/*
 * MemoryChunkSetHdrMaskExternal
 *      Set 'chunk' as an externally managed chunk.  Here we only record the
 *      MemoryContextMethodID and set the external chunk bit.
 */
static inline void
MemoryChunkSetHdrMaskExternal(MemoryChunk *chunk,
                              MemoryContextMethodID methodid)
{
    Assert((int) methodid <= MEMORY_CONTEXT_METHODID_MASK);
 
    chunk->hdrmask = MEMORYCHUNK_MAGIC | (((uint64) 1) << MEMORYCHUNK_EXTERNAL_BASEBIT) |
        methodid;
}
 
/*
 * MemoryChunkIsExternal
 *      Return true if 'chunk' is marked as external.
 */
static inline bool
MemoryChunkIsExternal(MemoryChunk *chunk)
{
    /*
     * External chunks should always store MEMORYCHUNK_MAGIC in the upper
     * portion of the hdrmask, check that nothing has stomped on that.
     */
    Assert(!HdrMaskIsExternal(chunk->hdrmask) ||
           HdrMaskCheckMagic(chunk->hdrmask));
 
    return HdrMaskIsExternal(chunk->hdrmask);
}
 
/*
 * MemoryChunkGetValue
 *      For non-external chunks, returns the value field as it was set in
 *      MemoryChunkSetHdrMask.
 */
static inline Size
MemoryChunkGetValue(MemoryChunk *chunk)
{
    Assert(!HdrMaskIsExternal(chunk->hdrmask));
 
    return HdrMaskGetValue(chunk->hdrmask);
}
 
/*
 * MemoryChunkGetBlock
 *      For non-external chunks, returns the pointer to the block as was set
 *      in MemoryChunkSetHdrMask.
 */
static inline void *
MemoryChunkGetBlock(MemoryChunk *chunk)
{
    Assert(!HdrMaskIsExternal(chunk->hdrmask));
 
    return (void *) ((char *) chunk - HdrMaskBlockOffset(chunk->hdrmask));
}
 
/* cleanup all internal definitions */
#undef MEMORYCHUNK_BLOCKOFFSET_MASK
#undef MEMORYCHUNK_EXTERNAL_BASEBIT
#undef MEMORYCHUNK_VALUE_BASEBIT
#undef MEMORYCHUNK_BLOCKOFFSET_BASEBIT
#undef MEMORYCHUNK_MAGIC
#undef HdrMaskIsExternal
#undef HdrMaskGetValue
#undef HdrMaskBlockOffset
#undef HdrMaskCheckMagic
 
#endif                          /* MEMUTILS_MEMORYCHUNK_H */

HdrMaskCheckMagic

#define HdrMaskCheckMagic

(

hdrmask

)

Value:

    (MEMORYCHUNK_MAGIC == \
     ((hdrmask) >> MEMORYCHUNK_VALUE_BASEBIT << MEMORYCHUNK_VALUE_BASEBIT))

Definition at line 155 of file memutils_memorychunk.h.

HdrMaskGetValue

#define HdrMaskGetValue

(

hdrmask

)

(((hdrmask) >> MEMORYCHUNK_VALUE_BASEBIT) & MEMORYCHUNK_MAX_VALUE)

Definition at line 144 of file memutils_memorychunk.h.

HdrMaskIsExternal

#define HdrMaskIsExternal

(

hdrmask

)

((hdrmask) & (((uint64) 1) << MEMORYCHUNK_EXTERNAL_BASEBIT))

Definition at line 142 of file memutils_memorychunk.h.

MEMORYCHUNK_BLOCKOFFSET_BASEBIT

#define MEMORYCHUNK_BLOCKOFFSET_BASEBIT   (MEMORYCHUNK_VALUE_BASEBIT + 29)

Definition at line 113 of file memutils_memorychunk.h.

MEMORYCHUNK_BLOCKOFFSET_MASK

#define MEMORYCHUNK_BLOCKOFFSET_MASK   UINT64CONST(0x3FFFFFFE)

Definition at line 108 of file memutils_memorychunk.h.

MEMORYCHUNK_EXTERNAL_BASEBIT

#define MEMORYCHUNK_EXTERNAL_BASEBIT   MEMORY_CONTEXT_METHODID_BITS

Definition at line 111 of file memutils_memorychunk.h.

MEMORYCHUNK_MAGIC

#define MEMORYCHUNK_MAGIC

Value:

                                 (UINT64CONST(0xB1A8DB858EB6EFBA) >> \
                                 MEMORYCHUNK_VALUE_BASEBIT << \
                                 MEMORYCHUNK_VALUE_BASEBIT)

Definition at line 120 of file memutils_memorychunk.h.

MEMORYCHUNK_MAX_BLOCKOFFSET

#define MEMORYCHUNK_MAX_BLOCKOFFSET   UINT64CONST(0x3FFFFFFF)

Definition at line 102 of file memutils_memorychunk.h.

MEMORYCHUNK_MAX_VALUE

#define MEMORYCHUNK_MAX_VALUE   UINT64CONST(0x3FFFFFFF)

Definition at line 96 of file memutils_memorychunk.h.

MEMORYCHUNK_VALUE_BASEBIT

#define MEMORYCHUNK_VALUE_BASEBIT   (MEMORYCHUNK_EXTERNAL_BASEBIT + 1)

Definition at line 112 of file memutils_memorychunk.h.

MemoryChunkGetPointer

#define MemoryChunkGetPointer

(

c

)

((void *) ((char *) (c) + sizeof(MemoryChunk)))

Definition at line 138 of file memutils_memorychunk.h.

PointerGetMemoryChunk

#define PointerGetMemoryChunk

(

p

)

((MemoryChunk *) ((char *) (p) - sizeof(MemoryChunk)))

Definition at line 135 of file memutils_memorychunk.h.

Typedef Documentation

MemoryChunk

typedef struct MemoryChunk MemoryChunk

Function Documentation

MemoryChunkGetBlock()

static void * MemoryChunkGetBlock ( MemoryChunk *  chunk )

inlinestatic

Definition at line 235 of file memutils_memorychunk.h.

{
    Assert(!HdrMaskIsExternal(chunk->hdrmask));
 
    return (void *) ((char *) chunk - HdrMaskBlockOffset(chunk->hdrmask));
}

References Assert, fb(), HdrMaskBlockOffset, and HdrMaskIsExternal.

Referenced by AlignedAllocFree(), AlignedAllocGetChunkContext(), AlignedAllocGetChunkSpace(), AlignedAllocRealloc(), AllocSetFree(), AllocSetGetChunkContext(), AllocSetRealloc(), GenerationFree(), GenerationGetChunkContext(), GenerationRealloc(), SlabFree(), SlabGetChunkContext(), SlabGetChunkSpace(), and SlabRealloc().

MemoryChunkGetValue()

static Size MemoryChunkGetValue ( MemoryChunk *  chunk )

inlinestatic

Definition at line 222 of file memutils_memorychunk.h.

{
    Assert(!HdrMaskIsExternal(chunk->hdrmask));
 
    return HdrMaskGetValue(chunk->hdrmask);
}

References Assert, fb(), HdrMaskGetValue, and HdrMaskIsExternal.

Referenced by AlignedAllocRealloc(), AllocSetAlloc(), AllocSetFree(), AllocSetGetChunkSpace(), AllocSetRealloc(), AllocSetStats(), GenerationFree(), GenerationGetChunkSpace(), and GenerationRealloc().

MemoryChunkIsExternal()

static bool MemoryChunkIsExternal ( MemoryChunk *  chunk )

inlinestatic

Definition at line 204 of file memutils_memorychunk.h.

{
    /*
     * External chunks should always store MEMORYCHUNK_MAGIC in the upper
     * portion of the hdrmask, check that nothing has stomped on that.
     */
    Assert(!HdrMaskIsExternal(chunk->hdrmask) ||
           HdrMaskCheckMagic(chunk->hdrmask));
 
    return HdrMaskIsExternal(chunk->hdrmask);
}

References Assert, fb(), HdrMaskCheckMagic, and HdrMaskIsExternal.

Referenced by AlignedAllocFree(), AlignedAllocGetChunkContext(), AllocSetFree(), AllocSetGetChunkContext(), AllocSetGetChunkSpace(), AllocSetRealloc(), GenerationFree(), GenerationGetChunkContext(), GenerationGetChunkSpace(), and GenerationRealloc().

MemoryChunkSetHdrMask()

static void MemoryChunkSetHdrMask ( MemoryChunk *  chunk, void *  block, Size  value, MemoryContextMethodID  methodid  )

inlinestatic

Definition at line 169 of file memutils_memorychunk.h.

{
    Size        blockoffset = (char *) chunk - (char *) block;
 
    Assert((char *) chunk >= (char *) block);
    Assert((blockoffset & MEMORYCHUNK_BLOCKOFFSET_MASK) == blockoffset);
    Assert(value <= MEMORYCHUNK_MAX_VALUE);
    Assert((int) methodid <= MEMORY_CONTEXT_METHODID_MASK);
 
    chunk->hdrmask = (((uint64) blockoffset) << MEMORYCHUNK_BLOCKOFFSET_BASEBIT) |
        (((uint64) value) << MEMORYCHUNK_VALUE_BASEBIT) |
        methodid;
}

References Assert, fb(), MEMORY_CONTEXT_METHODID_MASK, MEMORYCHUNK_BLOCKOFFSET_BASEBIT, MEMORYCHUNK_BLOCKOFFSET_MASK, MEMORYCHUNK_MAX_VALUE, MEMORYCHUNK_VALUE_BASEBIT, and value.

Referenced by AllocSetAllocChunkFromBlock(), AllocSetAllocFromNewBlock(), BumpAllocChunkFromBlock(), GenerationAllocChunkFromBlock(), MemoryContextAllocAligned(), and SlabAllocSetupNewChunk().

MemoryChunkSetHdrMaskExternal()

static void MemoryChunkSetHdrMaskExternal ( MemoryChunk *  chunk, MemoryContextMethodID  methodid  )

inlinestatic

Definition at line 190 of file memutils_memorychunk.h.

{
    Assert((int) methodid <= MEMORY_CONTEXT_METHODID_MASK);
 
    chunk->hdrmask = MEMORYCHUNK_MAGIC | (((uint64) 1) << MEMORYCHUNK_EXTERNAL_BASEBIT) |
        methodid;
}

References Assert, fb(), MEMORY_CONTEXT_METHODID_MASK, MEMORYCHUNK_EXTERNAL_BASEBIT, and MEMORYCHUNK_MAGIC.

Referenced by AllocSetAllocLarge(), BumpAllocLarge(), and GenerationAllocLarge().