2 * Copyright (c) 2008, 2009 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.
19 #include <arpa/inet.h>
25 #include "dynamic-string.h"
29 #include "openflow/nicira-ext.h"
35 #define THIS_MODULE VLM_status
38 struct status_category {
41 void (*cb)(struct status_reply *, void *aux);
45 struct switch_status {
47 struct status_category *config_cat;
48 struct status_category *switch_cat;
49 struct list categories;
53 struct status_category *category;
59 switch_status_handle_request(struct switch_status *ss, struct rconn *rconn,
60 struct nicira_header *request)
62 struct status_category *c;
63 struct nicira_header *reply;
64 struct status_reply sr;
68 sr.request.string = (void *) (request + 1);
69 sr.request.length = ntohs(request->header.length) - sizeof *request;
71 LIST_FOR_EACH (c, struct status_category, node, &ss->categories) {
72 if (!memcmp(c->name, sr.request.string,
73 MIN(strlen(c->name), sr.request.length))) {
78 reply = make_openflow_xid(sizeof *reply + sr.output.length,
79 OFPT_VENDOR, request->header.xid, &b);
80 reply->vendor = htonl(NX_VENDOR_ID);
81 reply->subtype = htonl(NXT_STATUS_REPLY);
82 memcpy(reply + 1, sr.output.string, sr.output.length);
83 retval = rconn_send(rconn, b, NULL);
84 if (retval && retval != EAGAIN) {
85 VLOG_WARN("send failed (%s)", strerror(retval));
87 ds_destroy(&sr.output);
92 rconn_status_cb(struct status_reply *sr, void *rconn_)
94 struct rconn *rconn = rconn_;
95 time_t now = time_now();
97 status_reply_put(sr, "name=%s", rconn_get_name(rconn));
98 status_reply_put(sr, "state=%s", rconn_get_state(rconn));
99 status_reply_put(sr, "backoff=%d", rconn_get_backoff(rconn));
100 status_reply_put(sr, "probe-interval=%d", rconn_get_probe_interval(rconn));
101 status_reply_put(sr, "is-connected=%s",
102 rconn_is_connected(rconn) ? "true" : "false");
103 status_reply_put(sr, "sent-msgs=%u", rconn_packets_sent(rconn));
104 status_reply_put(sr, "received-msgs=%u", rconn_packets_received(rconn));
105 status_reply_put(sr, "attempted-connections=%u",
106 rconn_get_attempted_connections(rconn));
107 status_reply_put(sr, "successful-connections=%u",
108 rconn_get_successful_connections(rconn));
109 status_reply_put(sr, "last-connection=%ld",
110 (long int) (now - rconn_get_last_connection(rconn)));
111 status_reply_put(sr, "last-received=%ld",
112 (long int) (now - rconn_get_last_received(rconn)));
113 status_reply_put(sr, "time-connected=%lu",
114 rconn_get_total_time_connected(rconn));
115 status_reply_put(sr, "state-elapsed=%u", rconn_get_state_elapsed(rconn));
119 config_status_cb(struct status_reply *sr, void *ofproto_)
121 const struct ofproto *ofproto = ofproto_;
122 uint64_t datapath_id, mgmt_id;
123 struct svec listeners;
124 int probe_interval, max_backoff;
127 datapath_id = ofproto_get_datapath_id(ofproto);
129 status_reply_put(sr, "datapath-id=%"PRIx64, datapath_id);
132 mgmt_id = ofproto_get_mgmt_id(ofproto);
134 status_reply_put(sr, "mgmt-id=%"PRIx64, mgmt_id);
137 svec_init(&listeners);
138 ofproto_get_listeners(ofproto, &listeners);
139 for (i = 0; i < listeners.n; i++) {
140 status_reply_put(sr, "management%zu=%s", i, listeners.names[i]);
142 svec_destroy(&listeners);
144 probe_interval = ofproto_get_probe_interval(ofproto);
145 if (probe_interval) {
146 status_reply_put(sr, "probe-interval=%d", probe_interval);
149 max_backoff = ofproto_get_max_backoff(ofproto);
151 status_reply_put(sr, "max-backoff=%d", max_backoff);
156 switch_status_cb(struct status_reply *sr, void *ss_)
158 struct switch_status *ss = ss_;
159 time_t now = time_now();
161 status_reply_put(sr, "now=%ld", (long int) now);
162 status_reply_put(sr, "uptime=%ld", (long int) (now - ss->booted));
163 status_reply_put(sr, "pid=%ld", (long int) getpid());
166 struct switch_status *
167 switch_status_create(const struct ofproto *ofproto)
169 struct switch_status *ss = xcalloc(1, sizeof *ss);
170 ss->booted = time_now();
171 list_init(&ss->categories);
172 ss->config_cat = switch_status_register(ss, "config", config_status_cb,
174 ss->switch_cat = switch_status_register(ss, "switch", switch_status_cb,
180 switch_status_destroy(struct switch_status *ss)
183 /* Orphan any remaining categories, so that unregistering them later
184 * won't write to bad memory. */
185 struct status_category *c, *next;
186 LIST_FOR_EACH_SAFE (c, next,
187 struct status_category, node, &ss->categories) {
190 switch_status_unregister(ss->config_cat);
191 switch_status_unregister(ss->switch_cat);
196 struct status_category *
197 switch_status_register(struct switch_status *ss,
198 const char *category,
199 status_cb_func *cb, void *aux)
201 struct status_category *c = xmalloc(sizeof *c);
204 c->name = xstrdup(category);
205 list_push_back(&ss->categories, &c->node);
210 switch_status_unregister(struct status_category *c)
213 if (!list_is_empty(&c->node)) {
214 list_remove(&c->node);
222 status_reply_put(struct status_reply *sr, const char *content, ...)
224 size_t old_length = sr->output.length;
228 /* Append the status reply to the output. */
229 ds_put_format(&sr->output, "%s.", sr->category->name);
230 va_start(args, content);
231 ds_put_format_valist(&sr->output, content, args);
233 if (ds_last(&sr->output) != '\n') {
234 ds_put_char(&sr->output, '\n');
237 /* Drop what we just added if it doesn't match the request. */
238 added = sr->output.length - old_length;
239 if (added < sr->request.length
240 || memcmp(&sr->output.string[old_length],
241 sr->request.string, sr->request.length)) {
242 ds_truncate(&sr->output, old_length);