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 <sys/types.h>
22 #include <netinet/in.h>
27 #include "fatal-signal.h"
30 #include "openflow/nicira-ext.h"
31 #include "openflow/openflow.h"
32 #include "openvswitch/dynamic-string.h"
33 #include "openvswitch/ofp-print.h"
34 #include "openvswitch/ofpbuf.h"
35 #include "openvswitch/vlog.h"
36 #include "ovs-thread.h"
38 #include "openvswitch/poll-loop.h"
40 #include "socket-util.h"
43 VLOG_DEFINE_THIS_MODULE(stream
);
45 COVERAGE_DEFINE(pstream_open
);
46 COVERAGE_DEFINE(stream_open
);
48 /* State of an active stream.*/
50 SCS_CONNECTING
, /* Underlying stream is not connected. */
51 SCS_CONNECTED
, /* Connection established. */
52 SCS_DISCONNECTED
/* Connection failed or connection closed. */
55 static const struct stream_class
*stream_classes
[] = {
60 &windows_stream_class
,
67 static const struct pstream_class
*pstream_classes
[] = {
72 &pwindows_pstream_class
,
79 /* Check the validity of the stream class structures. */
81 check_stream_classes(void)
86 for (i
= 0; i
< ARRAY_SIZE(stream_classes
); i
++) {
87 const struct stream_class
*class = stream_classes
[i
];
88 ovs_assert(class->name
!= NULL
);
89 ovs_assert(class->open
!= NULL
);
90 if (class->close
|| class->recv
|| class->send
|| class->run
91 || class->run_wait
|| class->wait
) {
92 ovs_assert(class->close
!= NULL
);
93 ovs_assert(class->recv
!= NULL
);
94 ovs_assert(class->send
!= NULL
);
95 ovs_assert(class->wait
!= NULL
);
97 /* This class delegates to another one. */
101 for (i
= 0; i
< ARRAY_SIZE(pstream_classes
); i
++) {
102 const struct pstream_class
*class = pstream_classes
[i
];
103 ovs_assert(class->name
!= NULL
);
104 ovs_assert(class->listen
!= NULL
);
105 if (class->close
|| class->accept
|| class->wait
) {
106 ovs_assert(class->close
!= NULL
);
107 ovs_assert(class->accept
!= NULL
);
108 ovs_assert(class->wait
!= NULL
);
110 /* This class delegates to another one. */
116 /* Prints information on active (if 'active') and passive (if 'passive')
117 * connection methods supported by the stream. */
119 stream_usage(const char *name
, bool active
, bool passive
,
120 bool bootstrap OVS_UNUSED
)
122 /* Really this should be implemented via callbacks into the stream
123 * providers, but that seems too heavy-weight to bother with at the
128 printf("Active %s connection methods:\n", name
);
129 printf(" tcp:HOST:PORT "
130 "PORT at remote HOST\n");
132 printf(" ssl:HOST:PORT "
133 "SSL PORT at remote HOST\n");
136 "Unix domain socket named FILE\n");
140 printf("Passive %s connection methods:\n", name
);
141 printf(" ptcp:PORT[:IP] "
142 "listen to TCP PORT on IP\n");
144 printf(" pssl:PORT[:IP] "
145 "listen for SSL on PORT on IP\n");
147 printf(" punix:FILE "
148 "listen on Unix domain socket FILE\n");
152 printf("PKI configuration (required to use SSL):\n"
153 " -p, --private-key=FILE file with private key\n"
154 " -c, --certificate=FILE file with certificate for private key\n"
155 " -C, --ca-cert=FILE file with peer CA certificate\n");
157 printf(" --bootstrap-ca-cert=FILE file with peer CA certificate "
158 "to read or create\n");
160 printf("SSL options:\n"
161 " --ssl-protocols=PROTOS list of SSL protocols to enable\n"
162 " --ssl-ciphers=CIPHERS list of SSL ciphers to enable\n");
166 /* Given 'name', a stream name in the form "TYPE:ARGS", stores the class
167 * named "TYPE" into '*classp' and returns 0. Returns EAFNOSUPPORT and stores
168 * a null pointer into '*classp' if 'name' is in the wrong form or if no such
171 stream_lookup_class(const char *name
, const struct stream_class
**classp
)
176 check_stream_classes();
179 prefix_len
= strcspn(name
, ":");
180 if (name
[prefix_len
] == '\0') {
183 for (i
= 0; i
< ARRAY_SIZE(stream_classes
); i
++) {
184 const struct stream_class
*class = stream_classes
[i
];
185 if (strlen(class->name
) == prefix_len
186 && !memcmp(class->name
, name
, prefix_len
)) {
194 /* Returns 0 if 'name' is a stream name in the form "TYPE:ARGS" and TYPE is
195 * a supported stream type, otherwise EAFNOSUPPORT. */
197 stream_verify_name(const char *name
)
199 const struct stream_class
*class;
200 return stream_lookup_class(name
, &class);
203 /* Attempts to connect a stream to a remote peer. 'name' is a connection name
204 * in the form "TYPE:ARGS", where TYPE is an active stream class's name and
205 * ARGS are stream class-specific.
207 * Returns 0 if successful, otherwise a positive errno value. If successful,
208 * stores a pointer to the new connection in '*streamp', otherwise a null
211 stream_open(const char *name
, struct stream
**streamp
, uint8_t dscp
)
213 const struct stream_class
*class;
214 struct stream
*stream
;
218 COVERAGE_INC(stream_open
);
220 /* Look up the class. */
221 error
= stream_lookup_class(name
, &class);
226 /* Call class's "open" function. */
227 suffix_copy
= xstrdup(strchr(name
, ':') + 1);
228 error
= class->open(name
, suffix_copy
, &stream
, dscp
);
243 /* Blocks until a previously started stream connection attempt succeeds or
244 * fails, but no more than 'timeout' milliseconds. 'error' should be the
245 * value returned by stream_open() and 'streamp' should point to the stream
246 * pointer set by stream_open(). Returns 0 if successful, otherwise a
247 * positive errno value other than EAGAIN or EINPROGRESS. If successful,
248 * leaves '*streamp' untouched; on error, closes '*streamp' and sets
249 * '*streamp' to null. Negative value of 'timeout' means infinite waiting.
252 * error = stream_open_block(stream_open("tcp:1.2.3.4:5", &stream), -1,
256 stream_open_block(int error
, long long int timeout
, struct stream
**streamp
)
258 struct stream
*stream
= *streamp
;
263 long long int deadline
= (timeout
>= 0
264 ? time_msec() + timeout
266 while ((error
= stream_connect(stream
)) == EAGAIN
) {
267 if (deadline
!= LLONG_MAX
&& time_msec() > deadline
) {
272 stream_run_wait(stream
);
273 stream_connect_wait(stream
);
274 if (deadline
!= LLONG_MAX
) {
275 poll_timer_wait_until(deadline
);
279 ovs_assert(error
!= EINPROGRESS
);
283 stream_close(stream
);
291 /* Closes 'stream'. */
293 stream_close(struct stream
*stream
)
295 if (stream
!= NULL
) {
296 char *name
= stream
->name
;
297 char *peer_id
= stream
->peer_id
;
298 (stream
->class->close
)(stream
);
304 /* Returns the name of 'stream', that is, the string passed to
307 stream_get_name(const struct stream
*stream
)
309 return stream
? stream
->name
: "(null)";
313 scs_connecting(struct stream
*stream
)
315 int retval
= (stream
->class->connect
)(stream
);
316 ovs_assert(retval
!= EINPROGRESS
);
318 stream
->state
= SCS_CONNECTED
;
319 } else if (retval
!= EAGAIN
) {
320 stream
->state
= SCS_DISCONNECTED
;
321 stream
->error
= retval
;
325 /* Tries to complete the connection on 'stream'. If 'stream''s connection is
326 * complete, returns 0 if the connection was successful or a positive errno
327 * value if it failed. If the connection is still in progress, returns
330 stream_connect(struct stream
*stream
)
332 enum stream_state last_state
;
335 last_state
= stream
->state
;
336 switch (stream
->state
) {
338 scs_connecting(stream
);
344 case SCS_DISCONNECTED
:
345 return stream
->error
;
350 } while (stream
->state
!= last_state
);
355 /* Tries to receive up to 'n' bytes from 'stream' into 'buffer', and returns:
357 * - If successful, the number of bytes received (between 1 and 'n').
359 * - On error, a negative errno value.
361 * - 0, if the connection has been closed in the normal fashion, or if 'n'
364 * The recv function will not block waiting for a packet to arrive. If no
365 * data have been received, it returns -EAGAIN immediately. */
367 stream_recv(struct stream
*stream
, void *buffer
, size_t n
)
369 int retval
= stream_connect(stream
);
370 return (retval
? -retval
372 : (stream
->class->recv
)(stream
, buffer
, n
));
375 /* Tries to send up to 'n' bytes of 'buffer' on 'stream', and returns:
377 * - If successful, the number of bytes sent (between 1 and 'n'). 0 is
378 * only a valid return value if 'n' is 0.
380 * - On error, a negative errno value.
382 * The send function will not block. If no bytes can be immediately accepted
383 * for transmission, it returns -EAGAIN immediately. */
385 stream_send(struct stream
*stream
, const void *buffer
, size_t n
)
387 int retval
= stream_connect(stream
);
388 return (retval
? -retval
390 : (stream
->class->send
)(stream
, buffer
, n
));
393 /* Allows 'stream' to perform maintenance activities, such as flushing
396 stream_run(struct stream
*stream
)
398 if (stream
->class->run
) {
399 (stream
->class->run
)(stream
);
403 /* Arranges for the poll loop to wake up when 'stream' needs to perform
404 * maintenance activities. */
406 stream_run_wait(struct stream
*stream
)
408 if (stream
->class->run_wait
) {
409 (stream
->class->run_wait
)(stream
);
413 /* Arranges for the poll loop to wake up when 'stream' is ready to take an
414 * action of the given 'type'. */
416 stream_wait(struct stream
*stream
, enum stream_wait_type wait
)
418 ovs_assert(wait
== STREAM_CONNECT
|| wait
== STREAM_RECV
419 || wait
== STREAM_SEND
);
421 switch (stream
->state
) {
423 wait
= STREAM_CONNECT
;
426 case SCS_DISCONNECTED
:
427 poll_immediate_wake();
430 (stream
->class->wait
)(stream
, wait
);
434 stream_connect_wait(struct stream
*stream
)
436 stream_wait(stream
, STREAM_CONNECT
);
440 stream_recv_wait(struct stream
*stream
)
442 stream_wait(stream
, STREAM_RECV
);
446 stream_send_wait(struct stream
*stream
)
448 stream_wait(stream
, STREAM_SEND
);
452 stream_set_peer_id(struct stream
*stream
, const char *peer_id
)
454 free(stream
->peer_id
);
455 stream
->peer_id
= xstrdup(peer_id
);
459 stream_get_peer_id(const struct stream
*stream
)
461 return stream
->peer_id
;
464 /* Given 'name', a pstream name in the form "TYPE:ARGS", stores the class
465 * named "TYPE" into '*classp' and returns 0. Returns EAFNOSUPPORT and stores
466 * a null pointer into '*classp' if 'name' is in the wrong form or if no such
469 pstream_lookup_class(const char *name
, const struct pstream_class
**classp
)
474 check_stream_classes();
477 prefix_len
= strcspn(name
, ":");
478 if (name
[prefix_len
] == '\0') {
481 for (i
= 0; i
< ARRAY_SIZE(pstream_classes
); i
++) {
482 const struct pstream_class
*class = pstream_classes
[i
];
483 if (strlen(class->name
) == prefix_len
484 && !memcmp(class->name
, name
, prefix_len
)) {
492 /* Returns 0 if 'name' is a pstream name in the form "TYPE:ARGS" and TYPE is
493 * a supported pstream type, otherwise EAFNOSUPPORT. */
495 pstream_verify_name(const char *name
)
497 const struct pstream_class
*class;
498 return pstream_lookup_class(name
, &class);
501 /* Returns 1 if the stream or pstream specified by 'name' needs periodic probes
502 * to verify connectivity. For [p]streams which need probes, it can take a
503 * long time to notice the connection has been dropped. Returns 0 if the
504 * stream or pstream does not need probes, and -1 if 'name' is not valid. */
506 stream_or_pstream_needs_probes(const char *name
)
508 const struct pstream_class
*pclass
;
509 const struct stream_class
*class;
511 if (!stream_lookup_class(name
, &class)) {
512 return class->needs_probes
;
513 } else if (!pstream_lookup_class(name
, &pclass
)) {
514 return pclass
->needs_probes
;
520 /* Attempts to start listening for remote stream connections. 'name' is a
521 * connection name in the form "TYPE:ARGS", where TYPE is an passive stream
522 * class's name and ARGS are stream class-specific.
524 * Returns 0 if successful, otherwise a positive errno value. If successful,
525 * stores a pointer to the new connection in '*pstreamp', otherwise a null
528 pstream_open(const char *name
, struct pstream
**pstreamp
, uint8_t dscp
)
530 const struct pstream_class
*class;
531 struct pstream
*pstream
;
535 COVERAGE_INC(pstream_open
);
537 /* Look up the class. */
538 error
= pstream_lookup_class(name
, &class);
543 /* Call class's "open" function. */
544 suffix_copy
= xstrdup(strchr(name
, ':') + 1);
545 error
= class->listen(name
, suffix_copy
, &pstream
, dscp
);
560 /* Returns the name that was used to open 'pstream'. The caller must not
561 * modify or free the name. */
563 pstream_get_name(const struct pstream
*pstream
)
565 return pstream
->name
;
568 /* Closes 'pstream'. */
570 pstream_close(struct pstream
*pstream
)
572 if (pstream
!= NULL
) {
573 char *name
= pstream
->name
;
574 (pstream
->class->close
)(pstream
);
579 /* Tries to accept a new connection on 'pstream'. If successful, stores the
580 * new connection in '*new_stream' and returns 0. Otherwise, returns a
581 * positive errno value.
583 * pstream_accept() will not block waiting for a connection. If no connection
584 * is ready to be accepted, it returns EAGAIN immediately. */
586 pstream_accept(struct pstream
*pstream
, struct stream
**new_stream
)
588 int retval
= (pstream
->class->accept
)(pstream
, new_stream
);
592 ovs_assert((*new_stream
)->state
!= SCS_CONNECTING
593 || (*new_stream
)->class->connect
);
598 /* Tries to accept a new connection on 'pstream'. If successful, stores the
599 * new connection in '*new_stream' and returns 0. Otherwise, returns a
600 * positive errno value.
602 * pstream_accept_block() blocks until a connection is ready or until an error
603 * occurs. It will not return EAGAIN. */
605 pstream_accept_block(struct pstream
*pstream
, struct stream
**new_stream
)
610 while ((error
= pstream_accept(pstream
, new_stream
)) == EAGAIN
) {
611 pstream_wait(pstream
);
621 pstream_wait(struct pstream
*pstream
)
623 (pstream
->class->wait
)(pstream
);
626 /* Returns the transport port on which 'pstream' is listening, or 0 if the
627 * concept doesn't apply. */
629 pstream_get_bound_port(const struct pstream
*pstream
)
631 return pstream
->bound_port
;
634 /* Initializes 'stream' as a new stream named 'name', implemented via 'class'.
635 * The initial connection status, supplied as 'connect_status', is interpreted
638 * - 0: 'stream' is connected. Its 'send' and 'recv' functions may be
639 * called in the normal fashion.
641 * - EAGAIN: 'stream' is trying to complete a connection. Its 'connect'
642 * function should be called to complete the connection.
644 * - Other positive errno values indicate that the connection failed with
645 * the specified error.
647 * After calling this function, stream_close() must be used to destroy
648 * 'stream', otherwise resources will be leaked.
650 * Takes ownership of 'name'. */
652 stream_init(struct stream
*stream
, const struct stream_class
*class,
653 int connect_status
, char *name
)
655 memset(stream
, 0, sizeof *stream
);
656 stream
->class = class;
657 stream
->state
= (connect_status
== EAGAIN
? SCS_CONNECTING
658 : !connect_status
? SCS_CONNECTED
660 stream
->error
= connect_status
;
662 ovs_assert(stream
->state
!= SCS_CONNECTING
|| class->connect
);
665 /* Takes ownership of 'name'. */
667 pstream_init(struct pstream
*pstream
, const struct pstream_class
*class,
670 memset(pstream
, 0, sizeof *pstream
);
671 pstream
->class = class;
672 pstream
->name
= name
;
676 pstream_set_bound_port(struct pstream
*pstream
, ovs_be16 port
)
678 pstream
->bound_port
= port
;
682 count_fields(const char *s_
)
684 char *s
, *field
, *save_ptr
;
689 for (field
= strtok_r(s
, ":", &save_ptr
); field
!= NULL
;
690 field
= strtok_r(NULL
, ":", &save_ptr
)) {
698 /* Like stream_open(), but the port defaults to 'default_port' if no port
699 * number is given. */
701 stream_open_with_default_port(const char *name_
,
702 uint16_t default_port
,
703 struct stream
**streamp
,
709 if ((!strncmp(name_
, "tcp:", 4) || !strncmp(name_
, "ssl:", 4))
710 && count_fields(name_
) < 3) {
711 if (default_port
== OFP_PORT
) {
712 VLOG_WARN_ONCE("The default OpenFlow port number has changed "
714 OFP_OLD_PORT
, OFP_PORT
);
715 } else if (default_port
== OVSDB_PORT
) {
716 VLOG_WARN_ONCE("The default OVSDB port number has changed "
718 OVSDB_OLD_PORT
, OVSDB_PORT
);
720 name
= xasprintf("%s:%d", name_
, default_port
);
722 name
= xstrdup(name_
);
724 error
= stream_open(name
, streamp
, dscp
);
730 /* Like pstream_open(), but port defaults to 'default_port' if no port
731 * number is given. */
733 pstream_open_with_default_port(const char *name_
,
734 uint16_t default_port
,
735 struct pstream
**pstreamp
,
741 if ((!strncmp(name_
, "ptcp:", 5) || !strncmp(name_
, "pssl:", 5))
742 && count_fields(name_
) < 2) {
743 name
= xasprintf("%s%d", name_
, default_port
);
745 name
= xstrdup(name_
);
747 error
= pstream_open(name
, pstreamp
, dscp
);
754 * This function extracts IP address and port from the target string.
756 * - On success, function returns true and fills *ss structure with port
757 * and IP address. If port was absent in target string then it will use
758 * corresponding default port value.
759 * - On error, function returns false and *ss contains garbage.
762 stream_parse_target_with_default_port(const char *target
, int default_port
,
763 struct sockaddr_storage
*ss
)
765 return ((!strncmp(target
, "tcp:", 4) || !strncmp(target
, "ssl:", 4))
766 && inet_parse_active(target
+ 4, default_port
, ss
, true));
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
, 0 /* 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
));