From de467ec91d39d768301dfa150328e86663957101 Mon Sep 17 00:00:00 2001 From: Seth Howell Date: Tue, 10 Dec 2019 16:29:37 -0700 Subject: [PATCH] env_dpdk/rpc: add rpc to get memory stats. This will enable us to create a helper applciation to print memory statistics for a given SPDK application. Change-Id: I0ad5a8163166a5d67d9a5533303ec0858297ba6b Signed-off-by: Seth Howell Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/477511 Reviewed-by: Jim Harris Reviewed-by: Shuhei Matsumoto Community-CI: Broadcom SPDK FC-NVMe CI Community-CI: SPDK CI Jenkins Tested-by: SPDK CI Jenkins --- app/iscsi_tgt/Makefile | 5 +++ app/nvmf_tgt/Makefile | 4 ++ app/spdk_tgt/Makefile | 4 ++ app/vhost/Makefile | 4 ++ mk/spdk.lib_deps.mk | 3 ++ module/Makefile | 4 ++ module/env_dpdk/Makefile | 40 ++++++++++++++++++++ module/env_dpdk/env_dpdk_rpc.c | 68 ++++++++++++++++++++++++++++++++++ scripts/rpc.py | 7 ++++ scripts/rpc/__init__.py | 1 + scripts/rpc/env_dpdk.py | 8 ++++ 11 files changed, 148 insertions(+) create mode 100644 module/env_dpdk/Makefile create mode 100644 module/env_dpdk/env_dpdk_rpc.c create mode 100644 scripts/rpc/env_dpdk.py diff --git a/app/iscsi_tgt/Makefile b/app/iscsi_tgt/Makefile index 3fc675160..bf3ea738c 100644 --- a/app/iscsi_tgt/Makefile +++ b/app/iscsi_tgt/Makefile @@ -48,6 +48,11 @@ SPDK_LIB_LIST += event_bdev event_copy event_iscsi event_net event_scsi event_vm SPDK_LIB_LIST += jsonrpc json rpc bdev_rpc bdev iscsi scsi copy trace conf SPDK_LIB_LIST += thread util log log_rpc app_rpc net sock notify +ifeq ($(SPDK_ROOT_DIR)/lib/env_dpdk,$(CONFIG_ENV)) +SPDK_LIB_LIST += env_dpdk_rpc +endif + + ifeq ($(OS),Linux) SPDK_LIB_LIST += event_nbd nbd endif diff --git a/app/nvmf_tgt/Makefile b/app/nvmf_tgt/Makefile index 76f2874db..3334b765b 100644 --- a/app/nvmf_tgt/Makefile +++ b/app/nvmf_tgt/Makefile @@ -44,6 +44,10 @@ SPDK_LIB_LIST += event_bdev event_copy event_nvmf event_net event_vmd SPDK_LIB_LIST += nvmf event log trace conf thread util bdev copy rpc jsonrpc json net sock SPDK_LIB_LIST += app_rpc log_rpc bdev_rpc notify +ifeq ($(SPDK_ROOT_DIR)/lib/env_dpdk,$(CONFIG_ENV)) +SPDK_LIB_LIST += env_dpdk_rpc +endif + ifeq ($(OS),Linux) SPDK_LIB_LIST += event_nbd nbd endif diff --git a/app/spdk_tgt/Makefile b/app/spdk_tgt/Makefile index 6e0766aa5..eb9dd2e67 100644 --- a/app/spdk_tgt/Makefile +++ b/app/spdk_tgt/Makefile @@ -54,6 +54,10 @@ SPDK_LIB_LIST += event_bdev event_copy event_iscsi event_net event_scsi event_nv SPDK_LIB_LIST += nvmf trace log conf thread util bdev iscsi scsi copy rpc jsonrpc json SPDK_LIB_LIST += app_rpc log_rpc bdev_rpc net sock notify +ifeq ($(SPDK_ROOT_DIR)/lib/env_dpdk,$(CONFIG_ENV)) +SPDK_LIB_LIST += env_dpdk_rpc +endif + ifeq ($(OS),Linux) SPDK_LIB_LIST += event_nbd nbd endif diff --git a/app/vhost/Makefile b/app/vhost/Makefile index 0e15723c4..f4b6275cf 100644 --- a/app/vhost/Makefile +++ b/app/vhost/Makefile @@ -51,4 +51,8 @@ SPDK_LIB_LIST += jsonrpc json rpc bdev_rpc bdev scsi copy trace conf SPDK_LIB_LIST += thread util log log_rpc app_rpc SPDK_LIB_LIST += event_nbd nbd net sock notify +ifeq ($(SPDK_ROOT_DIR)/lib/env_dpdk,$(CONFIG_ENV)) +SPDK_LIB_LIST += env_dpdk_rpc +endif + include $(SPDK_ROOT_DIR)/mk/spdk.app.mk diff --git a/mk/spdk.lib_deps.mk b/mk/spdk.lib_deps.mk index 1741f94e9..34e694d1a 100644 --- a/mk/spdk.lib_deps.mk +++ b/mk/spdk.lib_deps.mk @@ -103,6 +103,9 @@ DEPDIRS-blobfs_bdev := $(BDEV_DEPS_THREAD) blob_bdev blobfs # module/copy DEPDIRS-copy_ioat := log ioat conf thread $(JSON_LIBS) copy +# module/env_dpdk +DEPDIRS-env_dpdk_rpc := log $(JSON_LIBS) + # module/sock DEPDIRS-sock_posix := log sock DEPDIRS-sock_vpp := log sock util thread diff --git a/module/Makefile b/module/Makefile index f8aff0c44..f94232c4f 100644 --- a/module/Makefile +++ b/module/Makefile @@ -35,9 +35,13 @@ SPDK_ROOT_DIR := $(abspath $(CURDIR)/..) include $(SPDK_ROOT_DIR)/mk/spdk.common.mk DIRS-y = bdev blob blobfs copy event sock +ifeq ($(SPDK_ROOT_DIR)/lib/env_dpdk,$(CONFIG_ENV)) +DIRS-y += env_dpdk +endif DEPDIRS-blob := DEPDIRS-copy := +DEPDIRS-env_dpdk := DEPDIRS-sock := DEPDIRS-bdev := blob DEPDIRS-blobfs := blob diff --git a/module/env_dpdk/Makefile b/module/env_dpdk/Makefile new file mode 100644 index 000000000..1b38df597 --- /dev/null +++ b/module/env_dpdk/Makefile @@ -0,0 +1,40 @@ +# +# 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)/../..) +include $(SPDK_ROOT_DIR)/mk/spdk.common.mk + +C_SRCS = env_dpdk_rpc.c +LIBNAME = env_dpdk_rpc + +include $(SPDK_ROOT_DIR)/mk/spdk.lib.mk diff --git a/module/env_dpdk/env_dpdk_rpc.c b/module/env_dpdk/env_dpdk_rpc.c new file mode 100644 index 000000000..16ae050a9 --- /dev/null +++ b/module/env_dpdk/env_dpdk_rpc.c @@ -0,0 +1,68 @@ +/*- + * BSD LICENSE + * + * Copyright (c) Intel Corporation. All rights reserved. + * Copyright (c) 2019 Mellanox Technologies LTD. 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/stdinc.h" +#include "spdk/rpc.h" +#include "spdk/env_dpdk.h" +#include "spdk_internal/log.h" + +static void +spdk_rpc_env_dpdk_get_mem_stats(struct spdk_jsonrpc_request *request, + const struct spdk_json_val *params) +{ + FILE *file = NULL; + struct spdk_json_write_ctx *w; + char default_filename[] = "/tmp/spdk_mem_dump.txt"; + + if (params != NULL) { + SPDK_ERRLOG("spdk_json_decode_object failed\n"); + spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, + "env_dpdk_get_mem_stats doesn't accept any parameters.\n"); + } + + file = fopen(default_filename, "w"); + if (!file) { + spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, + "Unable to open file for writing.\n"); + return; + } + + spdk_env_dpdk_dump_mem_stats(file); + fclose(file); + w = spdk_jsonrpc_begin_result(request); + spdk_json_write_object_begin(w); + spdk_json_write_named_string(w, "filename", default_filename); + spdk_json_write_object_end(w); + spdk_jsonrpc_end_result(request, w); +} +SPDK_RPC_REGISTER("env_dpdk_get_mem_stats", spdk_rpc_env_dpdk_get_mem_stats, SPDK_RPC_RUNTIME) diff --git a/scripts/rpc.py b/scripts/rpc.py index 13157d850..9692a915d 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -2245,6 +2245,13 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse 'thread_get_stats', help='Display current statistics of all the threads') p.set_defaults(func=thread_get_stats) + def env_dpdk_get_mem_stats(args): + print_dict(rpc.env_dpdk.env_dpdk_get_mem_stats(args.client)) + + p = subparsers.add_parser( + 'env_dpdk_get_mem_stats', help='write the dpdk memory stats to a file.') + p.set_defaults(func=env_dpdk_get_mem_stats) + # blobfs def blobfs_detect(args): print(rpc.blobfs.blobfs_detect(args.client, diff --git a/scripts/rpc/__init__.py b/scripts/rpc/__init__.py index 0a43bb9bf..403e2ec2e 100644 --- a/scripts/rpc/__init__.py +++ b/scripts/rpc/__init__.py @@ -4,6 +4,7 @@ import sys from . import app from . import bdev from . import blobfs +from . import env_dpdk from . import ioat from . import iscsi from . import log diff --git a/scripts/rpc/env_dpdk.py b/scripts/rpc/env_dpdk.py new file mode 100644 index 000000000..f2c098e52 --- /dev/null +++ b/scripts/rpc/env_dpdk.py @@ -0,0 +1,8 @@ +def env_dpdk_get_mem_stats(client): + """Dump the applications memory stats to a file. + + Returns: + The path to the file where the stats are written. + """ + + return client.call('env_dpdk_get_mem_stats')