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]);
47 parse_options(argc, argv);
48 run_command(argc - optind, argv + optind, all_commands);
53 parse_options(int argc, char *argv[])
56 OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1
58 static struct option long_options[] = {
59 {"verbose", optional_argument, 0, 'v'},
60 {"help", no_argument, 0, 'h'},
63 {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
64 STREAM_SSL_LONG_OPTIONS
68 char *short_options = long_options_to_short_options(long_options);
71 int c = getopt_long(argc, argv, short_options, long_options, NULL);
81 vlog_set_verbosity(optarg);
84 DAEMON_OPTION_HANDLERS
87 STREAM_SSL_OPTION_HANDLERS
89 case OPT_BOOTSTRAP_CA_CERT:
90 stream_ssl_set_ca_cert_file(optarg, true);
107 printf("%s: JSON-RPC test utility\n"
108 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
109 " listen LOCAL listen for connections on LOCAL\n"
110 " request REMOTE METHOD PARAMS send request, print reply\n"
111 " notify REMOTE METHOD PARAMS send notification and exit\n",
112 program_name, program_name);
113 stream_usage("JSON-RPC", true, true, true);
116 printf("\nOther options:\n"
117 " -h, --help display this help message\n");
121 /* Command helper functions. */
124 parse_json(const char *s)
126 struct json *json = json_from_string(s);
127 if (json->type == JSON_STRING) {
128 ovs_fatal(0, "\"%s\": %s", s, json->u.string);
134 print_and_free_json(struct json *json)
136 char *string = json_to_string(json, JSSF_SORT);
142 /* Command implementations. */
145 handle_rpc(struct jsonrpc *rpc, struct jsonrpc_msg *msg, bool *done)
147 struct jsonrpc_msg *reply = NULL;
148 if (msg->type == JSONRPC_REQUEST) {
149 if (!strcmp(msg->method, "echo")) {
150 reply = jsonrpc_create_reply(json_clone(msg->params), msg->id);
152 struct json *error = json_object_create();
153 json_object_put_string(error, "error", "unknown method");
154 reply = jsonrpc_create_error(error, msg->id);
155 ovs_error(0, "unknown request %s", msg->method);
158 } else if (msg->type == JSONRPC_NOTIFY) {
159 if (!strcmp(msg->method, "shutdown")) {
162 jsonrpc_error(rpc, ENOTTY);
163 ovs_error(0, "unknown notification %s", msg->method);
166 jsonrpc_error(rpc, EPROTO);
167 ovs_error(0, "unsolicited JSON-RPC reply or error");
171 jsonrpc_send(rpc, reply);
176 do_listen(int argc OVS_UNUSED, char *argv[])
178 struct pstream *pstream;
179 struct jsonrpc **rpcs;
180 size_t n_rpcs, allocated_rpcs;
184 die_if_already_running();
186 error = jsonrpc_pstream_open(argv[1], &pstream);
188 ovs_fatal(error, "could not listen on \"%s\"", argv[1]);
194 n_rpcs = allocated_rpcs = 0;
197 struct stream *stream;
200 /* Accept new connections. */
201 error = pstream_accept(pstream, &stream);
203 if (n_rpcs >= allocated_rpcs) {
204 rpcs = x2nrealloc(rpcs, &allocated_rpcs, sizeof *rpcs);
206 rpcs[n_rpcs++] = jsonrpc_open(stream);
207 } else if (error != EAGAIN) {
208 ovs_fatal(error, "pstream_accept failed");
211 /* Service existing connections. */
212 for (i = 0; i < n_rpcs; ) {
213 struct jsonrpc *rpc = rpcs[i];
214 struct jsonrpc_msg *msg;
217 if (!jsonrpc_get_backlog(rpc)) {
218 error = jsonrpc_recv(rpc, &msg);
220 handle_rpc(rpc, msg, &done);
221 jsonrpc_msg_destroy(msg);
225 error = jsonrpc_get_status(rpc);
228 ovs_error(error, "connection closed");
229 memmove(&rpcs[i], &rpcs[i + 1],
230 (n_rpcs - i - 1) * sizeof *rpcs);
237 /* Wait for something to do. */
238 if (done && !n_rpcs) {
241 pstream_wait(pstream);
242 for (i = 0; i < n_rpcs; i++) {
243 struct jsonrpc *rpc = rpcs[i];
246 if (!jsonrpc_get_backlog(rpc)) {
247 jsonrpc_recv_wait(rpc);
253 pstream_close(pstream);
257 do_request(int argc OVS_UNUSED, char *argv[])
259 struct jsonrpc_msg *msg;
262 struct stream *stream;
268 params = parse_json(argv[3]);
269 msg = jsonrpc_create_request(method, params, NULL);
270 string = jsonrpc_msg_is_valid(msg);
272 ovs_fatal(0, "not a valid JSON-RPC request: %s", string);
275 error = stream_open_block(jsonrpc_stream_open(argv[1], &stream), &stream);
277 ovs_fatal(error, "could not open \"%s\"", argv[1]);
279 rpc = jsonrpc_open(stream);
281 error = jsonrpc_send(rpc, msg);
283 ovs_fatal(error, "could not send request");
286 error = jsonrpc_recv_block(rpc, &msg);
288 ovs_fatal(error, "error waiting for reply");
290 print_and_free_json(jsonrpc_msg_to_json(msg));
296 do_notify(int argc OVS_UNUSED, char *argv[])
298 struct jsonrpc_msg *msg;
301 struct stream *stream;
307 params = parse_json(argv[3]);
308 msg = jsonrpc_create_notify(method, params);
309 string = jsonrpc_msg_is_valid(msg);
311 ovs_fatal(0, "not a JSON RPC-valid notification: %s", string);
314 error = stream_open_block(jsonrpc_stream_open(argv[1], &stream), &stream);
316 ovs_fatal(error, "could not open \"%s\"", argv[1]);
318 rpc = jsonrpc_open(stream);
320 error = jsonrpc_send_block(rpc, msg);
322 ovs_fatal(error, "could not send notification");
328 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
333 static struct command all_commands[] = {
334 { "listen", 1, 1, do_listen },
335 { "request", 3, 3, do_request },
336 { "notify", 3, 3, do_notify },
337 { "help", 0, INT_MAX, do_help },
338 { NULL, 0, 0, NULL },