event_machine_helper.h

Go to the documentation of this file.

/*
 *   Copyright (c) 2012, Nokia Siemens Networks
 *   Copyright (c) 2015-2026, Nokia Solutions and Networks
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the copyright holder nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef EVENT_MACHINE_HELPER_H_
#define EVENT_MACHINE_HELPER_H_
 
#pragma GCC visibility push(default)
 
/**
 * @file
 * Event Machine helper functions and macros
 */
 
#include <event_machine/api/event_machine_types.h>
#include <event_machine/api/event_machine_error.h>
#include <event_machine/api/event_machine_core_mask.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**
 * Format error string
 *
 * Creates an error report string from EM internal errors.
 * Main use case: application error handlers to create an error report from
 * EM internal errors.
 *
 * @param[out] str     Output string pointer
 * @param      size    Maximum string length in characters
 * @param      eo      EO handle
 * @param      error   Error code (EM internal)
 * @param      escope  Error scope (EM internal)
 * @param      args    Variable arguments as passed to the error handler
 *
 * @return Output string length (including final '\0'), or 0 on invalid input
 */
int em_error_format_string(char *str /*out*/, size_t size, em_eo_t eo,
                           em_status_t error, em_escope_t escope, va_list args);
/**
 * @brief Print EM related version information
 *
 * Prints the EM version information, as well as version information for the
 * used ODP and HW etc. (similar to what EM prints at startup).
 *
 * For EM API version strings, defines and macros see
 * include/event_machine/api/event_machine_version.h
 *
 * The printed content may vary from one EM release to the next.
 */
void em_version_print(void);
 
/**
 * @brief Print miscellaneous EM information
 *
 * Print information about the running EM instance.
 * Mainly for debug or startup logging needs.
 *
 * The printed content may vary from one EM release to the next.
 */
void em_info_print(void);
 
/*
 * Physical core ids
 ***************************************
 */
 
/**
 * Converts a logical core id to a physical core id
 *
 * @note
 * This may be a very slow operation and MUST NOT be used in the fast path!
 *
 * @param core          Logical (Event Machine) core id
 *
 * @return Physical core id or -1 on error.
 */
int em_core_id_physical(int core);
 
/* Backwards compatible naming ("get") */
#define em_core_id_get_physical em_core_id_physical
 
/**
 * Converts a logical core mask to a physical core mask
 *
 * @note
 * This may be a very slow operation and MUST NOT be used in the fast path!
 *
 * @param[out] phys   Core mask of physical core ids
 * @param      logic  Core mask of logical (Event Machine) core ids
 */
void em_core_mask_physical(em_core_mask_t *phys /*out*/,
                           const em_core_mask_t *logic);
 
/* Backwards compatible naming ("get") */
#define em_core_mask_get_physical em_core_mask_physical
 
#ifdef __cplusplus
}
#endif
 
#pragma GCC visibility pop
#endif /* EVENT_MACHINE_HELPER_H_ */