Commit d27b24c9 authored by Daniel Verkamp's avatar Daniel Verkamp
Browse files

log: split internal TRACELOG macro into new header 



The SPDK_TRACELOG macro depends on a CONFIG setting (DEBUG), so it
should not be part of the public API.

Create a new include/spdk_internal directory for headers that should
only be used within SPDK, not exported for public use.

Change-Id: I39b90ce57da3270e735ba32210c4b3a3468c460b
Signed-off-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
parent ac99f2fb

include/spdk/log.h

+0 −31
Original line number Diff line number Diff line
@@ -57,37 +57,6 @@ extern unsigned int spdk_g_notice_stderr_flag; 
#define SPDK_ERRLOG(...) \

	spdk_errlog(__FILE__, __LINE__, __func__, __VA_ARGS__)





#ifdef DEBUG

#define SPDK_LOG_REGISTER_TRACE_FLAG(str, flag) \

bool flag = false; \

__attribute__((constructor)) static void register_trace_flag_##flag(void) \

{ \

	spdk_log_register_trace_flag(str, &flag); \

}



#define SPDK_TRACELOG(FLAG, ...)							\

	do {										\

		extern bool FLAG;							\

		if (FLAG) {								\

			spdk_tracelog(__FILE__, __LINE__, __func__, __VA_ARGS__);	\

		}									\

	} while (0)



#define SPDK_TRACEDUMP(FLAG, LABEL, BUF, LEN)						\

	do {										\

		extern bool FLAG;							\

		if ((FLAG) && (LEN)) {								\

			spdk_trace_dump((LABEL), (BUF), (LEN));				\

		}									\

	} while (0)



#else

#define SPDK_LOG_REGISTER_TRACE_FLAG(str, flag)

#define SPDK_TRACELOG(...) do { } while (0)

#define SPDK_TRACEDUMP(...) do { } while (0)

#endif



int spdk_set_log_facility(const char *facility);

int spdk_set_log_priority(const char *priority);

void spdk_noticelog(const char *file, const int line, const char *func,

include/spdk_internal/log.h

0 → 100644
+74 −0
Original line number Diff line number Diff line 
/*-

 *   BSD LICENSE

 *

 *   Copyright (c) Intel Corporation.

 *   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 Intel Corporation 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.

 */



/**

 * \file

 * Logging interfaces

 */



#ifndef SPDK_INTERNAL_LOG_H

#define SPDK_INTERNAL_LOG_H



#include "spdk/log.h"



#ifdef DEBUG

#define SPDK_LOG_REGISTER_TRACE_FLAG(str, flag) \

bool flag = false; \

__attribute__((constructor)) static void register_trace_flag_##flag(void) \

{ \

	spdk_log_register_trace_flag(str, &flag); \

}



#define SPDK_TRACELOG(FLAG, ...)							\

	do {										\

		extern bool FLAG;							\

		if (FLAG) {								\

			spdk_tracelog(__FILE__, __LINE__, __func__, __VA_ARGS__);	\

		}									\

	} while (0)



#define SPDK_TRACEDUMP(FLAG, LABEL, BUF, LEN)						\

	do {										\

		extern bool FLAG;							\

		if ((FLAG) && (LEN)) {							\

			spdk_trace_dump((LABEL), (BUF), (LEN));				\

		}									\

	} while (0)



#else

#define SPDK_LOG_REGISTER_TRACE_FLAG(str, flag)

#define SPDK_TRACELOG(...) do { } while (0)

#define SPDK_TRACEDUMP(...) do { } while (0)

#endif



#endif /* SPDK_INTERNAL_LOG_H */

lib/bdev/aio/blockdev_aio.c

+2 −1
Original line number Diff line number Diff line
@@ -44,9 +44,10 @@ 
#include "spdk/bdev.h"

#include "spdk/conf.h"

#include "spdk/fd.h"

#include "spdk/log.h"

#include "spdk/io_channel.h"



#include "spdk_internal/log.h"



static int g_blockdev_count = 0;



static int blockdev_aio_initialize(void);

lib/bdev/aio/blockdev_aio_rpc.c

+2 −1
Original line number Diff line number Diff line
@@ -32,9 +32,10 @@ 
 */



#include "blockdev_aio.h"

#include "spdk/log.h"

#include "spdk/rpc.h"



#include "spdk_internal/log.h"



struct rpc_construct_aio {

	char *fname;

};

lib/bdev/bdev.c

+2 −1
Original line number Diff line number Diff line
@@ -44,9 +44,10 @@ 
#include <rte_version.h>



#include "spdk/event.h"

#include "spdk/log.h"

#include "spdk/queue.h"



#include "spdk_internal/log.h"



#include "bdev_module.h"



#define SPDK_BDEV_IO_POOL_SIZE	(64 * 1024)