2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
25 #include "command-line.h"
29 #include "poll-loop.h"
30 #include "stream-ssl.h"
36 OVS_NO_RETURN static void usage(void);
37 static void parse_options(int argc, char *argv[]);
38 static struct command *get_all_commands(void);
41 test_jsonrpc_main(int argc, char *argv[])
43 proctitle_init(argc, argv);
44 set_program_name(argv[0]);
45 service_start(&argc, &argv);
46 parse_options(argc, argv);
47 run_command(argc - optind, argv + optind, get_all_commands());
51 parse_options(int argc, char *argv[])
54 OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1,
57 static const struct option long_options[] = {
58 {"verbose", optional_argument, NULL, 'v'},
59 {"help", no_argument, NULL, 'h'},
61 {"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT},
62 STREAM_SSL_LONG_OPTIONS,
65 char *short_options = long_options_to_short_options(long_options);
68 int c = getopt_long(argc, argv, short_options, long_options, NULL);
78 vlog_set_verbosity(optarg);
81 DAEMON_OPTION_HANDLERS
83 STREAM_SSL_OPTION_HANDLERS
85 case OPT_BOOTSTRAP_CA_CERT:
86 stream_ssl_set_ca_cert_file(optarg, true);
102 printf("%s: JSON-RPC test utility\n"
103 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
104 " listen LOCAL listen for connections on LOCAL\n"
105 " request REMOTE METHOD PARAMS send request, print reply\n"
106 " notify REMOTE METHOD PARAMS send notification and exit\n",
107 program_name, program_name);
108 stream_usage("JSON-RPC", true, true, true);
111 printf("\nOther options:\n"
112 " -h, --help display this help message\n");
116 /* Command helper functions. */
119 parse_json(const char *s)
121 struct json *json = json_from_string(s);
122 if (json->type == JSON_STRING) {
123 ovs_fatal(0, "\"%s\": %s", s, json->u.string);
129 print_and_free_json(struct json *json)
131 char *string = json_to_string(json, JSSF_SORT);
137 /* Command implementations. */
140 handle_rpc(struct jsonrpc *rpc, struct jsonrpc_msg *msg, bool *done)
142 if (msg->type == JSONRPC_REQUEST) {
143 struct jsonrpc_msg *reply = NULL;
144 if (!strcmp(msg->method, "echo")) {
145 reply = jsonrpc_create_reply(json_clone(msg->params), msg->id);
147 struct json *error = json_object_create();
148 json_object_put_string(error, "error", "unknown method");
149 reply = jsonrpc_create_error(error, msg->id);
150 ovs_error(0, "unknown request %s", msg->method);
152 jsonrpc_send(rpc, reply);
154 } else if (msg->type == JSONRPC_NOTIFY) {
155 if (!strcmp(msg->method, "shutdown")) {
159 ovs_error(0, "unknown notification %s", msg->method);
163 ovs_error(0, "unsolicited JSON-RPC reply or error");
169 do_listen(int argc OVS_UNUSED, char *argv[])
171 struct pstream *pstream;
172 struct jsonrpc **rpcs;
173 size_t n_rpcs, allocated_rpcs;
177 error = jsonrpc_pstream_open(argv[1], &pstream, DSCP_DEFAULT);
179 ovs_fatal(error, "could not listen on \"%s\"", argv[1]);
185 n_rpcs = allocated_rpcs = 0;
188 struct stream *stream;
191 /* Accept new connections. */
192 error = pstream_accept(pstream, &stream);
194 if (n_rpcs >= allocated_rpcs) {
195 rpcs = x2nrealloc(rpcs, &allocated_rpcs, sizeof *rpcs);
197 rpcs[n_rpcs++] = jsonrpc_open(stream);
198 } else if (error != EAGAIN) {
199 ovs_fatal(error, "pstream_accept failed");
202 /* Service existing connections. */
203 for (i = 0; i < n_rpcs; ) {
204 struct jsonrpc *rpc = rpcs[i];
205 struct jsonrpc_msg *msg;
208 if (!jsonrpc_get_backlog(rpc)) {
209 error = jsonrpc_recv(rpc, &msg);
211 error = handle_rpc(rpc, msg, &done);
212 jsonrpc_msg_destroy(msg);
213 } else if (error == EAGAIN) {
219 error = jsonrpc_get_status(rpc);
223 ovs_error(error, "connection closed");
224 memmove(&rpcs[i], &rpcs[i + 1],
225 (n_rpcs - i - 1) * sizeof *rpcs);
232 /* Wait for something to do. */
233 if (done && !n_rpcs) {
236 pstream_wait(pstream);
237 for (i = 0; i < n_rpcs; i++) {
238 struct jsonrpc *rpc = rpcs[i];
241 if (!jsonrpc_get_backlog(rpc)) {
242 jsonrpc_recv_wait(rpc);
248 pstream_close(pstream);
252 do_request(int argc OVS_UNUSED, char *argv[])
254 struct jsonrpc_msg *msg;
257 struct stream *stream;
263 params = parse_json(argv[3]);
264 msg = jsonrpc_create_request(method, params, NULL);
265 string = jsonrpc_msg_is_valid(msg);
267 ovs_fatal(0, "not a valid JSON-RPC request: %s", string);
270 error = stream_open_block(jsonrpc_stream_open(argv[1], &stream,
271 DSCP_DEFAULT), &stream);
273 ovs_fatal(error, "could not open \"%s\"", argv[1]);
275 rpc = jsonrpc_open(stream);
277 error = jsonrpc_send(rpc, msg);
279 ovs_fatal(error, "could not send request");
282 error = jsonrpc_recv_block(rpc, &msg);
284 ovs_fatal(error, "error waiting for reply");
286 print_and_free_json(jsonrpc_msg_to_json(msg));
292 do_notify(int argc OVS_UNUSED, char *argv[])
294 struct jsonrpc_msg *msg;
297 struct stream *stream;
303 params = parse_json(argv[3]);
304 msg = jsonrpc_create_notify(method, params);
305 string = jsonrpc_msg_is_valid(msg);
307 ovs_fatal(0, "not a JSON RPC-valid notification: %s", string);
310 error = stream_open_block(jsonrpc_stream_open(argv[1], &stream,
311 DSCP_DEFAULT), &stream);
313 ovs_fatal(error, "could not open \"%s\"", argv[1]);
315 rpc = jsonrpc_open(stream);
317 error = jsonrpc_send_block(rpc, msg);
319 ovs_fatal(error, "could not send notification");
325 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
330 static struct command all_commands[] = {
331 { "listen", NULL, 1, 1, do_listen },
332 { "request", NULL, 3, 3, do_request },
333 { "notify", NULL, 3, 3, do_notify },
334 { "help", NULL, 0, INT_MAX, do_help },
335 { NULL, NULL, 0, 0, NULL },
338 static struct command *
339 get_all_commands(void)
344 OVSTEST_REGISTER("test-jsonrpc", test_jsonrpc_main);