Commit 44d13110 authored by Ben Walker's avatar Ben Walker Committed by Daniel Verkamp
Browse files

log: Add a lib for integrating the log lib with event framework. 



Linking this library into an application makes the log
configurable via RPC. This only works if the rpc subsystem
is also loaded.

Change-Id: If1340cf2a845ef159290232c26f341150c98fb9a
Signed-off-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 548ab005

lib/log/Makefile

+2 −0
Original line number Diff line number Diff line
@@ -36,4 +36,6 @@ SPDK_ROOT_DIR := $(abspath $(CURDIR)/../..) 
C_SRCS = log.c

LIBNAME = log



DIRS-y = rpc



include $(SPDK_ROOT_DIR)/mk/spdk.lib.mk

lib/log/rpc/Makefile

0 → 100644
+39 −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.

#



SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../..)



C_SRCS = log_rpc.c

LIBNAME = log_rpc



include $(SPDK_ROOT_DIR)/mk/spdk.lib.mk

lib/log/rpc/log_rpc.c

0 → 100644
+156 −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.

 */



#include "spdk/log.h"



#include "spdk/rpc.h"



struct rpc_trace_flag {

	char *flag;

};



static void

free_rpc_trace_flag(struct rpc_trace_flag *p)

{

	free(p->flag);

}



static const struct spdk_json_object_decoder rpc_trace_flag_decoders[] = {

	{"flag", offsetof(struct rpc_trace_flag, flag), spdk_json_decode_string},

};



static void

spdk_rpc_set_trace_flag(struct spdk_jsonrpc_server_conn *conn,

			const struct spdk_json_val *params,

			const struct spdk_json_val *id)

{

	struct rpc_trace_flag req = {};

	struct spdk_json_write_ctx *w;



	if (spdk_json_decode_object(params, rpc_trace_flag_decoders,

				    sizeof(rpc_trace_flag_decoders) / sizeof(*rpc_trace_flag_decoders), &req)) {

		SPDK_TRACELOG(SPDK_TRACE_DEBUG, "spdk_json_decode_object failed\n");

		goto invalid;

	}



	if (req.flag == 0) {

		SPDK_TRACELOG(SPDK_TRACE_DEBUG, "flag was 0\n");

		goto invalid;

	}



	spdk_log_set_trace_flag(req.flag);

	free_rpc_trace_flag(&req);



	if (id == NULL) {

		return;

	}



	w = spdk_jsonrpc_begin_result(conn, id);

	spdk_json_write_bool(w, true);

	spdk_jsonrpc_end_result(conn, w);

	return;



invalid:

	spdk_jsonrpc_send_error_response(conn, id, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");

	free_rpc_trace_flag(&req);

}

SPDK_RPC_REGISTER("set_trace_flag", spdk_rpc_set_trace_flag)



static void

spdk_rpc_clear_trace_flag(struct spdk_jsonrpc_server_conn *conn,

			  const struct spdk_json_val *params,

			  const struct spdk_json_val *id)

{

	struct rpc_trace_flag req = {};

	struct spdk_json_write_ctx *w;



	if (spdk_json_decode_object(params, rpc_trace_flag_decoders,

				    sizeof(rpc_trace_flag_decoders) / sizeof(*rpc_trace_flag_decoders), &req)) {

		SPDK_TRACELOG(SPDK_TRACE_DEBUG, "spdk_json_decode_object failed\n");

		goto invalid;

	}



	if (req.flag == 0) {

		SPDK_TRACELOG(SPDK_TRACE_DEBUG, "flag was 0\n");

		goto invalid;

	}



	spdk_log_clear_trace_flag(req.flag);

	free_rpc_trace_flag(&req);



	if (id == NULL) {

		return;

	}



	w = spdk_jsonrpc_begin_result(conn, id);

	spdk_json_write_bool(w, true);

	spdk_jsonrpc_end_result(conn, w);

	return;



invalid:

	spdk_jsonrpc_send_error_response(conn, id, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");

	free_rpc_trace_flag(&req);

}

SPDK_RPC_REGISTER("clear_trace_flag", spdk_rpc_clear_trace_flag)



static void

spdk_rpc_get_trace_flags(struct spdk_jsonrpc_server_conn *conn,

			 const struct spdk_json_val *params,

			 const struct spdk_json_val *id)

{

	struct spdk_json_write_ctx *w;

	size_t i, count;



	if (params != NULL) {

		spdk_jsonrpc_send_error_response(conn, id, SPDK_JSONRPC_ERROR_INVALID_PARAMS,

						 "get_trace_flags requires no parameters");

		return;

	}



	if (id == NULL) {

		return;

	}



	count = spdk_log_get_num_trace_flags();

	w = spdk_jsonrpc_begin_result(conn, id);

	spdk_json_write_object_begin(w);

	for (i = 0; i < count; i++) {

		const char *name = spdk_log_get_trace_flag_name(i);



		spdk_json_write_name(w, name);

		spdk_json_write_bool(w, spdk_log_get_trace_flag(name));

	}

	spdk_json_write_object_end(w);

	spdk_jsonrpc_end_result(conn, w);

}

SPDK_RPC_REGISTER("get_trace_flags", spdk_rpc_get_trace_flags)

mk/spdk.lib.mk

+6 −2
Original line number Diff line number Diff line
@@ -35,12 +35,16 @@ include $(SPDK_ROOT_DIR)/mk/spdk.common.mk 


LIB := libspdk_$(LIBNAME).a



all: $(LIB)

.PHONY: all clean $(DIRS-y)



clean:

all: $(LIB) $(DIRS-y)



clean: $(DIRS-y)

	$(CLEAN_C)



$(LIB): $(OBJS)

	$(LIB_C)



include $(SPDK_ROOT_DIR)/mk/spdk.deps.mk



include $(SPDK_ROOT_DIR)/mk/spdk.subdirs.mk