utilities: Improve ovs-vlan-test man page.
[openvswitch] / ofproto / status.c
1 /*
2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #include <config.h>
18 #include "status.h"
19 #include <arpa/inet.h>
20 #include <assert.h>
21 #include <errno.h>
22 #include <inttypes.h>
23 #include <stdlib.h>
24 #include <unistd.h>
25 #include "dynamic-string.h"
26 #include "list.h"
27 #include "ofp-util.h"
28 #include "ofpbuf.h"
29 #include "ofproto.h"
30 #include "openflow/nicira-ext.h"
31 #include "packets.h"
32 #include "rconn.h"
33 #include "svec.h"
34 #include "timeval.h"
35 #include "vconn.h"
36 #include "vlog.h"
37
38 VLOG_DEFINE_THIS_MODULE(status);
39
40 struct status_category {
41     struct list node;
42     char *name;
43     void (*cb)(struct status_reply *, void *aux);
44     void *aux;
45 };
46
47 struct switch_status {
48     time_t booted;
49     struct status_category *config_cat;
50     struct status_category *switch_cat;
51     struct list categories;
52 };
53
54 struct status_reply {
55     struct status_category *category;
56     struct ds request;
57     struct ds output;
58 };
59
60 int
61 switch_status_handle_request(struct switch_status *ss, struct rconn *rconn,
62                              const struct ofp_header *oh)
63 {
64     const struct nicira_header *request = (const struct nicira_header *) oh;
65     struct status_category *c;
66     struct nicira_header *reply;
67     struct status_reply sr;
68     struct ofpbuf *b;
69     int retval;
70
71     sr.request.string = (void *) (request + 1);
72     sr.request.length = ntohs(request->header.length) - sizeof *request;
73     ds_init(&sr.output);
74     LIST_FOR_EACH (c, node, &ss->categories) {
75         if (!memcmp(c->name, sr.request.string,
76                     MIN(strlen(c->name), sr.request.length))) {
77             sr.category = c;
78             c->cb(&sr, c->aux);
79         }
80     }
81     reply = make_nxmsg_xid(sizeof *reply + sr.output.length,
82                            NXT_STATUS_REPLY, request->header.xid, &b);
83     memcpy(reply + 1, sr.output.string, sr.output.length);
84     retval = rconn_send(rconn, b, NULL);
85     if (retval && retval != EAGAIN) {
86         VLOG_WARN("send failed (%s)", strerror(retval));
87     }
88     ds_destroy(&sr.output);
89     return 0;
90 }
91
92 void
93 rconn_status_cb(struct status_reply *sr, void *rconn_)
94 {
95     struct rconn *rconn = rconn_;
96     time_t now = time_now();
97     uint32_t remote_ip = rconn_get_remote_ip(rconn);
98     uint32_t local_ip = rconn_get_local_ip(rconn);
99
100     status_reply_put(sr, "name=%s", rconn_get_target(rconn));
101     if (remote_ip) {
102         status_reply_put(sr, "remote-ip="IP_FMT, IP_ARGS(&remote_ip));
103         status_reply_put(sr, "remote-port=%d",
104                          ntohs(rconn_get_remote_port(rconn)));
105         status_reply_put(sr, "local-ip="IP_FMT, IP_ARGS(&local_ip));
106         status_reply_put(sr, "local-port=%d",
107                          ntohs(rconn_get_local_port(rconn)));
108     }
109     status_reply_put(sr, "state=%s", rconn_get_state(rconn));
110     status_reply_put(sr, "backoff=%d", rconn_get_backoff(rconn));
111     status_reply_put(sr, "probe-interval=%d", rconn_get_probe_interval(rconn));
112     status_reply_put(sr, "is-connected=%s",
113                      rconn_is_connected(rconn) ? "true" : "false");
114     status_reply_put(sr, "sent-msgs=%u", rconn_packets_sent(rconn));
115     status_reply_put(sr, "received-msgs=%u", rconn_packets_received(rconn));
116     status_reply_put(sr, "attempted-connections=%u",
117                      rconn_get_attempted_connections(rconn));
118     status_reply_put(sr, "successful-connections=%u",
119                      rconn_get_successful_connections(rconn));
120     status_reply_put(sr, "last-connection=%ld",
121                      (long int) (now - rconn_get_last_connection(rconn)));
122     status_reply_put(sr, "last-received=%ld",
123                      (long int) (now - rconn_get_last_received(rconn)));
124     status_reply_put(sr, "time-connected=%lu",
125                      rconn_get_total_time_connected(rconn));
126     status_reply_put(sr, "state-elapsed=%u", rconn_get_state_elapsed(rconn));
127 }
128
129 static void
130 config_status_cb(struct status_reply *sr, void *ofproto_)
131 {
132     const struct ofproto *ofproto = ofproto_;
133     uint64_t datapath_id;
134
135     datapath_id = ofproto_get_datapath_id(ofproto);
136     if (datapath_id) {
137         status_reply_put(sr, "datapath-id=%016"PRIx64, datapath_id);
138     }
139 }
140
141 static void
142 switch_status_cb(struct status_reply *sr, void *ss_)
143 {
144     struct switch_status *ss = ss_;
145     time_t now = time_now();
146
147     status_reply_put(sr, "now=%ld", (long int) now);
148     status_reply_put(sr, "uptime=%ld", (long int) (now - ss->booted));
149     status_reply_put(sr, "pid=%ld", (long int) getpid());
150 }
151
152 struct switch_status *
153 switch_status_create(const struct ofproto *ofproto)
154 {
155     struct switch_status *ss = xzalloc(sizeof *ss);
156     ss->booted = time_now();
157     list_init(&ss->categories);
158     ss->config_cat = switch_status_register(ss, "config", config_status_cb,
159                                             (void *) ofproto);
160     ss->switch_cat = switch_status_register(ss, "switch", switch_status_cb,
161                                             ss);
162     return ss;
163 }
164
165 void
166 switch_status_destroy(struct switch_status *ss)
167 {
168     if (ss) {
169         /* Orphan any remaining categories, so that unregistering them later
170          * won't write to bad memory. */
171         struct status_category *c, *next;
172         LIST_FOR_EACH_SAFE (c, next, node, &ss->categories) {
173             list_init(&c->node);
174         }
175         switch_status_unregister(ss->config_cat);
176         switch_status_unregister(ss->switch_cat);
177         free(ss);
178     }
179 }
180
181 struct status_category *
182 switch_status_register(struct switch_status *ss,
183                        const char *category,
184                        status_cb_func *cb, void *aux)
185 {
186     struct status_category *c = xmalloc(sizeof *c);
187     c->cb = cb;
188     c->aux = aux;
189     c->name = xstrdup(category);
190     list_push_back(&ss->categories, &c->node);
191     return c;
192 }
193
194 void
195 switch_status_unregister(struct status_category *c)
196 {
197     if (c) {
198         if (!list_is_empty(&c->node)) {
199             list_remove(&c->node);
200         }
201         free(c->name);
202         free(c);
203     }
204 }
205
206 void
207 status_reply_put(struct status_reply *sr, const char *content, ...)
208 {
209     size_t old_length = sr->output.length;
210     size_t added;
211     va_list args;
212
213     /* Append the status reply to the output. */
214     ds_put_format(&sr->output, "%s.", sr->category->name);
215     va_start(args, content);
216     ds_put_format_valist(&sr->output, content, args);
217     va_end(args);
218     if (ds_last(&sr->output) != '\n') {
219         ds_put_char(&sr->output, '\n');
220     }
221
222     /* Drop what we just added if it doesn't match the request. */
223     added = sr->output.length - old_length;
224     if (added < sr->request.length
225         || memcmp(&sr->output.string[old_length],
226                   sr->request.string, sr->request.length)) {
227         ds_truncate(&sr->output, old_length);
228     }
229 }