2 * Copyright (c) 2008, 2009, 2010, 2011 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.
18 #include "stream-provider.h"
22 #include <netinet/in.h>
27 #include "dynamic-string.h"
28 #include "fatal-signal.h"
30 #include "ofp-print.h"
32 #include "openflow/nicira-ext.h"
33 #include "openflow/openflow.h"
35 #include "poll-loop.h"
40 VLOG_DEFINE_THIS_MODULE(stream);
42 COVERAGE_DEFINE(pstream_open);
43 COVERAGE_DEFINE(stream_open);
45 /* State of an active stream.*/
47 SCS_CONNECTING, /* Underlying stream is not connected. */
48 SCS_CONNECTED, /* Connection established. */
49 SCS_DISCONNECTED /* Connection failed or connection closed. */
52 static const struct stream_class *stream_classes[] = {
60 static const struct pstream_class *pstream_classes[] = {
68 /* Check the validity of the stream class structures. */
70 check_stream_classes(void)
75 for (i = 0; i < ARRAY_SIZE(stream_classes); i++) {
76 const struct stream_class *class = stream_classes[i];
77 assert(class->name != NULL);
78 assert(class->open != NULL);
79 if (class->close || class->recv || class->send || class->run
80 || class->run_wait || class->wait) {
81 assert(class->close != NULL);
82 assert(class->recv != NULL);
83 assert(class->send != NULL);
84 assert(class->wait != NULL);
86 /* This class delegates to another one. */
90 for (i = 0; i < ARRAY_SIZE(pstream_classes); i++) {
91 const struct pstream_class *class = pstream_classes[i];
92 assert(class->name != NULL);
93 assert(class->listen != NULL);
94 if (class->close || class->accept || class->wait) {
95 assert(class->close != NULL);
96 assert(class->accept != NULL);
97 assert(class->wait != NULL);
99 /* This class delegates to another one. */
105 /* Prints information on active (if 'active') and passive (if 'passive')
106 * connection methods supported by the stream. */
108 stream_usage(const char *name, bool active, bool passive,
109 bool bootstrap OVS_UNUSED)
111 /* Really this should be implemented via callbacks into the stream
112 * providers, but that seems too heavy-weight to bother with at the
117 printf("Active %s connection methods:\n", name);
118 printf(" tcp:IP:PORT "
119 "PORT at remote IP\n");
121 printf(" ssl:IP:PORT "
122 "SSL PORT at remote IP\n");
125 "Unix domain socket named FILE\n");
129 printf("Passive %s connection methods:\n", name);
130 printf(" ptcp:PORT[:IP] "
131 "listen to TCP PORT on IP\n");
133 printf(" pssl:PORT[:IP] "
134 "listen for SSL on PORT on IP\n");
136 printf(" punix:FILE "
137 "listen on Unix domain socket FILE\n");
141 printf("PKI configuration (required to use SSL):\n"
142 " -p, --private-key=FILE file with private key\n"
143 " -c, --certificate=FILE file with certificate for private key\n"
144 " -C, --ca-cert=FILE file with peer CA certificate\n");
146 printf(" --bootstrap-ca-cert=FILE file with peer CA certificate "
147 "to read or create\n");
152 /* Given 'name', a stream name in the form "TYPE:ARGS", stores the class
153 * named "TYPE" into '*classp' and returns 0. Returns EAFNOSUPPORT and stores
154 * a null pointer into '*classp' if 'name' is in the wrong form or if no such
157 stream_lookup_class(const char *name, const struct stream_class **classp)
162 check_stream_classes();
165 prefix_len = strcspn(name, ":");
166 if (name[prefix_len] == '\0') {
169 for (i = 0; i < ARRAY_SIZE(stream_classes); i++) {
170 const struct stream_class *class = stream_classes[i];
171 if (strlen(class->name) == prefix_len
172 && !memcmp(class->name, name, prefix_len)) {
180 /* Returns 0 if 'name' is a stream name in the form "TYPE:ARGS" and TYPE is
181 * a supported stream type, otherwise EAFNOSUPPORT. */
183 stream_verify_name(const char *name)
185 const struct stream_class *class;
186 return stream_lookup_class(name, &class);
189 /* Attempts to connect a stream to a remote peer. 'name' is a connection name
190 * in the form "TYPE:ARGS", where TYPE is an active stream class's name and
191 * ARGS are stream class-specific.
193 * Returns 0 if successful, otherwise a positive errno value. If successful,
194 * stores a pointer to the new connection in '*streamp', otherwise a null
197 stream_open(const char *name, struct stream **streamp, uint8_t dscp)
199 const struct stream_class *class;
200 struct stream *stream;
204 COVERAGE_INC(stream_open);
206 /* Look up the class. */
207 error = stream_lookup_class(name, &class);
212 /* Call class's "open" function. */
213 suffix_copy = xstrdup(strchr(name, ':') + 1);
214 error = class->open(name, suffix_copy, &stream, dscp);
229 /* Blocks until a previously started stream connection attempt succeeds or
230 * fails. 'error' should be the value returned by stream_open() and 'streamp'
231 * should point to the stream pointer set by stream_open(). Returns 0 if
232 * successful, otherwise a positive errno value other than EAGAIN or
233 * EINPROGRESS. If successful, leaves '*streamp' untouched; on error, closes
234 * '*streamp' and sets '*streamp' to null.
237 * error = stream_open_block(stream_open("tcp:1.2.3.4:5", &stream), &stream);
240 stream_open_block(int error, struct stream **streamp)
242 struct stream *stream = *streamp;
247 while ((error = stream_connect(stream)) == EAGAIN) {
249 stream_run_wait(stream);
250 stream_connect_wait(stream);
253 assert(error != EINPROGRESS);
257 stream_close(stream);
265 /* Closes 'stream'. */
267 stream_close(struct stream *stream)
269 if (stream != NULL) {
270 char *name = stream->name;
271 (stream->class->close)(stream);
276 /* Returns the name of 'stream', that is, the string passed to
279 stream_get_name(const struct stream *stream)
281 return stream ? stream->name : "(null)";
284 /* Returns the IP address of the peer, or 0 if the peer is not connected over
285 * an IP-based protocol or if its IP address is not yet known. */
287 stream_get_remote_ip(const struct stream *stream)
289 return stream->remote_ip;
292 /* Returns the transport port of the peer, or 0 if the connection does not
293 * contain a port or if the port is not yet known. */
295 stream_get_remote_port(const struct stream *stream)
297 return stream->remote_port;
300 /* Returns the IP address used to connect to the peer, or 0 if the connection
301 * is not an IP-based protocol or if its IP address is not yet known. */
303 stream_get_local_ip(const struct stream *stream)
305 return stream->local_ip;
308 /* Returns the transport port used to connect to the peer, or 0 if the
309 * connection does not contain a port or if the port is not yet known. */
311 stream_get_local_port(const struct stream *stream)
313 return stream->local_port;
317 scs_connecting(struct stream *stream)
319 int retval = (stream->class->connect)(stream);
320 assert(retval != EINPROGRESS);
322 stream->state = SCS_CONNECTED;
323 } else if (retval != EAGAIN) {
324 stream->state = SCS_DISCONNECTED;
325 stream->error = retval;
329 /* Tries to complete the connection on 'stream'. If 'stream''s connection is
330 * complete, returns 0 if the connection was successful or a positive errno
331 * value if it failed. If the connection is still in progress, returns
334 stream_connect(struct stream *stream)
336 enum stream_state last_state;
339 last_state = stream->state;
340 switch (stream->state) {
342 scs_connecting(stream);
348 case SCS_DISCONNECTED:
349 return stream->error;
354 } while (stream->state != last_state);
359 /* Tries to receive up to 'n' bytes from 'stream' into 'buffer', and returns:
361 * - If successful, the number of bytes received (between 1 and 'n').
363 * - On error, a negative errno value.
365 * - 0, if the connection has been closed in the normal fashion, or if 'n'
368 * The recv function will not block waiting for a packet to arrive. If no
369 * data have been received, it returns -EAGAIN immediately. */
371 stream_recv(struct stream *stream, void *buffer, size_t n)
373 int retval = stream_connect(stream);
374 return (retval ? -retval
376 : (stream->class->recv)(stream, buffer, n));
379 /* Tries to send up to 'n' bytes of 'buffer' on 'stream', and returns:
381 * - If successful, the number of bytes sent (between 1 and 'n'). 0 is
382 * only a valid return value if 'n' is 0.
384 * - On error, a negative errno value.
386 * The send function will not block. If no bytes can be immediately accepted
387 * for transmission, it returns -EAGAIN immediately. */
389 stream_send(struct stream *stream, const void *buffer, size_t n)
391 int retval = stream_connect(stream);
392 return (retval ? -retval
394 : (stream->class->send)(stream, buffer, n));
397 /* Allows 'stream' to perform maintenance activities, such as flushing
400 stream_run(struct stream *stream)
402 if (stream->class->run) {
403 (stream->class->run)(stream);
407 /* Arranges for the poll loop to wake up when 'stream' needs to perform
408 * maintenance activities. */
410 stream_run_wait(struct stream *stream)
412 if (stream->class->run_wait) {
413 (stream->class->run_wait)(stream);
417 /* Arranges for the poll loop to wake up when 'stream' is ready to take an
418 * action of the given 'type'. */
420 stream_wait(struct stream *stream, enum stream_wait_type wait)
422 assert(wait == STREAM_CONNECT || wait == STREAM_RECV
423 || wait == STREAM_SEND);
425 switch (stream->state) {
427 wait = STREAM_CONNECT;
430 case SCS_DISCONNECTED:
431 poll_immediate_wake();
434 (stream->class->wait)(stream, wait);
438 stream_connect_wait(struct stream *stream)
440 stream_wait(stream, STREAM_CONNECT);
444 stream_recv_wait(struct stream *stream)
446 stream_wait(stream, STREAM_RECV);
450 stream_send_wait(struct stream *stream)
452 stream_wait(stream, STREAM_SEND);
455 /* Given 'name', a pstream name in the form "TYPE:ARGS", stores the class
456 * named "TYPE" into '*classp' and returns 0. Returns EAFNOSUPPORT and stores
457 * a null pointer into '*classp' if 'name' is in the wrong form or if no such
460 pstream_lookup_class(const char *name, const struct pstream_class **classp)
465 check_stream_classes();
468 prefix_len = strcspn(name, ":");
469 if (name[prefix_len] == '\0') {
472 for (i = 0; i < ARRAY_SIZE(pstream_classes); i++) {
473 const struct pstream_class *class = pstream_classes[i];
474 if (strlen(class->name) == prefix_len
475 && !memcmp(class->name, name, prefix_len)) {
483 /* Returns 0 if 'name' is a pstream name in the form "TYPE:ARGS" and TYPE is
484 * a supported pstream type, otherwise EAFNOSUPPORT. */
486 pstream_verify_name(const char *name)
488 const struct pstream_class *class;
489 return pstream_lookup_class(name, &class);
492 /* Returns 1 if the stream or pstream specified by 'name' needs periodic probes
493 * to verify connectivity. For [p]streams which need probes, it can take a
494 * long time to notice the connection has been dropped. Returns 0 if the
495 * stream or pstream does not need probes, and -1 if 'name' is not valid. */
497 stream_or_pstream_needs_probes(const char *name)
499 const struct pstream_class *pclass;
500 const struct stream_class *class;
502 if (!stream_lookup_class(name, &class)) {
503 return class->needs_probes;
504 } else if (!pstream_lookup_class(name, &pclass)) {
505 return pclass->needs_probes;
511 /* Attempts to start listening for remote stream connections. 'name' is a
512 * connection name in the form "TYPE:ARGS", where TYPE is an passive stream
513 * class's name and ARGS are stream class-specific.
515 * Returns 0 if successful, otherwise a positive errno value. If successful,
516 * stores a pointer to the new connection in '*pstreamp', otherwise a null
519 pstream_open(const char *name, struct pstream **pstreamp, uint8_t dscp)
521 const struct pstream_class *class;
522 struct pstream *pstream;
526 COVERAGE_INC(pstream_open);
528 /* Look up the class. */
529 error = pstream_lookup_class(name, &class);
534 /* Call class's "open" function. */
535 suffix_copy = xstrdup(strchr(name, ':') + 1);
536 error = class->listen(name, suffix_copy, &pstream, dscp);
551 /* Returns the name that was used to open 'pstream'. The caller must not
552 * modify or free the name. */
554 pstream_get_name(const struct pstream *pstream)
556 return pstream->name;
559 /* Closes 'pstream'. */
561 pstream_close(struct pstream *pstream)
563 if (pstream != NULL) {
564 char *name = pstream->name;
565 (pstream->class->close)(pstream);
570 /* Tries to accept a new connection on 'pstream'. If successful, stores the
571 * new connection in '*new_stream' and returns 0. Otherwise, returns a
572 * positive errno value.
574 * pstream_accept() will not block waiting for a connection. If no connection
575 * is ready to be accepted, it returns EAGAIN immediately. */
577 pstream_accept(struct pstream *pstream, struct stream **new_stream)
579 int retval = (pstream->class->accept)(pstream, new_stream);
583 assert((*new_stream)->state != SCS_CONNECTING
584 || (*new_stream)->class->connect);
589 /* Tries to accept a new connection on 'pstream'. If successful, stores the
590 * new connection in '*new_stream' and returns 0. Otherwise, returns a
591 * positive errno value.
593 * pstream_accept_block() blocks until a connection is ready or until an error
594 * occurs. It will not return EAGAIN. */
596 pstream_accept_block(struct pstream *pstream, struct stream **new_stream)
601 while ((error = pstream_accept(pstream, new_stream)) == EAGAIN) {
602 pstream_wait(pstream);
612 pstream_wait(struct pstream *pstream)
614 (pstream->class->wait)(pstream);
617 /* Initializes 'stream' as a new stream named 'name', implemented via 'class'.
618 * The initial connection status, supplied as 'connect_status', is interpreted
621 * - 0: 'stream' is connected. Its 'send' and 'recv' functions may be
622 * called in the normal fashion.
624 * - EAGAIN: 'stream' is trying to complete a connection. Its 'connect'
625 * function should be called to complete the connection.
627 * - Other positive errno values indicate that the connection failed with
628 * the specified error.
630 * After calling this function, stream_close() must be used to destroy
631 * 'stream', otherwise resources will be leaked.
633 * The caller retains ownership of 'name'. */
635 stream_init(struct stream *stream, const struct stream_class *class,
636 int connect_status, const char *name)
638 memset(stream, 0, sizeof *stream);
639 stream->class = class;
640 stream->state = (connect_status == EAGAIN ? SCS_CONNECTING
641 : !connect_status ? SCS_CONNECTED
643 stream->error = connect_status;
644 stream->name = xstrdup(name);
645 assert(stream->state != SCS_CONNECTING || class->connect);
649 stream_set_remote_ip(struct stream *stream, ovs_be32 ip)
651 stream->remote_ip = ip;
655 stream_set_remote_port(struct stream *stream, ovs_be16 port)
657 stream->remote_port = port;
661 stream_set_local_ip(struct stream *stream, ovs_be32 ip)
663 stream->local_ip = ip;
667 stream_set_local_port(struct stream *stream, ovs_be16 port)
669 stream->local_port = port;
673 pstream_init(struct pstream *pstream, const struct pstream_class *class,
676 pstream->class = class;
677 pstream->name = xstrdup(name);
681 count_fields(const char *s_)
683 char *s, *field, *save_ptr;
688 for (field = strtok_r(s, ":", &save_ptr); field != NULL;
689 field = strtok_r(NULL, ":", &save_ptr)) {
697 /* Like stream_open(), but for tcp streams the port defaults to
698 * 'default_tcp_port' if no port number is given and for SSL streams the port
699 * defaults to 'default_ssl_port' if no port number is given. */
701 stream_open_with_default_ports(const char *name_,
702 uint16_t default_tcp_port,
703 uint16_t default_ssl_port,
704 struct stream **streamp,
710 if (!strncmp(name_, "tcp:", 4) && count_fields(name_) < 3) {
711 name = xasprintf("%s:%d", name_, default_tcp_port);
712 } else if (!strncmp(name_, "ssl:", 4) && count_fields(name_) < 3) {
713 name = xasprintf("%s:%d", name_, default_ssl_port);
715 name = xstrdup(name_);
717 error = stream_open(name, streamp, dscp);
723 /* Like pstream_open(), but for ptcp streams the port defaults to
724 * 'default_ptcp_port' if no port number is given and for passive SSL streams
725 * the port defaults to 'default_pssl_port' if no port number is given. */
727 pstream_open_with_default_ports(const char *name_,
728 uint16_t default_ptcp_port,
729 uint16_t default_pssl_port,
730 struct pstream **pstreamp,
736 if (!strncmp(name_, "ptcp:", 5) && count_fields(name_) < 2) {
737 name = xasprintf("%s%d", name_, default_ptcp_port);
738 } else if (!strncmp(name_, "pssl:", 5) && count_fields(name_) < 2) {
739 name = xasprintf("%s%d", name_, default_pssl_port);
741 name = xstrdup(name_);
743 error = pstream_open(name, pstreamp, dscp);
750 * This function extracts IP address and port from the target string.
752 * - On success, function returns true and fills *sin structure with port
753 * and IP address. If port was absent in target string then it will use
754 * corresponding default port value.
755 * - On error, function returns false and *sin contains garbage.
758 stream_parse_target_with_default_ports(const char *target,
759 uint16_t default_tcp_port,
760 uint16_t default_ssl_port,
761 struct sockaddr_in *sin)
763 return (!strncmp(target, "tcp:", 4)
764 && inet_parse_active(target + 4, default_tcp_port, sin)) ||
765 (!strncmp(target, "ssl:", 4)
766 && inet_parse_active(target + 4, default_ssl_port, sin));
769 /* Attempts to guess the content type of a stream whose first few bytes were
770 * the 'size' bytes of 'data'. */
771 static enum stream_content_type
772 stream_guess_content(const uint8_t *data, ssize_t size)
775 #define PAIR(A, B) (((A) << 8) | (B))
776 switch (PAIR(data[0], data[1])) {
777 case PAIR(0x16, 0x03): /* Handshake, version 3. */
780 return STREAM_JSONRPC;
781 case PAIR(OFP10_VERSION, OFPT_HELLO):
782 return STREAM_OPENFLOW;
786 return STREAM_UNKNOWN;
789 /* Returns a string represenation of 'type'. */
791 stream_content_type_to_string(enum stream_content_type type)
801 case STREAM_OPENFLOW:
809 /* Attempts to guess the content type of a stream whose first few bytes were
810 * the 'size' bytes of 'data'. If this is done successfully, and the guessed
811 * content type is other than 'expected_type', then log a message in vlog
812 * module 'module', naming 'stream_name' as the source, explaining what
813 * content was expected and what was actually received. */
815 stream_report_content(const void *data, ssize_t size,
816 enum stream_content_type expected_type,
817 struct vlog_module *module, const char *stream_name)
819 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 5);
820 enum stream_content_type actual_type;
822 actual_type = stream_guess_content(data, size);
823 if (actual_type != expected_type && actual_type != STREAM_UNKNOWN) {
824 vlog_rate_limit(module, VLL_WARN, &rl,
825 "%s: received %s data on %s channel",
827 stream_content_type_to_string(actual_type),
828 stream_content_type_to_string(expected_type));