xref: /spdk/lib/init/subsystem_rpc.c (revision 895300d84030b370decaeaac0b3d6b7798227fe9)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #include "spdk/rpc.h"
35 #include "spdk/string.h"
36 #include "spdk/util.h"
37 #include "spdk/env.h"
38 #include "spdk/log.h"
39 
40 #include "spdk_internal/init.h"
41 
42 #include "subsystem.h"
43 
44 static void
45 rpc_framework_get_subsystems(struct spdk_jsonrpc_request *request,
46 			     const struct spdk_json_val *params)
47 {
48 	struct spdk_json_write_ctx *w;
49 	struct spdk_subsystem *subsystem;
50 	struct spdk_subsystem_depend *deps;
51 
52 	if (params) {
53 		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
54 						 "'framework_get_subsystems' requires no arguments");
55 		return;
56 	}
57 
58 	w = spdk_jsonrpc_begin_result(request);
59 	spdk_json_write_array_begin(w);
60 	subsystem = subsystem_get_first();
61 	while (subsystem != NULL) {
62 		spdk_json_write_object_begin(w);
63 
64 		spdk_json_write_named_string(w, "subsystem", subsystem->name);
65 		spdk_json_write_named_array_begin(w, "depends_on");
66 		deps = subsystem_get_first_depend();
67 		while (deps != NULL) {
68 			if (strcmp(subsystem->name, deps->name) == 0) {
69 				spdk_json_write_string(w, deps->depends_on);
70 			}
71 			deps = subsystem_get_next_depend(deps);
72 		}
73 		spdk_json_write_array_end(w);
74 		spdk_json_write_object_end(w);
75 		subsystem = subsystem_get_next(subsystem);
76 	}
77 	spdk_json_write_array_end(w);
78 	spdk_jsonrpc_end_result(request, w);
79 }
80 
81 SPDK_RPC_REGISTER("framework_get_subsystems", rpc_framework_get_subsystems, SPDK_RPC_RUNTIME)
82 
83 struct rpc_framework_get_config_ctx {
84 	char *name;
85 };
86 
87 static const struct spdk_json_object_decoder rpc_framework_get_config_ctx[] = {
88 	{"name", offsetof(struct rpc_framework_get_config_ctx, name), spdk_json_decode_string},
89 };
90 
91 static void
92 rpc_framework_get_config(struct spdk_jsonrpc_request *request,
93 			 const struct spdk_json_val *params)
94 {
95 	struct rpc_framework_get_config_ctx req = {};
96 	struct spdk_json_write_ctx *w;
97 	struct spdk_subsystem *subsystem;
98 
99 	if (spdk_json_decode_object(params, rpc_framework_get_config_ctx,
100 				    SPDK_COUNTOF(rpc_framework_get_config_ctx), &req)) {
101 		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid arguments");
102 		return;
103 	}
104 
105 	subsystem = subsystem_find(req.name);
106 	if (!subsystem) {
107 		spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
108 						     "Subsystem '%s' not found", req.name);
109 		free(req.name);
110 		return;
111 	}
112 
113 	free(req.name);
114 
115 	w = spdk_jsonrpc_begin_result(request);
116 	subsystem_config_json(w, subsystem);
117 	spdk_jsonrpc_end_result(request, w);
118 }
119 
120 SPDK_RPC_REGISTER("framework_get_config", rpc_framework_get_config, SPDK_RPC_RUNTIME)
121 
122 static void
123 dump_pci_device(void *ctx, struct spdk_pci_device *dev)
124 {
125 	struct spdk_json_write_ctx *w = ctx;
126 	struct spdk_pci_addr addr;
127 	char config[4096], bdf[14];
128 	int rc;
129 
130 	addr = spdk_pci_device_get_addr(dev);
131 	spdk_pci_addr_fmt(bdf, sizeof(bdf), &addr);
132 
133 	rc = spdk_pci_device_cfg_read(dev, config, sizeof(config), 0);
134 	if (rc != 0) {
135 		SPDK_ERRLOG("Failed to read config space of device: %s\n", bdf);
136 		return;
137 	}
138 
139 	spdk_json_write_object_begin(w);
140 	spdk_json_write_named_string(w, "address", bdf);
141 
142 	/* Don't write the extended config space if it's all zeroes */
143 	if (spdk_mem_all_zero(&config[256], sizeof(config) - 256)) {
144 		spdk_json_write_named_bytearray(w, "config_space", config, 256);
145 	} else {
146 		spdk_json_write_named_bytearray(w, "config_space", config, sizeof(config));
147 	}
148 
149 	spdk_json_write_object_end(w);
150 }
151 
152 static void
153 rpc_framework_get_pci_devices(struct spdk_jsonrpc_request *request,
154 			      const struct spdk_json_val *params)
155 {
156 	struct spdk_json_write_ctx *w;
157 
158 	if (params != NULL) {
159 		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
160 						 "framework_get_pci_devices doesn't accept any parameters.\n");
161 		return;
162 	}
163 
164 	w = spdk_jsonrpc_begin_result(request);
165 
166 	spdk_json_write_array_begin(w);
167 	spdk_pci_for_each_device(w, dump_pci_device);
168 	spdk_json_write_array_end(w);
169 
170 	spdk_jsonrpc_end_result(request, w);
171 }
172 SPDK_RPC_REGISTER("framework_get_pci_devices", rpc_framework_get_pci_devices, SPDK_RPC_RUNTIME)
173