2 * Copyright (c) 2009, 2010 Nicira Networks.
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.
27 #include "command-line.h"
30 #include "poll-loop.h"
31 #include "stream-ssl.h"
37 static struct command all_commands[];
39 static void usage(void) NO_RETURN;
40 static void parse_options(int argc, char *argv[]);
43 main(int argc, char *argv[])
45 proctitle_init(argc, argv);
46 set_program_name(argv[0]);
49 parse_options(argc, argv);
50 run_command(argc - optind, argv + optind, all_commands);
55 parse_options(int argc, char *argv[])
58 OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1
60 static struct option long_options[] = {
61 {"verbose", optional_argument, 0, 'v'},
62 {"help", no_argument, 0, 'h'},
65 {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
66 STREAM_SSL_LONG_OPTIONS
70 char *short_options = long_options_to_short_options(long_options);
73 int c = getopt_long(argc, argv, short_options, long_options, NULL);
83 vlog_set_verbosity(optarg);
86 DAEMON_OPTION_HANDLERS
89 STREAM_SSL_OPTION_HANDLERS
91 case OPT_BOOTSTRAP_CA_CERT:
92 stream_ssl_set_ca_cert_file(optarg, true);
109 printf("%s: JSON-RPC test utility\n"
110 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
111 " listen LOCAL listen for connections on LOCAL\n"
112 " request REMOTE METHOD PARAMS send request, print reply\n"
113 " notify REMOTE METHOD PARAMS send notification and exit\n",
114 program_name, program_name);
115 stream_usage("JSON-RPC", true, true, true);
118 printf("\nOther options:\n"
119 " -h, --help display this help message\n");
123 /* Command helper functions. */
126 parse_json(const char *s)
128 struct json *json = json_from_string(s);
129 if (json->type == JSON_STRING) {
130 ovs_fatal(0, "\"%s\": %s", s, json->u.string);
136 print_and_free_json(struct json *json)
138 char *string = json_to_string(json, JSSF_SORT);
144 /* Command implementations. */
147 handle_rpc(struct jsonrpc *rpc, struct jsonrpc_msg *msg, bool *done)
149 struct jsonrpc_msg *reply = NULL;
150 if (msg->type == JSONRPC_REQUEST) {
151 if (!strcmp(msg->method, "echo")) {
152 reply = jsonrpc_create_reply(json_clone(msg->params), msg->id);
154 struct json *error = json_object_create();
155 json_object_put_string(error, "error", "unknown method");
156 reply = jsonrpc_create_error(error, msg->id);
157 ovs_error(0, "unknown request %s", msg->method);
160 } else if (msg->type == JSONRPC_NOTIFY) {
161 if (!strcmp(msg->method, "shutdown")) {
164 jsonrpc_error(rpc, ENOTTY);
165 ovs_error(0, "unknown notification %s", msg->method);
168 jsonrpc_error(rpc, EPROTO);
169 ovs_error(0, "unsolicited JSON-RPC reply or error");
173 jsonrpc_send(rpc, reply);
178 do_listen(int argc OVS_UNUSED, char *argv[])
180 struct pstream *pstream;
181 struct jsonrpc **rpcs;
182 size_t n_rpcs, allocated_rpcs;
186 die_if_already_running();
188 error = pstream_open(argv[1], &pstream);
190 ovs_fatal(error, "could not listen on \"%s\"", argv[1]);
196 n_rpcs = allocated_rpcs = 0;
199 struct stream *stream;
202 /* Accept new connections. */
203 error = pstream_accept(pstream, &stream);
205 if (n_rpcs >= allocated_rpcs) {
206 rpcs = x2nrealloc(rpcs, &allocated_rpcs, sizeof *rpcs);
208 rpcs[n_rpcs++] = jsonrpc_open(stream);
209 } else if (error != EAGAIN) {
210 ovs_fatal(error, "pstream_accept failed");
213 /* Service existing connections. */
214 for (i = 0; i < n_rpcs; ) {
215 struct jsonrpc *rpc = rpcs[i];
216 struct jsonrpc_msg *msg;
219 if (!jsonrpc_get_backlog(rpc)) {
220 error = jsonrpc_recv(rpc, &msg);
222 handle_rpc(rpc, msg, &done);
223 jsonrpc_msg_destroy(msg);
227 error = jsonrpc_get_status(rpc);
230 ovs_error(error, "connection closed");
231 memmove(&rpcs[i], &rpcs[i + 1],
232 (n_rpcs - i - 1) * sizeof *rpcs);
239 /* Wait for something to do. */
240 if (done && !n_rpcs) {
243 pstream_wait(pstream);
244 for (i = 0; i < n_rpcs; i++) {
245 struct jsonrpc *rpc = rpcs[i];
248 if (!jsonrpc_get_backlog(rpc)) {
249 jsonrpc_recv_wait(rpc);
255 pstream_close(pstream);
259 do_request(int argc OVS_UNUSED, char *argv[])
261 struct jsonrpc_msg *msg;
264 struct stream *stream;
270 params = parse_json(argv[3]);
271 msg = jsonrpc_create_request(method, params, NULL);
272 string = jsonrpc_msg_is_valid(msg);
274 ovs_fatal(0, "not a valid JSON-RPC request: %s", string);
277 error = stream_open_block(argv[1], &stream);
279 ovs_fatal(error, "could not open \"%s\"", argv[1]);
281 rpc = jsonrpc_open(stream);
283 error = jsonrpc_send(rpc, msg);
285 ovs_fatal(error, "could not send request");
288 error = jsonrpc_recv_block(rpc, &msg);
290 ovs_fatal(error, "error waiting for reply");
292 print_and_free_json(jsonrpc_msg_to_json(msg));
298 do_notify(int argc OVS_UNUSED, char *argv[])
300 struct jsonrpc_msg *msg;
303 struct stream *stream;
309 params = parse_json(argv[3]);
310 msg = jsonrpc_create_notify(method, params);
311 string = jsonrpc_msg_is_valid(msg);
313 ovs_fatal(0, "not a JSON RPC-valid notification: %s", string);
316 error = stream_open_block(argv[1], &stream);
318 ovs_fatal(error, "could not open \"%s\"", argv[1]);
320 rpc = jsonrpc_open(stream);
322 error = jsonrpc_send_block(rpc, msg);
324 ovs_fatal(error, "could not send request");
330 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
335 static struct command all_commands[] = {
336 { "listen", 1, 1, do_listen },
337 { "request", 3, 3, do_request },
338 { "notify", 3, 3, do_notify },
339 { "help", 0, INT_MAX, do_help },
340 { NULL, 0, 0, NULL },