|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* Copyright (c) 2004-2009 Voltaire, Inc. All rights reserved.
|
|
Packit |
13e616 |
* Copyright (c) 2002-2012 Mellanox Technologies LTD. All rights reserved.
|
|
Packit |
13e616 |
* Copyright (c) 1996-2003 Intel Corporation. All rights reserved.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* This software is available to you under a choice of one of two
|
|
Packit |
13e616 |
* licenses. You may choose to be licensed under the terms of the GNU
|
|
Packit |
13e616 |
* General Public License (GPL) Version 2, available from the file
|
|
Packit |
13e616 |
* COPYING in the main directory of this source tree, or the
|
|
Packit |
13e616 |
* OpenIB.org BSD license below:
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* Redistribution and use in source and binary forms, with or
|
|
Packit |
13e616 |
* without modification, are permitted provided that the following
|
|
Packit |
13e616 |
* conditions are met:
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* - Redistributions of source code must retain the above
|
|
Packit |
13e616 |
* copyright notice, this list of conditions and the following
|
|
Packit |
13e616 |
* disclaimer.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* - Redistributions in binary form must reproduce the above
|
|
Packit |
13e616 |
* copyright notice, this list of conditions and the following
|
|
Packit |
13e616 |
* disclaimer in the documentation and/or other materials
|
|
Packit |
13e616 |
* provided with the distribution.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
Packit |
13e616 |
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
Packit |
13e616 |
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
Packit |
13e616 |
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
|
Packit |
13e616 |
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
Packit |
13e616 |
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
Packit |
13e616 |
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
Packit |
13e616 |
* SOFTWARE.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* Abstract:
|
|
Packit |
13e616 |
* Declaration of osm_log_t.
|
|
Packit |
13e616 |
* This object represents the log file.
|
|
Packit |
13e616 |
* This object is part of the OpenSM family of objects.
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#ifndef _OSM_LOG_H_
|
|
Packit |
13e616 |
#define _OSM_LOG_H_
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#ifndef __WIN__
|
|
Packit |
13e616 |
#include <syslog.h>
|
|
Packit |
13e616 |
#endif
|
|
Packit |
13e616 |
#include <complib/cl_spinlock.h>
|
|
Packit |
13e616 |
#include <opensm/osm_base.h>
|
|
Packit |
13e616 |
#include <iba/ib_types.h>
|
|
Packit |
13e616 |
#include <stdio.h>
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#ifdef __GNUC__
|
|
Packit |
13e616 |
#define STRICT_OSM_LOG_FORMAT __attribute__((format(printf, 3, 4)))
|
|
Packit |
13e616 |
#define STRICT_OSM_LOG_V2_FORMAT __attribute__((format(printf, 4, 5)))
|
|
Packit |
13e616 |
#else
|
|
Packit |
13e616 |
#define STRICT_OSM_LOG_FORMAT
|
|
Packit |
13e616 |
#define STRICT_OSM_LOG_V2_FORMAT
|
|
Packit |
13e616 |
#endif
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#ifdef __cplusplus
|
|
Packit |
13e616 |
# define BEGIN_C_DECLS extern "C" {
|
|
Packit |
13e616 |
# define END_C_DECLS }
|
|
Packit |
13e616 |
#else /* !__cplusplus */
|
|
Packit |
13e616 |
# define BEGIN_C_DECLS
|
|
Packit |
13e616 |
# define END_C_DECLS
|
|
Packit |
13e616 |
#endif /* __cplusplus */
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
BEGIN_C_DECLS
|
|
Packit |
13e616 |
#define LOG_ENTRY_SIZE_MAX 4096
|
|
Packit |
13e616 |
#define BUF_SIZE LOG_ENTRY_SIZE_MAX
|
|
Packit |
13e616 |
#define __func__ __FUNCTION__
|
|
Packit |
13e616 |
#ifdef FILE_ID
|
|
Packit |
13e616 |
#define OSM_LOG_ENTER( OSM_LOG_PTR ) \
|
|
Packit |
13e616 |
osm_log_v2( OSM_LOG_PTR, OSM_LOG_FUNCS, FILE_ID, \
|
|
Packit |
13e616 |
"%s: [\n", __func__);
|
|
Packit |
13e616 |
#define OSM_LOG_EXIT( OSM_LOG_PTR ) \
|
|
Packit |
13e616 |
osm_log_v2( OSM_LOG_PTR, OSM_LOG_FUNCS, FILE_ID, \
|
|
Packit |
13e616 |
"%s: ]\n", __func__);
|
|
Packit |
13e616 |
#define OSM_LOG_IS_ACTIVE_V2( OSM_LOG_PTR, OSM_LOG_FUNCS ) \
|
|
Packit |
13e616 |
osm_log_is_active_v2( OSM_LOG_PTR, OSM_LOG_FUNCS, FILE_ID)
|
|
Packit |
13e616 |
#else
|
|
Packit |
13e616 |
#define OSM_LOG_ENTER( OSM_LOG_PTR ) \
|
|
Packit |
13e616 |
osm_log( OSM_LOG_PTR, OSM_LOG_FUNCS, \
|
|
Packit |
13e616 |
"%s: [\n", __func__);
|
|
Packit |
13e616 |
#define OSM_LOG_EXIT( OSM_LOG_PTR ) \
|
|
Packit |
13e616 |
osm_log( OSM_LOG_PTR, OSM_LOG_FUNCS, \
|
|
Packit |
13e616 |
"%s: ]\n", __func__);
|
|
Packit |
13e616 |
#endif
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****h* OpenSM/Log
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* Log
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* AUTHOR
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
typedef uint8_t osm_log_level_t;
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#define OSM_LOG_NONE 0x00
|
|
Packit |
13e616 |
#define OSM_LOG_ERROR 0x01
|
|
Packit |
13e616 |
#define OSM_LOG_INFO 0x02
|
|
Packit |
13e616 |
#define OSM_LOG_VERBOSE 0x04
|
|
Packit |
13e616 |
#define OSM_LOG_DEBUG 0x08
|
|
Packit |
13e616 |
#define OSM_LOG_FUNCS 0x10
|
|
Packit |
13e616 |
#define OSM_LOG_FRAMES 0x20
|
|
Packit |
13e616 |
#define OSM_LOG_ROUTING 0x40
|
|
Packit |
13e616 |
#define OSM_LOG_ALL 0x7f
|
|
Packit |
13e616 |
#define OSM_LOG_SYS 0x80
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
DEFAULT - turn on ERROR and INFO only
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
#define OSM_LOG_DEFAULT_LEVEL OSM_LOG_ERROR | OSM_LOG_INFO
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****s* OpenSM: Log/osm_log_t
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_log_t
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
typedef struct osm_log {
|
|
Packit |
13e616 |
osm_log_level_t level;
|
|
Packit |
13e616 |
cl_spinlock_t lock;
|
|
Packit |
13e616 |
unsigned long count;
|
|
Packit |
13e616 |
unsigned long max_size;
|
|
Packit |
13e616 |
boolean_t flush;
|
|
Packit |
13e616 |
FILE *out_port;
|
|
Packit |
13e616 |
boolean_t accum_log_file;
|
|
Packit |
13e616 |
boolean_t daemon;
|
|
Packit |
13e616 |
char *log_file_name;
|
|
Packit |
13e616 |
char *log_prefix;
|
|
Packit |
13e616 |
osm_log_level_t per_mod_log_tbl[256];
|
|
Packit |
13e616 |
} osm_log_t;
|
|
Packit |
13e616 |
/*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#define OSM_LOG_MOD_NAME_MAX 32
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Log/osm_get_log_per_module
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_get_log_per_module
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* This looks up the given file ID in the per module log table.
|
|
Packit |
13e616 |
* NOTE: this code is not thread safe. Need to grab the lock before
|
|
Packit |
13e616 |
* calling it.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
osm_log_level_t osm_get_log_per_module(IN osm_log_t * p_log,
|
|
Packit |
13e616 |
IN const int file_id);
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_log
|
|
Packit |
13e616 |
* [in] Pointer to a Log object to construct.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* file_id
|
|
Packit |
13e616 |
* [in] File ID for module
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUES
|
|
Packit |
13e616 |
* The log level from the per module logging structure for this file ID.
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Log/osm_set_log_per_module
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_set_log_per_module
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* This sets log level for the given file ID in the per module log table.
|
|
Packit |
13e616 |
* NOTE: this code is not thread safe. Need to grab the lock before
|
|
Packit |
13e616 |
* calling it.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
void osm_set_log_per_module(IN osm_log_t * p_log, IN const int file_id,
|
|
Packit |
13e616 |
IN osm_log_level_t level);
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_log
|
|
Packit |
13e616 |
* [in] Pointer to a Log object to construct.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* file_id
|
|
Packit |
13e616 |
* [in] File ID for module
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* level
|
|
Packit |
13e616 |
* [in] Log level of the module
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUES
|
|
Packit |
13e616 |
* This function does not return a value.
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Log/osm_reset_log_per_module
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_reset_log_per_module
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* This resets log level for the entire per module log table.
|
|
Packit |
13e616 |
* NOTE: this code is not thread safe. Need to grab the lock before
|
|
Packit |
13e616 |
* calling it.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
void osm_reset_log_per_module(IN osm_log_t * p_log);
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_log
|
|
Packit |
13e616 |
* [in] Pointer to a Log object to construct.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUES
|
|
Packit |
13e616 |
* This function does not return a value.
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Log/osm_log_construct
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_log_construct
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* This function constructs a Log object.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
static inline void osm_log_construct(IN osm_log_t * p_log)
|
|
Packit |
13e616 |
{
|
|
Packit |
13e616 |
cl_spinlock_construct(&p_log->lock);
|
|
Packit |
13e616 |
}
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_log
|
|
Packit |
13e616 |
* [in] Pointer to a Log object to construct.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUE
|
|
Packit |
13e616 |
* This function does not return a value.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* NOTES
|
|
Packit |
13e616 |
* Allows calling osm_log_init, osm_log_init_v2, osm_log_destroy
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* Calling osm_log_construct is a prerequisite to calling any other
|
|
Packit |
13e616 |
* method except osm_log_init or osm_log_init_v2.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SEE ALSO
|
|
Packit |
13e616 |
* Log object, osm_log_init, osm_log_init_v2,
|
|
Packit |
13e616 |
* osm_log_destroy
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Log/osm_log_destroy
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_log_destroy
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* The osm_log_destroy function destroys the object, releasing
|
|
Packit |
13e616 |
* all resources.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
static inline void osm_log_destroy(IN osm_log_t * p_log)
|
|
Packit |
13e616 |
{
|
|
Packit |
13e616 |
cl_spinlock_destroy(&p_log->lock);
|
|
Packit |
13e616 |
if (p_log->out_port != stdout) {
|
|
Packit |
13e616 |
fclose(p_log->out_port);
|
|
Packit |
13e616 |
p_log->out_port = stdout;
|
|
Packit |
13e616 |
}
|
|
Packit |
13e616 |
closelog();
|
|
Packit |
13e616 |
}
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_log
|
|
Packit |
13e616 |
* [in] Pointer to the object to destroy.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUE
|
|
Packit |
13e616 |
* This function does not return a value.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* NOTES
|
|
Packit |
13e616 |
* Performs any necessary cleanup of the specified
|
|
Packit |
13e616 |
* Log object.
|
|
Packit |
13e616 |
* Further operations should not be attempted on the destroyed object.
|
|
Packit |
13e616 |
* This function should only be called after a call to
|
|
Packit |
13e616 |
* osm_log_construct, osm_log_init, or osm_log_init_v2.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SEE ALSO
|
|
Packit |
13e616 |
* Log object, osm_log_construct,
|
|
Packit |
13e616 |
* osm_log_init, osm_log_init_v2
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Log/osm_log_init_v2
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_log_init_v2
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* The osm_log_init_v2 function initializes a
|
|
Packit |
13e616 |
* Log object for use.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
ib_api_status_t osm_log_init_v2(IN osm_log_t * p_log, IN boolean_t flush,
|
|
Packit |
13e616 |
IN uint8_t log_flags, IN const char *log_file,
|
|
Packit |
13e616 |
IN unsigned long max_size,
|
|
Packit |
13e616 |
IN boolean_t accum_log_file);
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_log
|
|
Packit |
13e616 |
* [in] Pointer to the log object.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* flush
|
|
Packit |
13e616 |
* [in] Set to TRUE directs the log to flush all log messages
|
|
Packit |
13e616 |
* immediately. This severely degrades log performance,
|
|
Packit |
13e616 |
* and is normally used for debugging only.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* log_flags
|
|
Packit |
13e616 |
* [in] The log verbosity level to be used.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* log_file
|
|
Packit |
13e616 |
* [in] if not NULL defines the name of the log file. Otherwise
|
|
Packit |
13e616 |
* it is stdout.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUES
|
|
Packit |
13e616 |
* CL_SUCCESS if the Log object was initialized
|
|
Packit |
13e616 |
* successfully.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* NOTES
|
|
Packit |
13e616 |
* Allows calling other Log methods.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SEE ALSO
|
|
Packit |
13e616 |
* Log object, osm_log_construct,
|
|
Packit |
13e616 |
* osm_log_destroy
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Log/osm_log_reopen_file
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_log_reopen_file
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* The osm_log_reopen_file function reopens the log file
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
int osm_log_reopen_file(osm_log_t * p_log);
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_log
|
|
Packit |
13e616 |
* [in] Pointer to the log object.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUES
|
|
Packit |
13e616 |
* 0 on success or nonzero value otherwise.
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Log/osm_log_init
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_log_init
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* The osm_log_init function initializes a
|
|
Packit |
13e616 |
* Log object for use. It is a wrapper for osm_log_init_v2().
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
ib_api_status_t osm_log_init(IN osm_log_t * p_log, IN boolean_t flush,
|
|
Packit |
13e616 |
IN uint8_t log_flags, IN const char *log_file,
|
|
Packit |
13e616 |
IN boolean_t accum_log_file);
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* Same as osm_log_init_v2() but without max_size parameter
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
void osm_log(IN osm_log_t * p_log, IN osm_log_level_t verbosity,
|
|
Packit |
13e616 |
IN const char *p_str, ...) STRICT_OSM_LOG_FORMAT;
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
void osm_log_v2(IN osm_log_t * p_log, IN osm_log_level_t verbosity,
|
|
Packit |
13e616 |
IN const int file_id, IN const char *p_str, ...) STRICT_OSM_LOG_V2_FORMAT;
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Log/osm_log_get_level
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_log_get_level
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* Returns the current log level.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
static inline osm_log_level_t osm_log_get_level(IN const osm_log_t * p_log)
|
|
Packit |
13e616 |
{
|
|
Packit |
13e616 |
return p_log->level;
|
|
Packit |
13e616 |
}
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_log
|
|
Packit |
13e616 |
* [in] Pointer to the log object.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUES
|
|
Packit |
13e616 |
* Returns the current log level.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* NOTES
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SEE ALSO
|
|
Packit |
13e616 |
* Log object, osm_log_construct,
|
|
Packit |
13e616 |
* osm_log_destroy
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Log/osm_log_set_level
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_log_set_level
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* Sets the current log level.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
static inline void osm_log_set_level(IN osm_log_t * p_log,
|
|
Packit |
13e616 |
IN osm_log_level_t level)
|
|
Packit |
13e616 |
{
|
|
Packit |
13e616 |
p_log->level = level;
|
|
Packit |
13e616 |
osm_log(p_log, OSM_LOG_ALL, "Setting log level to: 0x%02x\n", level);
|
|
Packit |
13e616 |
}
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_log
|
|
Packit |
13e616 |
* [in] Pointer to the log object.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* level
|
|
Packit |
13e616 |
* [in] New level to set.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUES
|
|
Packit |
13e616 |
* This function does not return a value.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* NOTES
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SEE ALSO
|
|
Packit |
13e616 |
* Log object, osm_log_construct,
|
|
Packit |
13e616 |
* osm_log_destroy
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Log/osm_log_is_active
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_log_is_active
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* Returns TRUE if the specified log level would be logged.
|
|
Packit |
13e616 |
* FALSE otherwise.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
static inline boolean_t osm_log_is_active(IN const osm_log_t * p_log,
|
|
Packit |
13e616 |
IN osm_log_level_t level)
|
|
Packit |
13e616 |
{
|
|
Packit |
13e616 |
return ((p_log->level & level) != 0);
|
|
Packit |
13e616 |
}
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_log
|
|
Packit |
13e616 |
* [in] Pointer to the log object.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* level
|
|
Packit |
13e616 |
* [in] Level to check.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUES
|
|
Packit |
13e616 |
* Returns TRUE if the specified log level would be logged.
|
|
Packit |
13e616 |
* FALSE otherwise.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* NOTES
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SEE ALSO
|
|
Packit |
13e616 |
* Log object, osm_log_construct,
|
|
Packit |
13e616 |
* osm_log_destroy
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
static inline boolean_t osm_log_is_active_v2(IN const osm_log_t * p_log,
|
|
Packit |
13e616 |
IN osm_log_level_t level,
|
|
Packit |
13e616 |
IN const int file_id)
|
|
Packit |
13e616 |
{
|
|
Packit |
13e616 |
if ((p_log->level & level) != 0)
|
|
Packit |
13e616 |
return 1;
|
|
Packit |
13e616 |
if ((level & p_log->per_mod_log_tbl[file_id]))
|
|
Packit |
13e616 |
return 1;
|
|
Packit |
13e616 |
return 0;
|
|
Packit |
13e616 |
}
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
extern void osm_log_msg_box(osm_log_t *log, osm_log_level_t level,
|
|
Packit |
13e616 |
const char *func_name, const char *msg);
|
|
Packit |
13e616 |
extern void osm_log_msg_box_v2(osm_log_t *log, osm_log_level_t level,
|
|
Packit |
13e616 |
const int file_id, const char *func_name,
|
|
Packit |
13e616 |
const char *msg);
|
|
Packit |
13e616 |
extern void osm_log_raw(IN osm_log_t * p_log, IN osm_log_level_t verbosity,
|
|
Packit |
13e616 |
IN const char *p_buf);
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#ifdef FILE_ID
|
|
Packit |
13e616 |
#define OSM_LOG(log, level, fmt, ...) do { \
|
|
Packit |
13e616 |
if (osm_log_is_active_v2(log, (level), FILE_ID)) \
|
|
Packit |
13e616 |
osm_log_v2(log, level, FILE_ID, "%s: " fmt, __func__, ## __VA_ARGS__); \
|
|
Packit |
13e616 |
} while (0)
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#define OSM_LOG_MSG_BOX(log, level, msg) \
|
|
Packit |
13e616 |
osm_log_msg_box_v2(log, level, FILE_ID, __func__, msg)
|
|
Packit |
13e616 |
#else
|
|
Packit |
13e616 |
#define OSM_LOG(log, level, fmt, ...) do { \
|
|
Packit |
13e616 |
if (osm_log_is_active(log, (level))) \
|
|
Packit |
13e616 |
osm_log(log, level, "%s: " fmt, __func__, ## __VA_ARGS__); \
|
|
Packit |
13e616 |
} while (0)
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#define OSM_LOG_MSG_BOX(log, level, msg) \
|
|
Packit |
13e616 |
osm_log_msg_box(log, level, __func__, msg)
|
|
Packit |
13e616 |
#endif
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#define DBG_CL_LOCK 0
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#define CL_PLOCK_EXCL_ACQUIRE( __exp__ ) \
|
|
Packit |
13e616 |
{ \
|
|
Packit |
13e616 |
if (DBG_CL_LOCK) \
|
|
Packit |
13e616 |
printf("cl_plock_excl_acquire: Acquiring %p file %s, line %d\n", \
|
|
Packit |
13e616 |
__exp__,__FILE__, __LINE__); \
|
|
Packit |
13e616 |
cl_plock_excl_acquire( __exp__ ); \
|
|
Packit |
13e616 |
if (DBG_CL_LOCK) \
|
|
Packit |
13e616 |
printf("cl_plock_excl_acquire: Acquired %p file %s, line %d\n", \
|
|
Packit |
13e616 |
__exp__,__FILE__, __LINE__); \
|
|
Packit |
13e616 |
}
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#define CL_PLOCK_ACQUIRE( __exp__ ) \
|
|
Packit |
13e616 |
{ \
|
|
Packit |
13e616 |
if (DBG_CL_LOCK) \
|
|
Packit |
13e616 |
printf("cl_plock_acquire: Acquiring %p file %s, line %d\n", \
|
|
Packit |
13e616 |
__exp__,__FILE__, __LINE__); \
|
|
Packit |
13e616 |
cl_plock_acquire( __exp__ ); \
|
|
Packit |
13e616 |
if (DBG_CL_LOCK) \
|
|
Packit |
13e616 |
printf("cl_plock_acquire: Acquired %p file %s, line %d\n", \
|
|
Packit |
13e616 |
__exp__,__FILE__, __LINE__); \
|
|
Packit |
13e616 |
}
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#define CL_PLOCK_RELEASE( __exp__ ) \
|
|
Packit |
13e616 |
{ \
|
|
Packit |
13e616 |
if (DBG_CL_LOCK) \
|
|
Packit |
13e616 |
printf("cl_plock_release: Releasing %p file %s, line %d\n", \
|
|
Packit |
13e616 |
__exp__,__FILE__, __LINE__); \
|
|
Packit |
13e616 |
cl_plock_release( __exp__ ); \
|
|
Packit |
13e616 |
if (DBG_CL_LOCK) \
|
|
Packit |
13e616 |
printf("cl_plock_release: Released %p file %s, line %d\n", \
|
|
Packit |
13e616 |
__exp__,__FILE__, __LINE__); \
|
|
Packit |
13e616 |
}
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#define DBG_CL_SPINLOCK 0
|
|
Packit |
13e616 |
#define CL_SPINLOCK_RELEASE( __exp__ ) \
|
|
Packit |
13e616 |
{ \
|
|
Packit |
13e616 |
if (DBG_CL_SPINLOCK) \
|
|
Packit |
13e616 |
printf("cl_spinlock_release: Releasing %p file %s, line %d\n", \
|
|
Packit |
13e616 |
__exp__,__FILE__, __LINE__); \
|
|
Packit |
13e616 |
cl_spinlock_release( __exp__ ); \
|
|
Packit |
13e616 |
if (DBG_CL_SPINLOCK) \
|
|
Packit |
13e616 |
printf("cl_spinlock_release: Released %p file %s, line %d\n", \
|
|
Packit |
13e616 |
__exp__,__FILE__, __LINE__); \
|
|
Packit |
13e616 |
}
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#define CL_SPINLOCK_ACQUIRE( __exp__ ) \
|
|
Packit |
13e616 |
{ \
|
|
Packit |
13e616 |
if (DBG_CL_SPINLOCK) \
|
|
Packit |
13e616 |
printf("cl_spinlock_acquire: Acquiring %p file %s, line %d\n", \
|
|
Packit |
13e616 |
__exp__,__FILE__, __LINE__); \
|
|
Packit |
13e616 |
cl_spinlock_acquire( __exp__ ); \
|
|
Packit |
13e616 |
if (DBG_CL_SPINLOCK) \
|
|
Packit |
13e616 |
printf("cl_spinlock_acquire: Acquired %p file %s, line %d\n", \
|
|
Packit |
13e616 |
__exp__,__FILE__, __LINE__); \
|
|
Packit |
13e616 |
}
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Helper/osm_is_debug
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_is_debug
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* The osm_is_debug function returns TRUE if the opensm was compiled
|
|
Packit |
13e616 |
* in debug mode, and FALSE otherwise.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
boolean_t osm_is_debug(void);
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* None
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUE
|
|
Packit |
13e616 |
* TRUE if compiled in debug version. FALSE otherwise.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* NOTES
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
END_C_DECLS
|
|
Packit |
13e616 |
#endif /* _OSM_LOG_H_ */
|