1 # Copyright (c) 2011, 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.
16 util module contains some helper function
31 def str_ip(ip_address):
33 Converts an IP address from binary format to a string.
35 (x1, x2, x3, x4) = struct.unpack("BBBB", ip_address)
36 return ("%u.%u.%u.%u") % (x1, x2, x3, x4)
39 def get_interface_mtu(iface):
41 Returns MTU of the given interface.
43 s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
44 indata = iface + ('\0' * (32 - len(iface)))
46 outdata = fcntl.ioctl(s.fileno(), 0x8921, indata) # socket.SIOCGIFMTU
47 mtu = struct.unpack("16si12x", outdata)[1]
54 def get_interface(address):
56 Finds first interface that has given address
59 s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
60 names = array.array('B', '\0' * bytes)
61 outbytes = struct.unpack('iL', fcntl.ioctl(
64 struct.pack('iL', bytes, names.buffer_info()[0])
66 namestr = names.tostring()
68 for i in range(0, outbytes, 40):
69 name = namestr[i:i + 16].split('\0', 1)[0]
70 if address == str_ip(namestr[i + 20:i + 24]):
72 return None # did not find interface we were looking for
77 return os_info[2] # return only the kernel version number
80 def start_process(args):
82 p = subprocess.Popen(args,
83 stdin = subprocess.PIPE,
84 stdout = subprocess.PIPE,
85 stderr = subprocess.PIPE)
86 out, err = p.communicate()
87 return (p.returncode, out, err)
88 except exceptions.OSError:
89 return (-1, None, None)
92 def get_driver(iface):
93 ret, out, _err = start_process(["ethtool", "-i", iface])
95 lines = out.splitlines()
96 driver = "%s(%s)" % (lines[0], lines[1]) # driver name + version
102 def interface_up(iface):
104 This function brings given iface up.
106 ret, _out, _err = start_process(["ifconfig", iface, "up"])
110 def interface_assign_ip(iface, ip_addr, mask):
112 This function allows to assign IP address to an interface. If mask is an
113 empty string then ifconfig will decide what kind of mask to use. The
114 caller can also specify the mask by using CIDR notation in ip argument by
115 leaving the mask argument as an empty string. In case of success this
118 args = ["ifconfig", iface, ip_addr]
120 args.append("netmask")
122 ret, _out, _err = start_process(args)
126 def interface_get_ip(iface):
128 This function returns tuple - ip and mask that was assigned to the
131 args = ["ifconfig", iface]
132 ret, out, _err = start_process(args)
135 ip = re.search(r'inet addr:(\S+)', out)
136 mask = re.search(r'Mask:(\S+)', out)
137 if ip is not None and mask is not None:
138 return (ip.group(1), mask.group(1))
143 def move_routes(iface1, iface2):
145 This function moves routes from iface1 to iface2.
147 args = ["ip", "route", "show", "dev", iface1]
148 ret, out, _err = start_process(args)
150 for route in out.splitlines():
151 args = ["ip", "route", "replace", "dev", iface2] + route.split()
155 def get_interface_from_routing_decision(ip):
157 This function returns the interface through which the given ip address
160 args = ["ip", "route", "get", ip]
161 ret, out, _err = start_process(args)
163 iface = re.search(r'dev (\S+)', out)
165 return iface.group(1)
169 def rpc_client(ip, port):
170 return xmlrpclib.Server("http://%s:%u/" % (ip, port), allow_none=True)
173 def sigint_intercept():
175 Intercept SIGINT from child (the local ovs-test server process).
177 signal.signal(signal.SIGINT, signal.SIG_IGN)
180 def start_local_server(port):
182 This function spawns an ovs-test server that listens on specified port
183 and blocks till the spawned ovs-test server is ready to accept XML RPC
186 p = subprocess.Popen(["ovs-test", "-s", str(port)],
187 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
188 preexec_fn=sigint_intercept)
189 fcntl.fcntl( p.stdout.fileno(),fcntl.F_SETFL,
190 fcntl.fcntl(p.stdout.fileno(), fcntl.F_GETFL) | os.O_NONBLOCK)
192 while p.poll() is None:
193 fd = select.select([p.stdout.fileno()], [], [])[0]
195 out = p.stdout.readline()
196 if out.startswith("Starting RPC server"):
198 if p.poll() is not None:
199 raise RuntimeError("Couldn't start local instance of ovs-test server")
203 def get_datagram_sizes(mtu1, mtu2):
205 This function calculates all the "interesting" datagram sizes so that
206 we test both - receive and send side with different packets sizes.
208 s1 = set([8, mtu1 - 100, mtu1 - 28, mtu1])
209 s2 = set([8, mtu2 - 100, mtu2 - 28, mtu2])
210 return sorted(s1.union(s2))
213 def ip_from_cidr(string):
215 This function removes the netmask (if present) from the given string and
216 returns the IP address.
218 token = string.split("/")
222 def bandwidth_to_string(bwidth):
223 """Convert bandwidth from long to string and add units."""
224 bwidth = bwidth * 8 # Convert back to bits/second
225 if bwidth >= 10000000:
226 return str(int(bwidth / 1000000)) + "Mbps"
228 return str(int(bwidth / 1000)) + "Kbps"
230 return str(int(bwidth)) + "bps"