function lfds700_stack_init_valid_on_current_logical_core

Source Files

└───liblfds700
    ├───inc
    │   └───liblfds700
    │           lfds700_stack.h
    └───src
        └───lfds700_stack
                lfds700_stack_init.c

Opaque Structures

struct lfds700_stack_state;

Prototype

void lfds700_stack_init_valid_on_current_logical_core( struct lfds700_stack_state *ss, void *user_state );

Parameters

struct lfds700_stack_state *ss

A pointer to a user-allocated LFDS700_PAL_ATOMIC_ISOLATION_IN_BYTES aligned struct lfds700_stack_state. Stack declared variables will automatically be correctly aligned by the compiler, due to the information in the structure definitions; nothing has to be done. Heap allocated variables however will by no means be correctly aligned and an aligned malloc must be used.

void *user_state

A void pointer for arbitrary user state. This is stored in the stack state and can be retrieved later at any time from the stack state using the LFDS700_STACK_GET_USER_STATE_FROM_STATE macro, in particular in callbacks, when they receive the stack state as one of their arguments.

Notes

As the function name indicates, the initialization work performed on the stack state is only valid on the current logical core. To make this work valid on other logical cores, threads on other cores must call LFDS700_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE.

This function instantiates a stack by initializing the stack state. The caller is responsible for all memory allocation and, after lfds700_stack_cleanup is called, for all deallocation.

Example

#include "liblfds700.h"

int main()
{
  struct lfds700_stack_state
    ss;

  lfds700_misc_library_init_valid_on_current_logical_core();

  lfds700_stack_init_valid_on_current_logical_core( &ss, NULL );

  lfds700_stack_cleanup( &ss, NULL );

  lfds700_misc_library_cleanup();

  return( EXIT_SUCCESS );
}

See Also

• Stack
• lfds700_stack_cleanup