mlpiTraceLib.h

Go to the documentation of this file.

#ifndef __MLPITRACELIB_H__
#define __MLPITRACELIB_H__

// -----------------------------------------------------------------------
// MLPI - <mlpiTraceLib.h>
// -----------------------------------------------------------------------
// Copyright (c) 2013 Bosch Rexroth. All rights reserved.
// Redistribution and use in source and binary forms of this MLPI software
// (SW) provided to you, with or without modification, are permitted
// without prior approval provided that the following conditions are met:
//
// 1. Redistributions of source code of SW must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form of SW 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.
//
// 3. User recognizes and acknowledges that it acquires no right,
// title or interest in or to any of the names or trademarks used in
// connection with the SW ("names") by virtue of this License and waives
// any right to or interest in the names. User recognizes and acknowledges
// that names of companies or names or products of companies displayed
// in the documentation of SW to indicate the interoperability of products
// with the SW are the names of their respective owners. The use of such
// names in the documentation of SW does not imply any sponsorship,
// approval, or endorsement by such companies of this product.
//
// 4. Modified code versions, i.e. any addition to or deletion from
// the substance or structure of the original code of the SW running
// the MLPI must be plainly marked as such and must not be misrepresented
// as being original SW.
//
// 5. The SW may only be used in connection with a Bosch Rexroth product.
//
// THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
// AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
// (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
// INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
// ERRORS OR INACCURACIES.
// SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
// THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
// NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
// THE  SOFTWARE  DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
// DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
// -----------------------------------------------------------------------
//
//
// -----------------------------------------------------------------------












// -----------------------------------------------------------------------
// GLOBAL INCLUDES
// -----------------------------------------------------------------------
#include "mlpiGlobal.h"


// -----------------------------------------------------------------------
// GLOBAL CONSTANTS
// -----------------------------------------------------------------------
#define MLPI_TRACE_MODULE_NAME_SIZE    (20)
#define MLPI_TRACE_BUFFER_NAME_SIZE    (20)
#define MLPI_TRACE_FUNCTION_NAME_SIZE  (30)
#define MLPI_TRACE_MESSAGE_SIZE        (130)

#define MLPI_TRACE_MAX_MODULES         (2000)
#define MLPI_TRACE_MAX_BUFFERS         (16)

#define MLPI_TRACE_MAIN_BUFFER_NAME     L"MAIN"                 
#define MLPI_TRACE_KIS_CMD_BUFFER_NAME  L"KIS_CMD_LOGGER"       

#define MLPI_TRACE_MODULE_USER          L"MLPI_TRACE_USER"      



// -----------------------------------------------------------------------
// GLOBAL TYPEDEFS
// -----------------------------------------------------------------------

typedef enum MlpiTraceType
{
  MLPI_TRACE_TYPE_OTHER     = 0,               
  MLPI_TRACE_TYPE_MESSAGE   = 1,               
  MLPI_TRACE_TYPE_WARNING   = 2,               
  MLPI_TRACE_TYPE_ERROR     = 3                
}MlpiTraceType;

// message packing follows 8 byte natural alignment
#if !defined(TARGET_OS_VXWORKS)
#pragma pack(push,8)
#endif

typedef struct MlpiTraceModuleInformation
{
  BOOL8   isActive;                                 
  BOOL8   toStdOut;                                 
  BOOL8   toMainBuffer;                             
  BOOL8   toSeparateBuffer;                         
  WCHAR16 moduleName[MLPI_TRACE_MODULE_NAME_SIZE];  
  WCHAR16 bufferName[MLPI_TRACE_BUFFER_NAME_SIZE];  
}MlpiTraceModuleInformation;

typedef struct MlpiTraceBufferInformation
{
  WCHAR16 bufferName[MLPI_TRACE_BUFFER_NAME_SIZE]; 
  LONG    maximumBufferSize;                       
  LONG    actualBufferSize;                        
  BOOL8   isLocked;                                
}MlpiTraceBufferInformation;

typedef struct MlpiTraceMessage
{
  ULLONG        index;                                          
  MlpiTraceType type;                                           
  ULONG         milliseconds;                                   
  ULONG         lineNumber;                                     
  ULONG         threadId;                                       
  WCHAR16       text[MLPI_TRACE_MESSAGE_SIZE];                  
  WCHAR16       moduleName[MLPI_TRACE_MODULE_NAME_SIZE];        
  WCHAR16       functionName[MLPI_TRACE_FUNCTION_NAME_SIZE];    
}MlpiTraceMessage;

#if !defined(TARGET_OS_VXWORKS)
#pragma pack(pop)
#endif





// -----------------------------------------------------------------------
// GLOBAL EXPORTS
// -----------------------------------------------------------------------
#ifdef MLPI_API
  #undef MLPI_API
#endif

#if defined(TARGET_OS_WINNT)
  #if defined(MLPI_EXPORTS)
    #define MLPI_API __declspec(dllexport)
  #elif defined(MLPI_IMPORTS)
    #define MLPI_API __declspec(dllimport)
  #else
    #define MLPI_API
  #endif
#else
  #if defined(MLPI_EXPORTS)
    #define MLPI_API __attribute__ ((visibility("default")))
  #elif defined(MLPI_IMPORTS)
    #define MLPI_API
  #else
    #define MLPI_API
  #endif
#endif


#ifdef __cplusplus
extern "C" {
#endif

MLPI_API MLPIRESULT mlpiTraceActivateModule(const MLPIHANDLE connection, const WCHAR16* moduleName);


MLPI_API MLPIRESULT mlpiTraceDeactivateModule(const MLPIHANDLE connection, const WCHAR16* moduleName);


MLPI_API MLPIRESULT mlpiTraceActivateAllModules(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiTraceDeactivateAllModules(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiTraceGetNumberOfModules(const MLPIHANDLE connection, ULONG* numberOfModules);


MLPI_API MLPIRESULT mlpiTraceGetModuleList(const MLPIHANDLE connection, MlpiTraceModuleInformation *moduleInfo, const ULONG numElements, ULONG *numElementsRet = 0);


MLPI_API MLPIRESULT mlpiTraceGetNumberOfBuffers(const MLPIHANDLE connection, ULONG* numberOfBuffers);


MLPI_API MLPIRESULT mlpiTraceGetBufferList(const MLPIHANDLE connection, MlpiTraceBufferInformation *bufferInfo, const ULONG numElements, ULONG *numElementsRet = 0);


MLPI_API MLPIRESULT mlpiTraceReadBuffer(const MLPIHANDLE connection, const WCHAR16 *bufferName, const ULLONG startIndex, MlpiTraceMessage *messages, const ULONG numElements, ULONG *numElementsRet = 0);


MLPI_API MLPIRESULT mlpiTraceGetNewestMessageIndex(const MLPIHANDLE connection, const WCHAR16 *bufferName, ULLONG *newestIndex);


MLPI_API MLPIRESULT mlpiTraceGetOldestMessageIndex(const MLPIHANDLE connection, const WCHAR16 *bufferName, ULLONG *oldestIndex);


MLPI_API MLPIRESULT mlpiTraceClearAllBuffers(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiTraceMessage(const MLPIHANDLE connection, const WCHAR16* text, const WCHAR16 *moduleName=0, const WCHAR16 *functionName=0, const LONG lineNumber=0);


MLPI_API MLPIRESULT mlpiTraceWarning(const MLPIHANDLE connection, const WCHAR16* text, const WCHAR16 *moduleName=0, const WCHAR16 *functionName=0, const LONG lineNumber=0);


MLPI_API MLPIRESULT mlpiTraceError(const MLPIHANDLE connection, const WCHAR16* text, const WCHAR16 *moduleName=0, const WCHAR16 *functionName=0, const LONG lineNumber=0);


MLPI_API MLPIRESULT mlpiTraceEvent(const MLPIHANDLE connection, const WCHAR16* text, const WCHAR16 *moduleName=0, const WCHAR16 *functionName=0, const LONG lineNumber=0);



#ifdef __cplusplus
}
#endif



#endif // endof: #ifndef __MLPITRACELIB_H__