1 # Copyright (c) 2010, 2012 Nicira, Inc.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at:
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
21 import ovs.fatal_signal
25 vlog = ovs.vlog.Vlog("socket_util")
28 def make_unix_socket(style, nonblock, bind_path, connect_path):
29 """Creates a Unix domain socket in the given 'style' (either
30 socket.SOCK_DGRAM or socket.SOCK_STREAM) that is bound to 'bind_path' (if
31 'bind_path' is not None) and connected to 'connect_path' (if 'connect_path'
32 is not None). If 'nonblock' is true, the socket is made non-blocking.
34 Returns (error, socket): on success 'error' is 0 and 'socket' is a new
35 socket object, on failure 'error' is a positive errno value and 'socket' is
39 sock = socket.socket(socket.AF_UNIX, style)
40 except socket.error, e:
41 return get_exception_errno(e), None
46 if bind_path is not None:
47 # Delete bind_path but ignore ENOENT.
51 if e.errno != errno.ENOENT:
54 ovs.fatal_signal.add_file_to_unlink(bind_path)
58 if sys.hexversion >= 0x02060000:
59 os.fchmod(sock.fileno(), 0700)
61 os.chmod("/dev/fd/%d" % sock.fileno(), 0700)
64 if connect_path is not None:
66 sock.connect(connect_path)
67 except socket.error, e:
68 if get_exception_errno(e) != errno.EINPROGRESS:
71 except socket.error, e:
73 if bind_path is not None:
74 ovs.fatal_signal.unlink_file_now(bind_path)
75 return get_exception_errno(e), None
78 def check_connection_completion(sock):
79 p = ovs.poller.SelectPoll()
80 p.register(sock, select.POLLOUT)
81 if len(p.poll(0)) == 1:
82 return get_socket_error(sock)
87 def inet_parse_active(target, default_port):
88 address = target.split(":")
89 host_name = address[0]
91 raise ValueError("%s: bad peer name format" % target)
93 port = int(address[1])
97 raise ValueError("%s: port number must be specified" % target)
98 return (host_name, port)
101 def inet_open_active(style, target, default_port, dscp):
102 address = inet_parse_active(target, default_port)
104 sock = socket.socket(socket.AF_INET, style, 0)
105 except socket.error, e:
106 return get_exception_errno(e), None
109 set_nonblocking(sock)
112 sock.connect(address)
113 except socket.error, e:
114 if get_exception_errno(e) != errno.EINPROGRESS:
117 except socket.error, e:
119 return get_exception_errno(e), None
122 def get_socket_error(sock):
123 """Returns the errno value associated with 'socket' (0 if no error) and
124 resets the socket's error status."""
125 return sock.getsockopt(socket.SOL_SOCKET, socket.SO_ERROR)
128 def get_exception_errno(e):
129 """A lot of methods on Python socket objects raise socket.error, but that
130 exception is documented as having two completely different forms of
131 arguments: either a string or a (errno, string) tuple. We only want the
133 if type(e.args) == tuple:
143 """Returns a readable and writable fd for /dev/null, if successful,
144 otherwise a negative errno value. The caller must not close the returned
145 fd (because the same fd will be handed out to subsequent callers)."""
149 null_fd = os.open("/dev/null", os.O_RDWR)
151 vlog.err("could not open /dev/null: %s" % os.strerror(e.errno))
156 def write_fully(fd, buf):
157 """Returns an (error, bytes_written) tuple where 'error' is 0 on success,
158 otherwise a positive errno value, and 'bytes_written' is the number of
159 bytes that were written before the error occurred. 'error' is 0 if and
160 only if 'bytes_written' is len(buf)."""
166 retval = os.write(fd, buf)
168 if retval == len(buf):
169 return 0, bytes_written + len(buf)
171 vlog.warn("write returned 0")
172 return errno.EPROTO, bytes_written
174 bytes_written += retval
177 return e.errno, bytes_written
180 def set_nonblocking(sock):
183 except socket.error, e:
184 vlog.err("could not set nonblocking mode on socket: %s"
185 % os.strerror(get_socket_error(e)))
188 def set_dscp(sock, dscp):
190 raise ValueError("Invalid dscp %d" % dscp)
192 sock.setsockopt(socket.IPPROTO_IP, socket.IP_TOS, val)