bsls::PerformanceHint Struct Reference

#include <bsls_performancehint.h>

List of all members.

Static Public Member Functions
static void	prefetchForReading (const void *address)
static void	prefetchForWriting (void *address)
static void	rarelyCalled ()
static void	lowFrequency ()

---

Detailed Description

This struct provides a namespace for a suite of functions that give performance hints to the compiler or hardware.

See Component bsls_performancehint

---

Member Function Documentation

static void bsls::PerformanceHint::prefetchForReading

(

const void *

address

)

[static]

Prefetch one cache line worth of data at the specified address for reading if the compiler built-in is available (see to the component level document for limitations). Otherwise this method has no effect.

static void bsls::PerformanceHint::prefetchForWriting

(

void *

address

)

[static]

Prefetch one cache line worth of data at the specified address for writing if the compiler built-in is available (see to the component level document for limitations). Otherwise this method has no effect.

static void bsls::PerformanceHint::rarelyCalled

(

)

[static]

This is an empty function that is marked as rarely called using pragmas. If this function is placed in a block of code inside a branch, the compiler will optimize the assembly code generated and mark the block as unlikely. Note that this function is intentionally not inlined.

static void bsls::PerformanceHint::lowFrequency

(

)

[static]

This is an empty function that is marked with low execution frequency using pragmas. If this function is placed in a block of code inside a branch, the compiler will optimize the assembly code generated and mark the block as unlikely.

---

The documentation for this struct was generated from the following file:

• bsls_performancehint.h