2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2015 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"
21 #include <netinet/in.h>
26 #include "fatal-signal.h"
29 #include "openflow/nicira-ext.h"
30 #include "openflow/openflow.h"
31 #include "openvswitch/dynamic-string.h"
32 #include "openvswitch/ofp-print.h"
33 #include "openvswitch/ofpbuf.h"
34 #include "openvswitch/vlog.h"
35 #include "ovs-thread.h"
37 #include "openvswitch/poll-loop.h"
39 #include "socket-util.h"
42 VLOG_DEFINE_THIS_MODULE(stream
);
44 COVERAGE_DEFINE(pstream_open
);
45 COVERAGE_DEFINE(stream_open
);
47 /* State of an active stream.*/
49 SCS_CONNECTING
, /* Underlying stream is not connected. */
50 SCS_CONNECTED
, /* Connection established. */
51 SCS_DISCONNECTED
/* Connection failed or connection closed. */
54 static const struct stream_class
*stream_classes
[] = {
59 &windows_stream_class
,
66 static const struct pstream_class
*pstream_classes
[] = {
71 &pwindows_pstream_class
,
78 /* Check the validity of the stream class structures. */
80 check_stream_classes(void)
85 for (i
= 0; i
< ARRAY_SIZE(stream_classes
); i
++) {
86 const struct stream_class
*class = stream_classes
[i
];
87 ovs_assert(class->name
!= NULL
);
88 ovs_assert(class->open
!= NULL
);
89 if (class->close
|| class->recv
|| class->send
|| class->run
90 || class->run_wait
|| class->wait
) {
91 ovs_assert(class->close
!= NULL
);
92 ovs_assert(class->recv
!= NULL
);
93 ovs_assert(class->send
!= NULL
);
94 ovs_assert(class->wait
!= NULL
);
96 /* This class delegates to another one. */
100 for (i
= 0; i
< ARRAY_SIZE(pstream_classes
); i
++) {
101 const struct pstream_class
*class = pstream_classes
[i
];
102 ovs_assert(class->name
!= NULL
);
103 ovs_assert(class->listen
!= NULL
);
104 if (class->close
|| class->accept
|| class->wait
) {
105 ovs_assert(class->close
!= NULL
);
106 ovs_assert(class->accept
!= NULL
);
107 ovs_assert(class->wait
!= NULL
);
109 /* This class delegates to another one. */
115 /* Prints information on active (if 'active') and passive (if 'passive')
116 * connection methods supported by the stream. */
118 stream_usage(const char *name
, bool active
, bool passive
,
119 bool bootstrap OVS_UNUSED
)
121 /* Really this should be implemented via callbacks into the stream
122 * providers, but that seems too heavy-weight to bother with at the
127 printf("Active %s connection methods:\n", name
);
128 printf(" tcp:IP:PORT "
129 "PORT at remote IP\n");
131 printf(" ssl:IP:PORT "
132 "SSL PORT at remote IP\n");
135 "Unix domain socket named FILE\n");
139 printf("Passive %s connection methods:\n", name
);
140 printf(" ptcp:PORT[:IP] "
141 "listen to TCP PORT on IP\n");
143 printf(" pssl:PORT[:IP] "
144 "listen for SSL on PORT on IP\n");
146 printf(" punix:FILE "
147 "listen on Unix domain socket FILE\n");
151 printf("PKI configuration (required to use SSL):\n"
152 " -p, --private-key=FILE file with private key\n"
153 " -c, --certificate=FILE file with certificate for private key\n"
154 " -C, --ca-cert=FILE file with peer CA certificate\n");
156 printf(" --bootstrap-ca-cert=FILE file with peer CA certificate "
157 "to read or create\n");
159 printf("SSL options:\n"
160 " --ssl-protocols=PROTOS list of SSL protocols to enable\n"
161 " --ssl-ciphers=CIPHERS list of SSL ciphers to enable\n");
165 /* Given 'name', a stream name in the form "TYPE:ARGS", stores the class
166 * named "TYPE" into '*classp' and returns 0. Returns EAFNOSUPPORT and stores
167 * a null pointer into '*classp' if 'name' is in the wrong form or if no such
170 stream_lookup_class(const char *name
, const struct stream_class
**classp
)
175 check_stream_classes();
178 prefix_len
= strcspn(name
, ":");
179 if (name
[prefix_len
] == '\0') {
182 for (i
= 0; i
< ARRAY_SIZE(stream_classes
); i
++) {
183 const struct stream_class
*class = stream_classes
[i
];
184 if (strlen(class->name
) == prefix_len
185 && !memcmp(class->name
, name
, prefix_len
)) {
193 /* Returns 0 if 'name' is a stream name in the form "TYPE:ARGS" and TYPE is
194 * a supported stream type, otherwise EAFNOSUPPORT. */
196 stream_verify_name(const char *name
)
198 const struct stream_class
*class;
199 return stream_lookup_class(name
, &class);
202 /* Attempts to connect a stream to a remote peer. 'name' is a connection name
203 * in the form "TYPE:ARGS", where TYPE is an active stream class's name and
204 * ARGS are stream class-specific.
206 * Returns 0 if successful, otherwise a positive errno value. If successful,
207 * stores a pointer to the new connection in '*streamp', otherwise a null
210 stream_open(const char *name
, struct stream
**streamp
, uint8_t dscp
)
212 const struct stream_class
*class;
213 struct stream
*stream
;
217 COVERAGE_INC(stream_open
);
219 /* Look up the class. */
220 error
= stream_lookup_class(name
, &class);
225 /* Call class's "open" function. */
226 suffix_copy
= xstrdup(strchr(name
, ':') + 1);
227 error
= class->open(name
, suffix_copy
, &stream
, dscp
);
242 /* Blocks until a previously started stream connection attempt succeeds or
243 * fails. 'error' should be the value returned by stream_open() and 'streamp'
244 * should point to the stream pointer set by stream_open(). Returns 0 if
245 * successful, otherwise a positive errno value other than EAGAIN or
246 * EINPROGRESS. If successful, leaves '*streamp' untouched; on error, closes
247 * '*streamp' and sets '*streamp' to null.
250 * error = stream_open_block(stream_open("tcp:1.2.3.4:5", &stream), &stream);
253 stream_open_block(int error
, struct stream
**streamp
)
255 struct stream
*stream
= *streamp
;
260 while ((error
= stream_connect(stream
)) == EAGAIN
) {
262 stream_run_wait(stream
);
263 stream_connect_wait(stream
);
266 ovs_assert(error
!= EINPROGRESS
);
270 stream_close(stream
);
278 /* Closes 'stream'. */
280 stream_close(struct stream
*stream
)
282 if (stream
!= NULL
) {
283 char *name
= stream
->name
;
284 char *peer_id
= stream
->peer_id
;
285 (stream
->class->close
)(stream
);
291 /* Returns the name of 'stream', that is, the string passed to
294 stream_get_name(const struct stream
*stream
)
296 return stream
? stream
->name
: "(null)";
300 scs_connecting(struct stream
*stream
)
302 int retval
= (stream
->class->connect
)(stream
);
303 ovs_assert(retval
!= EINPROGRESS
);
305 stream
->state
= SCS_CONNECTED
;
306 } else if (retval
!= EAGAIN
) {
307 stream
->state
= SCS_DISCONNECTED
;
308 stream
->error
= retval
;
312 /* Tries to complete the connection on 'stream'. If 'stream''s connection is
313 * complete, returns 0 if the connection was successful or a positive errno
314 * value if it failed. If the connection is still in progress, returns
317 stream_connect(struct stream
*stream
)
319 enum stream_state last_state
;
322 last_state
= stream
->state
;
323 switch (stream
->state
) {
325 scs_connecting(stream
);
331 case SCS_DISCONNECTED
:
332 return stream
->error
;
337 } while (stream
->state
!= last_state
);
342 /* Tries to receive up to 'n' bytes from 'stream' into 'buffer', and returns:
344 * - If successful, the number of bytes received (between 1 and 'n').
346 * - On error, a negative errno value.
348 * - 0, if the connection has been closed in the normal fashion, or if 'n'
351 * The recv function will not block waiting for a packet to arrive. If no
352 * data have been received, it returns -EAGAIN immediately. */
354 stream_recv(struct stream
*stream
, void *buffer
, size_t n
)
356 int retval
= stream_connect(stream
);
357 return (retval
? -retval
359 : (stream
->class->recv
)(stream
, buffer
, n
));
362 /* Tries to send up to 'n' bytes of 'buffer' on 'stream', and returns:
364 * - If successful, the number of bytes sent (between 1 and 'n'). 0 is
365 * only a valid return value if 'n' is 0.
367 * - On error, a negative errno value.
369 * The send function will not block. If no bytes can be immediately accepted
370 * for transmission, it returns -EAGAIN immediately. */
372 stream_send(struct stream
*stream
, const void *buffer
, size_t n
)
374 int retval
= stream_connect(stream
);
375 return (retval
? -retval
377 : (stream
->class->send
)(stream
, buffer
, n
));
380 /* Allows 'stream' to perform maintenance activities, such as flushing
383 stream_run(struct stream
*stream
)
385 if (stream
->class->run
) {
386 (stream
->class->run
)(stream
);
390 /* Arranges for the poll loop to wake up when 'stream' needs to perform
391 * maintenance activities. */
393 stream_run_wait(struct stream
*stream
)
395 if (stream
->class->run_wait
) {
396 (stream
->class->run_wait
)(stream
);
400 /* Arranges for the poll loop to wake up when 'stream' is ready to take an
401 * action of the given 'type'. */
403 stream_wait(struct stream
*stream
, enum stream_wait_type wait
)
405 ovs_assert(wait
== STREAM_CONNECT
|| wait
== STREAM_RECV
406 || wait
== STREAM_SEND
);
408 switch (stream
->state
) {
410 wait
= STREAM_CONNECT
;
413 case SCS_DISCONNECTED
:
414 poll_immediate_wake();
417 (stream
->class->wait
)(stream
, wait
);
421 stream_connect_wait(struct stream
*stream
)
423 stream_wait(stream
, STREAM_CONNECT
);
427 stream_recv_wait(struct stream
*stream
)
429 stream_wait(stream
, STREAM_RECV
);
433 stream_send_wait(struct stream
*stream
)
435 stream_wait(stream
, STREAM_SEND
);
439 stream_set_peer_id(struct stream
*stream
, const char *peer_id
)
441 free(stream
->peer_id
);
442 stream
->peer_id
= xstrdup(peer_id
);
446 stream_get_peer_id(const struct stream
*stream
)
448 return stream
->peer_id
;
451 /* Given 'name', a pstream name in the form "TYPE:ARGS", stores the class
452 * named "TYPE" into '*classp' and returns 0. Returns EAFNOSUPPORT and stores
453 * a null pointer into '*classp' if 'name' is in the wrong form or if no such
456 pstream_lookup_class(const char *name
, const struct pstream_class
**classp
)
461 check_stream_classes();
464 prefix_len
= strcspn(name
, ":");
465 if (name
[prefix_len
] == '\0') {
468 for (i
= 0; i
< ARRAY_SIZE(pstream_classes
); i
++) {
469 const struct pstream_class
*class = pstream_classes
[i
];
470 if (strlen(class->name
) == prefix_len
471 && !memcmp(class->name
, name
, prefix_len
)) {
479 /* Returns 0 if 'name' is a pstream name in the form "TYPE:ARGS" and TYPE is
480 * a supported pstream type, otherwise EAFNOSUPPORT. */
482 pstream_verify_name(const char *name
)
484 const struct pstream_class
*class;
485 return pstream_lookup_class(name
, &class);
488 /* Returns 1 if the stream or pstream specified by 'name' needs periodic probes
489 * to verify connectivity. For [p]streams which need probes, it can take a
490 * long time to notice the connection has been dropped. Returns 0 if the
491 * stream or pstream does not need probes, and -1 if 'name' is not valid. */
493 stream_or_pstream_needs_probes(const char *name
)
495 const struct pstream_class
*pclass
;
496 const struct stream_class
*class;
498 if (!stream_lookup_class(name
, &class)) {
499 return class->needs_probes
;
500 } else if (!pstream_lookup_class(name
, &pclass
)) {
501 return pclass
->needs_probes
;
507 /* Attempts to start listening for remote stream connections. 'name' is a
508 * connection name in the form "TYPE:ARGS", where TYPE is an passive stream
509 * class's name and ARGS are stream class-specific.
511 * Returns 0 if successful, otherwise a positive errno value. If successful,
512 * stores a pointer to the new connection in '*pstreamp', otherwise a null
515 pstream_open(const char *name
, struct pstream
**pstreamp
, uint8_t dscp
)
517 const struct pstream_class
*class;
518 struct pstream
*pstream
;
522 COVERAGE_INC(pstream_open
);
524 /* Look up the class. */
525 error
= pstream_lookup_class(name
, &class);
530 /* Call class's "open" function. */
531 suffix_copy
= xstrdup(strchr(name
, ':') + 1);
532 error
= class->listen(name
, suffix_copy
, &pstream
, dscp
);
547 /* Returns the name that was used to open 'pstream'. The caller must not
548 * modify or free the name. */
550 pstream_get_name(const struct pstream
*pstream
)
552 return pstream
->name
;
555 /* Closes 'pstream'. */
557 pstream_close(struct pstream
*pstream
)
559 if (pstream
!= NULL
) {
560 char *name
= pstream
->name
;
561 (pstream
->class->close
)(pstream
);
566 /* Tries to accept a new connection on 'pstream'. If successful, stores the
567 * new connection in '*new_stream' and returns 0. Otherwise, returns a
568 * positive errno value.
570 * pstream_accept() will not block waiting for a connection. If no connection
571 * is ready to be accepted, it returns EAGAIN immediately. */
573 pstream_accept(struct pstream
*pstream
, struct stream
**new_stream
)
575 int retval
= (pstream
->class->accept
)(pstream
, new_stream
);
579 ovs_assert((*new_stream
)->state
!= SCS_CONNECTING
580 || (*new_stream
)->class->connect
);
585 /* Tries to accept a new connection on 'pstream'. If successful, stores the
586 * new connection in '*new_stream' and returns 0. Otherwise, returns a
587 * positive errno value.
589 * pstream_accept_block() blocks until a connection is ready or until an error
590 * occurs. It will not return EAGAIN. */
592 pstream_accept_block(struct pstream
*pstream
, struct stream
**new_stream
)
597 while ((error
= pstream_accept(pstream
, new_stream
)) == EAGAIN
) {
598 pstream_wait(pstream
);
608 pstream_wait(struct pstream
*pstream
)
610 (pstream
->class->wait
)(pstream
);
613 /* Returns the transport port on which 'pstream' is listening, or 0 if the
614 * concept doesn't apply. */
616 pstream_get_bound_port(const struct pstream
*pstream
)
618 return pstream
->bound_port
;
621 /* Initializes 'stream' as a new stream named 'name', implemented via 'class'.
622 * The initial connection status, supplied as 'connect_status', is interpreted
625 * - 0: 'stream' is connected. Its 'send' and 'recv' functions may be
626 * called in the normal fashion.
628 * - EAGAIN: 'stream' is trying to complete a connection. Its 'connect'
629 * function should be called to complete the connection.
631 * - Other positive errno values indicate that the connection failed with
632 * the specified error.
634 * After calling this function, stream_close() must be used to destroy
635 * 'stream', otherwise resources will be leaked.
637 * Takes ownership of 'name'. */
639 stream_init(struct stream
*stream
, const struct stream_class
*class,
640 int connect_status
, char *name
)
642 memset(stream
, 0, sizeof *stream
);
643 stream
->class = class;
644 stream
->state
= (connect_status
== EAGAIN
? SCS_CONNECTING
645 : !connect_status
? SCS_CONNECTED
647 stream
->error
= connect_status
;
649 ovs_assert(stream
->state
!= SCS_CONNECTING
|| class->connect
);
652 /* Takes ownership of 'name'. */
654 pstream_init(struct pstream
*pstream
, const struct pstream_class
*class,
657 memset(pstream
, 0, sizeof *pstream
);
658 pstream
->class = class;
659 pstream
->name
= name
;
663 pstream_set_bound_port(struct pstream
*pstream
, ovs_be16 port
)
665 pstream
->bound_port
= port
;
669 count_fields(const char *s_
)
671 char *s
, *field
, *save_ptr
;
676 for (field
= strtok_r(s
, ":", &save_ptr
); field
!= NULL
;
677 field
= strtok_r(NULL
, ":", &save_ptr
)) {
685 /* Like stream_open(), but the port defaults to 'default_port' if no port
686 * number is given. */
688 stream_open_with_default_port(const char *name_
,
689 uint16_t default_port
,
690 struct stream
**streamp
,
696 if ((!strncmp(name_
, "tcp:", 4) || !strncmp(name_
, "ssl:", 4))
697 && count_fields(name_
) < 3) {
698 if (default_port
== OFP_PORT
) {
699 VLOG_WARN_ONCE("The default OpenFlow port number has changed "
701 OFP_OLD_PORT
, OFP_PORT
);
702 } else if (default_port
== OVSDB_PORT
) {
703 VLOG_WARN_ONCE("The default OVSDB port number has changed "
705 OVSDB_OLD_PORT
, OVSDB_PORT
);
707 name
= xasprintf("%s:%d", name_
, default_port
);
709 name
= xstrdup(name_
);
711 error
= stream_open(name
, streamp
, dscp
);
717 /* Like pstream_open(), but port defaults to 'default_port' if no port
718 * number is given. */
720 pstream_open_with_default_port(const char *name_
,
721 uint16_t default_port
,
722 struct pstream
**pstreamp
,
728 if ((!strncmp(name_
, "ptcp:", 5) || !strncmp(name_
, "pssl:", 5))
729 && count_fields(name_
) < 2) {
730 name
= xasprintf("%s%d", name_
, default_port
);
732 name
= xstrdup(name_
);
734 error
= pstream_open(name
, pstreamp
, dscp
);
741 * This function extracts IP address and port from the target string.
743 * - On success, function returns true and fills *ss structure with port
744 * and IP address. If port was absent in target string then it will use
745 * corresponding default port value.
746 * - On error, function returns false and *ss contains garbage.
749 stream_parse_target_with_default_port(const char *target
,
750 uint16_t default_port
,
751 struct sockaddr_storage
*ss
)
753 return ((!strncmp(target
, "tcp:", 4) || !strncmp(target
, "ssl:", 4))
754 && inet_parse_active(target
+ 4, default_port
, ss
));
757 /* Attempts to guess the content type of a stream whose first few bytes were
758 * the 'size' bytes of 'data'. */
759 static enum stream_content_type
760 stream_guess_content(const uint8_t *data
, ssize_t size
)
763 #define PAIR(A, B) (((A) << 8) | (B))
764 switch (PAIR(data
[0], data
[1])) {
765 case PAIR(0x16, 0x03): /* Handshake, version 3. */
768 return STREAM_JSONRPC
;
769 case PAIR(OFP10_VERSION
, 0 /* OFPT_HELLO */):
770 return STREAM_OPENFLOW
;
774 return STREAM_UNKNOWN
;
777 /* Returns a string represenation of 'type'. */
779 stream_content_type_to_string(enum stream_content_type type
)
789 case STREAM_OPENFLOW
:
797 /* Attempts to guess the content type of a stream whose first few bytes were
798 * the 'size' bytes of 'data'. If this is done successfully, and the guessed
799 * content type is other than 'expected_type', then log a message in vlog
800 * module 'module', naming 'stream_name' as the source, explaining what
801 * content was expected and what was actually received. */
803 stream_report_content(const void *data
, ssize_t size
,
804 enum stream_content_type expected_type
,
805 struct vlog_module
*module
, const char *stream_name
)
807 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(5, 5);
808 enum stream_content_type actual_type
;
810 actual_type
= stream_guess_content(data
, size
);
811 if (actual_type
!= expected_type
&& actual_type
!= STREAM_UNKNOWN
) {
812 vlog_rate_limit(module
, VLL_WARN
, &rl
,
813 "%s: received %s data on %s channel",
815 stream_content_type_to_string(actual_type
),
816 stream_content_type_to_string(expected_type
));