class IT:
def __init__(self):
self.hook = Hook(Vector(250, 250))
self.line = Line(200, (251, 100), 2, self.hook)
self.length = math.sqrt((self.line.begin[0] - self.line.end[0]) *
(self.line.begin[0] - self.line.end[0]) +
(self.line.begin[1] - self.line.end[1]) *
(self.line.begin[1] - self.line.end[1]))
def draw(self, canvas):
self.iteration()
self.hook.update()
self.hook.draw(canvas)
self.line.draw_line(canvas)
def addspeed(self):
self.hook.vel = Vector(0, 1)
def subtractspeed(self):
self.hook.vel = Vector(0, -1)
def iteration(self):
if self.length <= 20:
self.addspeed()
if self.length >= 100:
self.subtractspeed()
def __init__(self,
ring_min=RING_MIN,
ring_max=RING_MAX,
ring_on=RING_ON,
ring_off=RING_OFF,
ringer_pin=RINGER_PIN,
hook_pin=HOOK_PIN,
dial_tone_file=DIAL_TONE_FILE,
audio_directory=AUDIO_DIRECTORY):
self.ring_on = ring_on
self.ring_off = ring_off
self.ring_min = ring_min
self.ring_max = ring_max
self.ringer_pin = ringer_pin
self.hook_pin = hook_pin
self.audio_directory = audio_directory
self.dial_tone_file = dial_tone_file
Ringer.__init__(self, self.ring_on, self.ring_off, self.ringer_pin)
Hook.__init__(self, self.hook_pin)
DialTone.__init__(self, self.dial_tone_file)
RandomAudio.__init__(self, self.audio_directory)
self.state = SILENCE
GPIO.setup(self.hook_pin, GPIO.IN, pull_up_down=GPIO.PUD_UP)
def __init__(self):
# pygame.init is used to deploy the background
pygame.init()
# self.screen will display a window with 1200 by 700 screen size
self.settings = Settings(self)
self.screen = pygame.display.set_mode(
(self.settings.screen_width, self.settings.screen_height))
self.screen_rect = self.screen.get_rect()
# bg_colour will give a background colour
self.bg_colour = self.settings.bg_colour
# self.captions will create a title at the top of the window
pygame.display.set_caption('Blue Sky')
self.fish = Fish(self)
self.seaweeds = pygame.sprite.Group()
self.worms = pygame.sprite.Group()
self.hook = Hook(self)
self.line = Line(self)
self.stats = GameStats(self)
self._create_fleet()
self._create_worms()
self.clock = pygame.time.Clock()
self.counter = 0
pygame.time.set_timer(pygame.USEREVENT, 1000)
self.play = Button(self, 'Play')
self.sb = Score(self)
def _discover(self):
'''Create lists of all plugins present'''
# TODO non-hook plugins
# find user hooks
self._plugins_user = {}
for uhook in self._get_executables(
os.path.join(os.getenv('HOME'), '.disper', 'hooks')):
name = os.path.splitext(os.path.split(uhook)[1])[0]
self._plugins_user[name] = Hook(self.disper, uhook)
self.log.info('Available user hooks: ' + ', '.join(self._plugins_user))
# find system hooks
self._plugins_system = {}
for uhook in self._get_executables(
os.path.join(self.disper.prefix_share, 'hooks')):
name = os.path.splitext(os.path.split(uhook)[1])[0]
self._plugins_system[name] = Hook(self.disper, uhook)
self.log.info('Available system hooks: ' +
', '.join(self._plugins_user))
# Now create global list of plugins where user plugins get precedence
self._plugins = {}
for i in self._plugins_system:
self._plugins[i] = self._plugins_system[i]
for i in self._plugins_user:
self._plugins[i] = self._plugins_user[i]
def __init__(self):
self.hook = Hook(Vector(250, 250))
self.line = Line(200, (251, 100), 2, self.hook)
self.length = math.sqrt((self.line.begin[0] - self.line.end[0]) *
(self.line.begin[0] - self.line.end[0]) +
(self.line.begin[1] - self.line.end[1]) *
(self.line.begin[1] - self.line.end[1]))
def __init__(self, name, shm_prefix, test_class):
self.hook = Hook("vpp-papi-provider")
self.name = name
self.shm_prefix = shm_prefix
self.test_class = test_class
jsonfiles = []
install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
for root, dirnames, filenames in os.walk(install_dir):
for filename in fnmatch.filter(filenames, '*.api.json'):
jsonfiles.append(os.path.join(root, filename))
self.papi = VPP(jsonfiles)
self._events = deque()
def __init__(self, name, test_class, read_timeout):
self.hook = Hook(test_class)
self.name = name
self.test_class = test_class
self._expect_api_retval = self._zero
self._expect_stack = []
# install_dir is a class attribute. We need to set it before
# calling the constructor.
VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
self.vpp = VPPApiClient(logger=test_class.logger,
read_timeout=read_timeout,
use_socket=True,
server_address=test_class.get_api_sock_path())
self._events = queue.Queue()
def __init__(self):
self.lock = Lock()
self.ringer = Ringer(5)
self.hook = Hook(22, self)
self.sipClient = SipClient(self)
self.dialplate = Dialplate(17, 27, self)
self.number = ""
self.dialTimer = None
def __init__(self, name, shm_prefix, test_class, read_timeout):
self.hook = Hook("vpp-papi-provider")
self.name = name
self.shm_prefix = shm_prefix
self.test_class = test_class
self._expect_api_retval = self._zero
self._expect_stack = []
jsonfiles = []
install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
for root, dirnames, filenames in os.walk(install_dir):
for filename in fnmatch.filter(filenames, '*.api.json'):
jsonfiles.append(os.path.join(root, filename))
self.vpp = VPP(jsonfiles, logger=test_class.logger,
read_timeout=read_timeout)
self._events = deque()
async def on_message(message: discord.Message):
if message.author.bot or message.author.id in config.get_global(
"user_blacklist"):
return
if (isinstance(message.channel, discord.DMChannel)
or isinstance(message.channel, discord.GroupChannel) or
message.channel.permissions_for(message.guild.me).send_messages):
prefix = config.get_prefix(message.guild)
if message.content.startswith(prefix):
if not initialised:
await message.channel.send(
"I've only just woken up, give me a second please!")
return
command = message.content[len(prefix):].split(
" ")[0].lower() # just command text
args = message.content[len(prefix) + len(command) + 1:]
if Hook.exists("public!" +
command) and util.check_command_permissions(
message, "public"):
await Hook.get("public!" + command)(message, args)
elif Hook.exists("admin!" +
command) and util.check_command_permissions(
message, "admin"):
await Hook.get("admin!" + command)(message, args)
elif Hook.exists("owner!" +
command) and util.check_command_permissions(
message, "owner"):
await Hook.get("owner!" + command)(message, args)
else:
await message.channel.send(
"I don't know that command, sorry! Use the `help` command for a list of commands."
)
else:
if not initialised:
return
await Hook.get("on_message")(message)
if discord.utils.find(lambda m: m.id == client.user.id,
message.mentions) is not None:
await Hook.get("on_mention")(message)
if isinstance(message.channel, discord.abc.PrivateChannel):
await Hook.get("on_message_private")(message)
def init_game():
pygame.init()
game_settings = Settings()
screen = pygame.display.set_mode(
(game_settings.screen_width, game_settings.screen_height),
pygame.FULLSCREEN)
# screen = pygame.display.set_mode((game_settings.screen_width, game_settings.screen_height))
ship = Ship(screen)
stats = GameStats(game_settings)
friend = Friend(screen)
enemy = Enemy(screen)
enemy_2 = Enemy_2(screen)
enemy_3 = Enemy_3(screen)
enemy_4 = Enemy_4(screen)
enemy_5 = Enemy_5(screen)
enemy_6 = Enemy_6(screen)
enemy_7 = Enemy_7(screen)
enemy_8 = Enemy_8(screen)
enemy_9 = Enemy_9(screen)
hook = Hook(screen)
background = Background(screen)
pygame.display.set_caption("Peter Pan")
bullets = Group()
enemies = Group()
enemies.add(enemy, enemy_2, enemy_3, enemy_4, enemy_5, enemy_6, enemy_7,
enemy_8, enemy_9, hook)
friends = Group()
friends.add(friend)
ships = Group()
ships.add(ship)
#g_f.create_fleet(game_settings, screen, ship)
button = Button(screen, game_settings, "Play")
sb = Scoreboard(game_settings, screen, stats)
while True:
g_f.chek_events(game_settings, ship, screen, bullets, button, stats,
enemies, sb)
g_f.update_screen(background, ships, bullets, enemies, screen, button,
friends, stats, sb)
if stats.game_active:
g_f.update_bullets(bullets, enemies, ships, friends, hook, stats,
sb, screen)
g_f.aliens_move(enemies, screen, friends, ships, bullets, ship)
ship.update()
ship.blitme()
def hook(self, request, hookName):
try:
logger.info("Hook called: " + hookName)
#make sure json is valid and unprettified
body = json.dumps(json.loads(request.content.read()))
H = Hook(hookName, body)
result = yield H.d
returnValue(result)
except ValueError, e:
logger.error(hookName + " Called with invalid JSON")
logger.debug(e)
raise NotFound()
def __init__(self, name, shm_prefix, test_class, read_timeout):
self.hook = Hook(test_class)
self.name = name
self.shm_prefix = shm_prefix
self.test_class = test_class
self._expect_api_retval = self._zero
self._expect_stack = []
# install_dir is a class attribute. We need to set it before
# calling the constructor.
VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
use_socket = False
try:
if os.environ['SOCKET'] == '1':
use_socket = True
except KeyError:
pass
self.vpp = VPPApiClient(logger=test_class.logger,
read_timeout=read_timeout,
use_socket=use_socket,
server_address=test_class.api_sock)
self._events = deque()
def _load_hooks(self, plugin, name, filters: str = None):
self.log.debug(f"Loading {name}'s hooks" +
(f" Filtered to {filters}" if filters else ""))
for func in plugin.__dict__.values():
# self.log.debug(f"checking {func} in {plugin}")
if not hasattr(func, "_IsHook"):
continue
hooks = getattr(func, "_IsHook")
for hook, perm in hooks:
if filters is not None and not fnmatch(hook, filters):
self.log.debug(
f"SKIPPING {hook}: {func}, does not match filter ('{filters}'): '{hook}''"
)
continue
self.log(f"loading new hook {hook}: {func}" +
(f" Hook requested {perm}" if perm else ""))
self.hooks[hook].append(Hook(name, func, perm))
delattr(func, "_IsHook")
def __init__(self, name, shm_prefix):
self.hook = Hook("vpp-papi-provider")
self.name = name
self.shm_prefix = shm_prefix
class VppPapiProvider(object):
"""VPP-api provider using vpp-papi
@property hook: hook object providing before and after api/cli hooks
"""
_zero, _negative = range(2)
def __init__(self, name, test_class, read_timeout):
self.hook = Hook(test_class)
self.name = name
self.test_class = test_class
self._expect_api_retval = self._zero
self._expect_stack = []
# install_dir is a class attribute. We need to set it before
# calling the constructor.
VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
self.vpp = VPPApiClient(logger=test_class.logger,
read_timeout=read_timeout,
use_socket=True,
server_address=test_class.get_api_sock_path())
self._events = queue.Queue()
def __enter__(self):
return self
def assert_negative_api_retval(self):
""" Expect API failure - used with with, e.g.:
with self.vapi.assert_negative_api_retval():
self.vapi.<api call expected to fail>
"""
self._expect_stack.append(self._expect_api_retval)
self._expect_api_retval = self._negative
return self
def assert_zero_api_retval(self):
""" Expect API success - used with with, e.g.:
with self.vapi.assert_negative_api_retval():
self.vapi.<api call expected to succeed>
note: this is useful only inside another with block
as success is the default expected value
"""
self._expect_stack.append(self._expect_api_retval)
self._expect_api_retval = self._zero
return self
def __exit__(self, exc_type, exc_value, traceback):
self._expect_api_retval = self._expect_stack.pop()
def register_hook(self, hook):
"""Replace hook registration with new hook
:param hook:
"""
self.hook = hook
def collect_events(self):
""" Collect all events from the internal queue and clear the queue. """
result = []
while True:
try:
e = self._events.get(block=False)
result.append(e)
except queue.Empty:
return result
return result
def wait_for_event(self, timeout, name=None):
""" Wait for and return next event. """
if name:
self.test_class.logger.debug("Expecting event '%s' within %ss",
name, timeout)
else:
self.test_class.logger.debug("Expecting event within %ss", timeout)
try:
e = self._events.get(timeout=timeout)
except queue.Empty:
raise Exception("Event did not occur within timeout")
msgname = type(e).__name__
if name and msgname != name:
raise Exception("Unexpected event received: %s, expected: %s" %
msgname)
self.test_class.logger.debug("Returning event %s:%s" % (name, e))
return e
def __call__(self, name, event):
""" Enqueue event in the internal event queue. """
self.test_class.logger.debug("New event: %s: %s" % (name, event))
self._events.put(event)
def factory(self, name, apifn):
def f(*a, **ka):
fields = apifn._func.msg.fields
# add positional and kw arguments
d = ka
for i, o in enumerate(fields[3:]):
try:
d[o] = a[i]
except BaseException:
break
# Default override
if name in defaultmapping:
for k, v in iteritems(defaultmapping[name]):
if k in d:
continue
d[k] = v
return self.api(apifn, d)
return f
def __getattribute__(self, name):
try:
method = super(VppPapiProvider, self).__getattribute__(name)
except AttributeError:
method = self.factory(name, getattr(self.papi, name))
# lazily load the method so we don't need to call factory
# again for this name.
setattr(self, name, method)
return method
def connect(self):
"""Connect the API to VPP"""
# This might be called before VPP is prepared to listen to the socket
retries = 0
while not os.path.exists(self.test_class.get_api_sock_path()):
time.sleep(0.5)
retries += 1
if retries > 120:
break
self.vpp.connect(self.name[:63])
self.papi = self.vpp.api
self.vpp.register_event_callback(self)
def disconnect(self):
"""Disconnect the API from VPP"""
self.vpp.disconnect()
def api(self, api_fn, api_args, expected_retval=0):
""" Call API function and check it's return value.
Call the appropriate hooks before and after the API call
:param api_fn: API function to call
:param api_args: tuple of API function arguments
:param expected_retval: Expected return value (Default value = 0)
:returns: reply from the API
"""
self.hook.before_api(api_fn.__name__, api_args)
reply = api_fn(**api_args)
if self._expect_api_retval == self._negative:
if hasattr(reply, 'retval') and reply.retval >= 0:
msg = "%s(%s) passed unexpectedly: expected negative " \
"return value instead of %d in %s" % \
(api_fn.__name__, as_fn_signature(api_args),
reply.retval,
moves.reprlib.repr(reply))
self.test_class.logger.info(msg)
raise UnexpectedApiReturnValueError(msg)
elif self._expect_api_retval == self._zero:
if hasattr(reply, 'retval') and reply.retval != expected_retval:
msg = "%s(%s) failed, expected %d return value instead " \
"of %d in %s" % (api_fn.__name__,
as_fn_signature(api_args),
expected_retval, reply.retval,
repr(reply))
self.test_class.logger.info(msg)
raise UnexpectedApiReturnValueError(msg)
else:
raise Exception("Internal error, unexpected value for "
"self._expect_api_retval %s" %
self._expect_api_retval)
self.hook.after_api(api_fn.__name__, api_args)
return reply
def cli_return_response(self, cli):
""" Execute a CLI, calling the before/after hooks appropriately.
Return the reply without examining it
:param cli: CLI to execute
:returns: response object
"""
self.hook.before_cli(cli)
cli += '\n'
r = self.papi.cli_inband(cmd=cli)
self.hook.after_cli(cli)
return r
def cli(self, cli):
""" Execute a CLI, calling the before/after hooks appropriately.
:param cli: CLI to execute
:returns: CLI output
"""
r = self.cli_return_response(cli)
if r.retval == -156:
raise CliSyntaxError(r.reply)
if r.retval != 0:
raise CliFailedCommandError(r.reply)
if hasattr(r, 'reply'):
return r.reply
def ppcli(self, cli):
""" Helper method to print CLI command in case of info logging level.
:param cli: CLI to execute
:returns: CLI output
"""
return cli + "\n" + self.cli(cli)
def ip6nd_send_router_solicitation(self,
sw_if_index,
irt=1,
mrt=120,
mrc=0,
mrd=0):
return self.api(
self.papi.ip6nd_send_router_solicitation, {
'irt': irt,
'mrt': mrt,
'mrc': mrc,
'mrd': mrd,
'sw_if_index': sw_if_index
})
def want_interface_events(self, enable_disable=1):
return self.api(self.papi.want_interface_events, {
'enable_disable': enable_disable,
'pid': os.getpid(),
})
def sw_interface_set_mac_address(self, sw_if_index, mac):
return self.api(self.papi.sw_interface_set_mac_address, {
'sw_if_index': sw_if_index,
'mac_address': mac
})
def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
"""Create p2p ethernet subinterface
:param sw_if_index: main (parent) interface
:param remote_mac: client (remote) mac address
"""
return self.api(
self.papi.p2p_ethernet_add, {
'parent_if_index': sw_if_index,
'remote_mac': remote_mac,
'subif_id': subif_id
})
def p2p_ethernet_del(self, sw_if_index, remote_mac):
"""Delete p2p ethernet subinterface
:param sw_if_index: main (parent) interface
:param remote_mac: client (remote) mac address
"""
return self.api(self.papi.p2p_ethernet_del, {
'parent_if_index': sw_if_index,
'remote_mac': remote_mac
})
def create_vlan_subif(self, sw_if_index, vlan):
"""
:param vlan:
:param sw_if_index:
"""
return self.api(self.papi.create_vlan_subif, {
'sw_if_index': sw_if_index,
'vlan_id': vlan
})
def create_loopback(self, mac=''):
"""
:param mac: (Optional)
"""
return self.api(self.papi.create_loopback, {'mac_address': mac})
def ip_route_dump(self, table_id, is_ip6=False):
return self.api(self.papi.ip_route_dump,
{'table': {
'table_id': table_id,
'is_ip6': is_ip6
}})
def ip_route_v2_dump(self, table_id, is_ip6=False, src=0):
return self.api(self.papi.ip_route_v2_dump, {
'src': src,
'table': {
'table_id': table_id,
'is_ip6': is_ip6
}
})
def ip_neighbor_add_del(self,
sw_if_index,
mac_address,
ip_address,
is_add=1,
flags=0):
""" Add neighbor MAC to IPv4 or IPv6 address.
:param sw_if_index:
:param mac_address:
:param dst_address:
:param is_add: (Default value = 1)
:param flags: (Default value = 0/NONE)
"""
return self.api(
self.papi.ip_neighbor_add_del, {
'is_add': is_add,
'neighbor': {
'sw_if_index': sw_if_index,
'flags': flags,
'mac_address': mac_address,
'ip_address': ip_address
}
})
def udp_encap_add(self, src_ip, dst_ip, src_port, dst_port, table_id=0):
""" Add a GRE tunnel
:param src_ip:
:param dst_ip:
:param src_port:
:param dst_port:
:param outer_fib_id: (Default value = 0)
"""
return self.api(
self.papi.udp_encap_add, {
'udp_encap': {
'src_ip': src_ip,
'dst_ip': dst_ip,
'src_port': src_port,
'dst_port': dst_port,
'table_id': table_id
}
})
def udp_encap_del(self, id):
return self.api(self.papi.udp_encap_del, {'id': id})
def udp_encap_dump(self):
return self.api(self.papi.udp_encap_dump, {})
def want_udp_encap_stats(self, enable=1):
return self.api(self.papi.want_udp_encap_stats, {
'enable': enable,
'pid': os.getpid()
})
def mpls_route_dump(self, table_id):
return self.api(self.papi.mpls_route_dump,
{'table': {
'mt_table_id': table_id
}})
def mpls_table_dump(self):
return self.api(self.papi.mpls_table_dump, {})
def mpls_table_add_del(self, table_id, is_add=1):
"""
:param table_id
:param is_add: (Default value = 1)
"""
return self.api(self.papi.mpls_table_add_del, {
'mt_table': {
'mt_table_id': table_id,
},
'mt_is_add': is_add
})
def mpls_route_add_del(self, table_id, label, eos, eos_proto, is_multicast,
paths, is_add, is_multipath):
""" MPLS Route add/del """
return self.api(
self.papi.mpls_route_add_del, {
'mr_route': {
'mr_table_id': table_id,
'mr_label': label,
'mr_eos': eos,
'mr_eos_proto': eos_proto,
'mr_is_multicast': is_multicast,
'mr_n_paths': len(paths),
'mr_paths': paths,
},
'mr_is_add': is_add,
'mr_is_multipath': is_multipath
})
def mpls_ip_bind_unbind(self,
label,
prefix,
table_id=0,
ip_table_id=0,
is_bind=1):
"""
"""
return self.api(
self.papi.mpls_ip_bind_unbind, {
'mb_mpls_table_id': table_id,
'mb_label': label,
'mb_ip_table_id': ip_table_id,
'mb_is_bind': is_bind,
'mb_prefix': prefix
})
def mpls_tunnel_add_del(self,
tun_sw_if_index,
paths,
is_add=1,
l2_only=0,
is_multicast=0):
"""
"""
return self.api(
self.papi.mpls_tunnel_add_del, {
'mt_is_add': is_add,
'mt_tunnel': {
'mt_sw_if_index': tun_sw_if_index,
'mt_l2_only': l2_only,
'mt_is_multicast': is_multicast,
'mt_n_paths': len(paths),
'mt_paths': paths,
}
})
def input_acl_set_interface(self,
is_add,
sw_if_index,
ip4_table_index=0xFFFFFFFF,
ip6_table_index=0xFFFFFFFF,
l2_table_index=0xFFFFFFFF):
"""
:param is_add:
:param sw_if_index:
:param ip4_table_index: (Default value = 0xFFFFFFFF)
:param ip6_table_index: (Default value = 0xFFFFFFFF)
:param l2_table_index: (Default value = 0xFFFFFFFF)
"""
return self.api(
self.papi.input_acl_set_interface, {
'sw_if_index': sw_if_index,
'ip4_table_index': ip4_table_index,
'ip6_table_index': ip6_table_index,
'l2_table_index': l2_table_index,
'is_add': is_add
})
def output_acl_set_interface(self,
is_add,
sw_if_index,
ip4_table_index=0xFFFFFFFF,
ip6_table_index=0xFFFFFFFF,
l2_table_index=0xFFFFFFFF):
"""
:param is_add:
:param sw_if_index:
:param ip4_table_index: (Default value = 0xFFFFFFFF)
:param ip6_table_index: (Default value = 0xFFFFFFFF)
:param l2_table_index: (Default value = 0xFFFFFFFF)
"""
return self.api(
self.papi.output_acl_set_interface, {
'sw_if_index': sw_if_index,
'ip4_table_index': ip4_table_index,
'ip6_table_index': ip6_table_index,
'l2_table_index': l2_table_index,
'is_add': is_add
})
def set_ipfix_exporter(self,
collector_address,
src_address,
path_mtu,
template_interval,
vrf_id=0,
collector_port=4739,
udp_checksum=0):
return self.api(
self.papi.set_ipfix_exporter, {
'collector_address': collector_address,
'collector_port': collector_port,
'src_address': src_address,
'vrf_id': vrf_id,
'path_mtu': path_mtu,
'template_interval': template_interval,
'udp_checksum': udp_checksum,
})
def mfib_signal_dump(self):
return self.api(self.papi.mfib_signal_dump, {})
def ip_mroute_dump(self, table_id, is_ip6=False):
return self.api(self.papi.ip_mroute_dump,
{'table': {
'table_id': table_id,
'is_ip6': is_ip6
}})
def vxlan_gpe_add_del_tunnel(self,
src_addr,
dst_addr,
mcast_sw_if_index=0xFFFFFFFF,
is_add=1,
is_ipv6=0,
encap_vrf_id=0,
decap_vrf_id=0,
protocol=3,
vni=0):
"""
:param local:
:param remote:
:param is_add: (Default value = 1)
:param is_ipv6: (Default value = 0)
:param encap_vrf_id: (Default value = 0)
:param decap_vrf_id: (Default value = 0)
:param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
:param protocol: (Default value = 3)
:param vni: (Default value = 0)
"""
return self.api(
self.papi.vxlan_gpe_add_del_tunnel, {
'is_add': is_add,
'is_ipv6': is_ipv6,
'local': src_addr,
'remote': dst_addr,
'mcast_sw_if_index': mcast_sw_if_index,
'encap_vrf_id': encap_vrf_id,
'decap_vrf_id': decap_vrf_id,
'protocol': protocol,
'vni': vni
})
def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
return self.api(self.papi.vxlan_gbp_tunnel_dump,
{'sw_if_index': sw_if_index})
def pppoe_add_del_session(self,
client_ip,
client_mac,
session_id=0,
is_add=1,
decap_vrf_id=0):
"""
:param is_add: (Default value = 1)
:param is_ipv6: (Default value = 0)
:param client_ip:
:param session_id: (Default value = 0)
:param client_mac:
:param decap_vrf_id: (Default value = 0)
"""
return self.api(
self.papi.pppoe_add_del_session, {
'is_add': is_add,
'session_id': session_id,
'client_ip': client_ip,
'decap_vrf_id': decap_vrf_id,
'client_mac': client_mac
})
def sr_mpls_policy_add(self, bsid, weight, type, segments):
return self.api(
self.papi.sr_mpls_policy_add, {
'bsid': bsid,
'weight': weight,
'is_spray': type,
'n_segments': len(segments),
'segments': segments
})
def sr_mpls_policy_del(self, bsid):
return self.api(self.papi.sr_mpls_policy_del, {'bsid': bsid})
def bier_table_add_del(self, bti, mpls_label, is_add=1):
""" BIER Table add/del """
return self.api(
self.papi.bier_table_add_del, {
'bt_tbl_id': {
"bt_set": bti.set_id,
"bt_sub_domain": bti.sub_domain_id,
"bt_hdr_len_id": bti.hdr_len_id
},
'bt_label': mpls_label,
'bt_is_add': is_add
})
def bier_table_dump(self):
return self.api(self.papi.bier_table_dump, {})
def bier_route_add_del(self, bti, bp, paths, is_add=1, is_replace=0):
""" BIER Route add/del """
return self.api(
self.papi.bier_route_add_del, {
'br_route': {
'br_tbl_id': {
"bt_set": bti.set_id,
"bt_sub_domain": bti.sub_domain_id,
"bt_hdr_len_id": bti.hdr_len_id
},
'br_bp': bp,
'br_n_paths': len(paths),
'br_paths': paths,
},
'br_is_add': is_add,
'br_is_replace': is_replace
})
def bier_route_dump(self, bti):
return self.api(
self.papi.bier_route_dump, {
'br_tbl_id': {
"bt_set": bti.set_id,
"bt_sub_domain": bti.sub_domain_id,
"bt_hdr_len_id": bti.hdr_len_id
}
})
def bier_imp_add(self, bti, src, ibytes, is_add=1):
""" BIER Imposition Add """
return self.api(
self.papi.bier_imp_add, {
'bi_tbl_id': {
"bt_set": bti.set_id,
"bt_sub_domain": bti.sub_domain_id,
"bt_hdr_len_id": bti.hdr_len_id
},
'bi_src': src,
'bi_n_bytes': len(ibytes),
'bi_bytes': ibytes
})
def bier_imp_del(self, bi_index):
""" BIER Imposition del """
return self.api(self.papi.bier_imp_del, {'bi_index': bi_index})
def bier_imp_dump(self):
return self.api(self.papi.bier_imp_dump, {})
def bier_disp_table_add_del(self, bdti, is_add=1):
""" BIER Disposition Table add/del """
return self.api(self.papi.bier_disp_table_add_del, {
'bdt_tbl_id': bdti,
'bdt_is_add': is_add
})
def bier_disp_table_dump(self):
return self.api(self.papi.bier_disp_table_dump, {})
def bier_disp_entry_add_del(self,
bdti,
bp,
payload_proto,
next_hop_afi,
next_hop,
next_hop_tbl_id=0,
next_hop_rpf_id=~0,
next_hop_is_ip4=1,
is_add=1):
""" BIER Route add/del """
lstack = []
while (len(lstack) < 16):
lstack.append({})
return self.api(
self.papi.bier_disp_entry_add_del, {
'bde_tbl_id':
bdti,
'bde_bp':
bp,
'bde_payload_proto':
payload_proto,
'bde_n_paths':
1,
'bde_paths': [{
'table_id': next_hop_tbl_id,
'rpf_id': next_hop_rpf_id,
'n_labels': 0,
'label_stack': lstack
}],
'bde_is_add':
is_add
})
def bier_disp_entry_dump(self, bdti):
return self.api(self.papi.bier_disp_entry_dump, {'bde_tbl_id': bdti})
def ipsec_spd_add_del(self, spd_id, is_add=1):
""" SPD add/del - Wrapper to add or del ipsec SPD
Sample CLI : 'ipsec spd add 1'
:param spd_id - SPD ID to be created in the vpp . mandatory
:param is_add - create (1) or delete(0) SPD (Default 1 - add) .
optional
:returns: reply from the API
"""
return self.api(self.papi.ipsec_spd_add_del, {
'spd_id': spd_id,
'is_add': is_add
})
def ipsec_spds_dump(self):
return self.api(self.papi.ipsec_spds_dump, {})
def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
""" IPSEC interface SPD add/del - \
Wrapper to associate/disassociate SPD to interface in VPP
Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
:param spd_id - SPD ID to associate with the interface . mandatory
:param sw_if_index - Interface Index which needs to ipsec \
association mandatory
:param is_add - add(1) or del(0) association with interface \
(Default 1 - add) . optional
:returns: reply from the API
"""
return self.api(self.papi.ipsec_interface_add_del_spd, {
'spd_id': spd_id,
'sw_if_index': sw_if_index,
'is_add': is_add
})
def ipsec_spd_interface_dump(self, spd_index=None):
return self.api(
self.papi.ipsec_spd_interface_dump, {
'spd_index': spd_index if spd_index else 0,
'spd_index_valid': 1 if spd_index else 0
})
def ipsec_spd_entry_add_del(self,
spd_id,
sa_id,
local_address_start,
local_address_stop,
remote_address_start,
remote_address_stop,
local_port_start=0,
local_port_stop=65535,
remote_port_start=0,
remote_port_stop=65535,
protocol=0,
policy=0,
priority=100,
is_outbound=1,
is_add=1,
is_ipv6=0,
is_ip_any=0):
""" IPSEC policy SPD add/del -
Wrapper to configure ipsec SPD policy entries in VPP
:param spd_id: SPD ID for the policy
:param local_address_start: local-ip-range start address
:param local_address_stop : local-ip-range stop address
:param remote_address_start: remote-ip-range start address
:param remote_address_stop : remote-ip-range stop address
:param local_port_start: (Default value = 0)
:param local_port_stop: (Default value = 65535)
:param remote_port_start: (Default value = 0)
:param remote_port_stop: (Default value = 65535)
:param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
:param sa_id: Security Association ID for mapping it to SPD
:param policy: bypass(0), discard(1), resolve(2) or protect(3) action
(Default value = 0)
:param priority: value for the spd action (Default value = 100)
:param is_outbound: flag for inbound(0) or outbound(1)
(Default value = 1)
:param is_add: (Default value = 1)
"""
return self.api(
self.papi.ipsec_spd_entry_add_del, {
'is_add': is_add,
'entry': {
'spd_id': spd_id,
'sa_id': sa_id,
'local_address_start': local_address_start,
'local_address_stop': local_address_stop,
'remote_address_start': remote_address_start,
'remote_address_stop': remote_address_stop,
'local_port_start': local_port_start,
'local_port_stop': local_port_stop,
'remote_port_start': remote_port_start,
'remote_port_stop': remote_port_stop,
'protocol': protocol,
'policy': policy,
'priority': priority,
'is_outbound': is_outbound,
}
})
def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
return self.api(self.papi.ipsec_spd_dump, {
'spd_id': spd_id,
'sa_id': sa_id
})
def ipsec_tunnel_if_add_del(self,
local_ip,
remote_ip,
local_spi,
remote_spi,
crypto_alg,
local_crypto_key,
remote_crypto_key,
integ_alg,
local_integ_key,
remote_integ_key,
is_add=1,
esn=0,
salt=0,
anti_replay=1,
renumber=0,
udp_encap=0,
show_instance=0xffffffff):
return self.api(
self.papi.ipsec_tunnel_if_add_del, {
'local_ip': local_ip,
'remote_ip': remote_ip,
'local_spi': local_spi,
'remote_spi': remote_spi,
'crypto_alg': crypto_alg,
'local_crypto_key_len': len(local_crypto_key),
'local_crypto_key': local_crypto_key,
'remote_crypto_key_len': len(remote_crypto_key),
'remote_crypto_key': remote_crypto_key,
'integ_alg': integ_alg,
'local_integ_key_len': len(local_integ_key),
'local_integ_key': local_integ_key,
'remote_integ_key_len': len(remote_integ_key),
'remote_integ_key': remote_integ_key,
'is_add': is_add,
'esn': esn,
'anti_replay': anti_replay,
'renumber': renumber,
'show_instance': show_instance,
'udp_encap': udp_encap,
'salt': salt
})
def ipsec_select_backend(self, protocol, index):
return self.api(self.papi.ipsec_select_backend, {
'protocol': protocol,
'index': index
})
def ipsec_backend_dump(self):
return self.api(self.papi.ipsec_backend_dump, {})
def punt_socket_register(self, reg, pathname, header_version=1):
""" Register punt socket """
return self.api(self.papi.punt_socket_register, {
'header_version': header_version,
'punt': reg,
'pathname': pathname
})
def punt_socket_deregister(self, reg):
""" Unregister punt socket """
return self.api(self.papi.punt_socket_deregister, {'punt': reg})
def gbp_endpoint_dump(self):
""" GBP endpoint Dump """
return self.api(self.papi.gbp_endpoint_dump, {})
def gbp_recirc_dump(self):
""" GBP recirc Dump """
return self.api(self.papi.gbp_recirc_dump, {})
def gbp_ext_itf_dump(self):
""" GBP recirc Dump """
return self.api(self.papi.gbp_ext_itf_dump, {})
def gbp_subnet_dump(self):
""" GBP Subnet Dump """
return self.api(self.papi.gbp_subnet_dump, {})
def gbp_contract_dump(self):
""" GBP contract Dump """
return self.api(self.papi.gbp_contract_dump, {})
def gbp_vxlan_tunnel_dump(self):
""" GBP VXLAN tunnel add/del """
return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
def igmp_enable_disable(self, sw_if_index, enable, host):
""" Enable/disable IGMP on a given interface """
return self.api(self.papi.igmp_enable_disable, {
'enable': enable,
'mode': host,
'sw_if_index': sw_if_index
})
def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
""" Add/del IGMP proxy device """
return self.api(self.papi.igmp_proxy_device_add_del, {
'vrf_id': vrf_id,
'sw_if_index': sw_if_index,
'add': add
})
def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
""" Add/del interface to/from IGMP proxy device """
return self.api(self.papi.igmp_proxy_device_add_del_interface, {
'vrf_id': vrf_id,
'sw_if_index': sw_if_index,
'add': add
})
def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
""" Listen for new (S,G) on specified interface
:param enable: add/del
:param sw_if_index: interface sw index
:param saddr: source ip4 addr
:param gaddr: group ip4 addr
"""
return self.api(
self.papi.igmp_listen, {
'group': {
'filter': filter,
'sw_if_index': sw_if_index,
'n_srcs': len(saddrs),
'saddrs': saddrs,
'gaddr': gaddr
}
})
def igmp_clear_interface(self, sw_if_index):
""" Remove all (S,G)s from specified interface
doesn't send IGMP report!
"""
return self.api(self.papi.igmp_clear_interface,
{'sw_if_index': sw_if_index})
def want_igmp_events(self, enable=1):
return self.api(self.papi.want_igmp_events, {
'enable': enable,
'pid': os.getpid()
})
def save(self, text):
self._create_dirs()
text = Hook.enrich_text(text)
with open(self._filesystem_path, "w") as fd:
fd.write(text)
class BlueSky:
def __init__(self):
# pygame.init is used to deploy the background
pygame.init()
# self.screen will display a window with 1200 by 700 screen size
self.settings = Settings(self)
self.screen = pygame.display.set_mode(
(self.settings.screen_width, self.settings.screen_height))
self.screen_rect = self.screen.get_rect()
# bg_colour will give a background colour
self.bg_colour = self.settings.bg_colour
# self.captions will create a title at the top of the window
pygame.display.set_caption('Blue Sky')
self.fish = Fish(self)
self.seaweeds = pygame.sprite.Group()
self.worms = pygame.sprite.Group()
self.hook = Hook(self)
self.line = Line(self)
self.stats = GameStats(self)
self._create_fleet()
self._create_worms()
self.clock = pygame.time.Clock()
self.counter = 0
pygame.time.set_timer(pygame.USEREVENT, 1000)
self.play = Button(self, 'Play')
self.sb = Score(self)
def run_game(self):
while True:
self._check_events()
if self.stats.game_active:
self.fish.update()
self.worms.update()
self._update_hooks()
self._update_worms()
self._screen_update()
def _create_fleet(self):
# Make a seaweed
seaweed = Seaweed(self)
seaweed_width = seaweed.rect.width
number_seaweeds_x = self.screen_rect.width // seaweed_width
for number_seaweed in range(number_seaweeds_x):
# Create a seaweed and place it in position
seaweed = Seaweed(self)
seaweed.x = (seaweed_width * number_seaweed)
seaweed.rect.x = seaweed.x
self.seaweeds.add(seaweed)
def _create_worms(self):
'''Create a worm'''
worm = Worm(self)
worm_width, worm_height = worm.rect.size
for worm_num in range(3):
worm = Worm(self)
random_number_x = randint(worm_width,
self.settings.screen_width - worm_width)
worm.rect.x = random_number_x
self.worms.add(worm)
def _update_worms(self):
'''Remove any worms that have reached the bottom of the screen'''
for worm in self.worms.copy():
if worm.rect.y > self.settings.screen_height:
self.worms.remove(worm)
collisions = pygame.sprite.spritecollide(self.fish,
self.worms,
dokill=self.worms)
if collisions:
self.stats.score += self.settings.points
self.sb.prep_score()
if not self.worms:
self._create_worms()
self.settings.change_speed()
def _update_hooks(self):
'''Remove the hook when it reaches the bottom of the screen'''
if self.line.rect.bottom < -20 and self.line.go_up == True and self.hook.go_up == True:
self.counter = random.uniform(0, 10)
self.hook.center_hook()
self.line.center_line(self)
self.hook.go_up = False
self.line.go_up = False
self.settings.increase_hook_speed()
if self.counter <= 0:
self.hook.update()
self.line.update(self)
# Look for collision between fish and hook
if pygame.sprite.collide_rect(self.fish, self.line):
self.stats.key_active = False
self.fish.moving_left = False
self.fish.moving_down = False
self.fish.moving_up = False
self.fish.open_top = True
self.hook.go_up = True
self.line.go_up = True
if self.fish.y < -20:
self.stats.game_active = False
pygame.mouse.set_visible(True)
def _screen_update(self):
self.screen.fill(self.bg_colour)
self.fish.blitme()
self.seaweeds.draw(self.screen)
self.hook.draw_hook()
self.line.draw_line()
self.worms.draw(self.screen)
self.sb.show_score()
if not self.stats.game_active:
self.play.draw_button()
pygame.display.flip()
def _check_events(self):
for event in pygame.event.get():
if event.type == pygame.QUIT:
sys.exit()
elif event.type == pygame.KEYDOWN:
if self.stats.key_active:
if event.key == pygame.K_LEFT:
self.fish.moving_left = True
if event.key == pygame.K_UP:
self.fish.moving_up = True
if event.key == pygame.K_DOWN:
self.fish.moving_down = True
if event.key == pygame.K_q:
sys.exit()
elif event.type == pygame.KEYUP:
self.fish.moving_left = False
self.fish.moving_up = False
self.fish.moving_down = False
elif event.type == pygame.USEREVENT:
self.counter -= 1
elif event.type == pygame.MOUSEBUTTONDOWN:
mouse_pos = pygame.mouse.get_pos()
self._check_play_button(mouse_pos)
def _check_play_button(self, mouse_pos):
button_clicked = self.play.rect.collidepoint(mouse_pos)
if button_clicked and not self.stats.game_active:
# Reset the game statistics
self.stats.reset_stats()
# Get rid of any worms
self.worms.empty()
# Position the fish and hook
self.stats.key_active = True
self.sb.prep_score()
self.fish.open_top = False
self.hook.go_up = False
self.line.go_up = False
self.fish.fish_pos()
self.stats.game_active = True
# Hide the mouse cursor
pygame.mouse.set_visible(False)
def create_enemies(screen, enemies):
enemy = Enemy(screen)
enemy_2 = Enemy_2(screen)
hook = Hook(screen)
enemies.add(enemy, enemy_2, hook)
class WM:
"""
Provides basic building blocks to make a window manager.
It hides many dirty details about XCB. It was intended
to provide minimum functionality, the rest supposed to
be implemented by user in configuration file.
"""
root = None # type: Window
atoms = None # type: AtomVault
def __init__(self, display=None, desktops=None, loop=None):
self.log = Log("WM")
# INIT SOME BASIC STUFF
self.hook = Hook()
self.windows = {} # mapping between window id and Window
self.win2desk = {}
if not display:
display = os.environ.get("DISPLAY")
try:
self._conn = xcffib.connect(display=display)
except xcffib.ConnectionException:
sys.exit("cannot connect to %s" % display)
self.atoms = AtomVault(self._conn)
self.desktops = desktops or [Desktop()]
self.cur_desktop = self.desktops[0]
self.cur_desktop.show()
# CREATE ROOT WINDOW
xcb_setup = self._conn.get_setup()
xcb_screens = [i for i in xcb_setup.roots]
self.xcb_default_screen = xcb_screens[self._conn.pref_screen]
root_wid = self.xcb_default_screen.root
self.root = Window(self, wid=root_wid, atoms=self.atoms, mapped=True)
self.windows[root_wid] = self.root
# for desktop in self.desktops:
# desktop.windows.append(self.root)
self.root.set_attr(
eventmask=(
EventMask.StructureNotify
| EventMask.SubstructureNotify
| EventMask.FocusChange
# | EventMask.SubstructureRedirect
| EventMask.EnterWindow
# | EventMask.LeaveWindow
# | EventMask.PropertyChange
| EventMask.OwnerGrabButton
)
)
# INFORM X WHICH FEATURES WE SUPPORT
self.root.props[self.atoms._NET_SUPPORTED] = [self.atoms[a] for a in SUPPORTED_ATOMS]
# PRETEND TO BE A WINDOW MANAGER
supporting_wm_check_window = self.create_window(-1, -1, 1, 1)
supporting_wm_check_window.props['_NET_WM_NAME'] = "SWM"
self.root.props['_NET_SUPPORTING_WM_CHECK'] = supporting_wm_check_window.wid
self.root.props['_NET_NUMBER_OF_DESKTOPS'] = len(self.desktops)
self.root.props['_NET_CURRENT_DESKTOP'] = 0
# TODO: set cursor
# EVENTS THAT HAVE LITTLE USE FOR US...
self.ignoreEvents = {
"KeyRelease",
"ReparentNotify",
# "CreateNotify",
# DWM handles this to help "broken focusing windows".
# "MapNotify",
"ConfigureNotify",
"LeaveNotify",
"FocusOut",
"FocusIn",
"NoExposure",
}
# KEYBOARD
self.kbd = Keyboard(xcb_setup, self._conn)
self.mouse = Mouse(conn=self._conn, root=self.root)
# FLUSH XCB BUFFER
self.xsync() # apply settings
# the event loop is not yet there, but we might have some pending
# events...
self._xpoll()
# TODO: self.grabMouse
# NOW IT'S TIME TO GET PHYSICAL SCREEN CONFIGURATION
self.xrandr = Xrandr(root=self.root, conn=self._conn)
# TODO: self.update_net_desktops()
# SETUP EVENT LOOP
if not loop:
loop = asyncio.new_event_loop()
self._eventloop = loop
self._eventloop.add_signal_handler(signal.SIGINT, self.stop)
self._eventloop.add_signal_handler(signal.SIGTERM, self.stop)
self._eventloop.add_signal_handler(signal.SIGCHLD, self.on_sigchld)
self._eventloop.set_exception_handler(
lambda loop, ctx: self.log.error(
"Got an exception in {}: {}".format(loop, ctx))
)
fd = self._conn.get_file_descriptor()
self._eventloop.add_reader(fd, self._xpoll)
# HANDLE STANDARD EVENTS
self.hook.register("MapRequest", self.on_map_request)
self.hook.register("MapNotify", self.on_map_notify)
self.hook.register("UnmapNotify", self.on_window_unmap)
self.hook.register("KeyPress", self.on_key_press)
# self.hook.register("KeyRelease", self.on_key_release)
# self.hook.register("CreateNotify", self.on_window_create)
self.hook.register("PropertyNotify", self.on_property_notify)
self.hook.register("ClientMessage", self.on_client_message)
self.hook.register("DestroyNotify", self.on_window_destroy)
self.hook.register("EnterNotify", self.on_window_enter)
self.hook.register("ConfigureRequest", self.on_configure_window)
self.hook.register("MotionNotify", self.on_mouse_event)
self.hook.register("ButtonPress", self.on_mouse_event)
self.hook.register("ButtonRelease", self.on_mouse_event)
def on_property_notify(self, evname, xcb_event):
# TODO: messy ugly code
wid = xcb_event.window
atom = self.atoms.get_name(xcb_event.atom)
# window = self.windows.get(wid, Window(wm=self, wid=wid, mapped=True))
self.log.error("PropertyNotify: %s" % atom)
run_("xprop -id %s %s" % (wid, atom))
# TODO: dirty code, relocate to config
def on_client_message(self, evname, xcb_event):
self.log.error(dir(xcb_event))
data = xcb_event.data
resp_type = self.atoms.get_name(xcb_event.response_type)
type = self.atoms.get_name(xcb_event.type)
wid = xcb_event.window
self.log.error("client message: resp_type={resp_type} window={wid} type={type} data={data}" \
.format(**locals()))
# 'bufsize', 'data', 'format', 'pack', 'response_type', 'sequence', 'synthetic', 'type', 'window']
if type == '_NET_ACTIVE_WINDOW':
window = self.windows[wid]
window.rise()
self.focus_on(window)
def on_sigchld(self):
""" Rip orphans. """
while True:
try:
pid, status = os.waitpid(-1, os.WNOHANG)
if (pid, status) == (0, 0):
# no child to rip
break
self.log.notice("ripped child PID=%s" % pid)
except ChildProcessError:
break
def on_map_request(self, evname, xcb_event):
""" Map request is a request to draw the window on screen. """
wid = xcb_event.window
if wid not in self.windows:
window = self.on_new_window(wid)
else:
window = self.windows[wid]
self.log.on_map_request.debug("map request for %s" % window)
window.show()
if window.above_all:
window.rise()
if window.can_focus:
window.focus()
def on_new_window(self, wid):
""" Registers new window. """
window = Window(wm=self, wid=wid, atoms=self.atoms, mapped=True)
# call configuration hood first
# to setup attributes like 'sticky'
self.hook.fire("new_window", window)
self.log.on_new_window.debug(
"new window is ready: %s" % window)
self.windows[wid] = window
self.win2desk[window] = self.cur_desktop
if window.sticky:
for desktop in self.desktops:
desktop.add(window)
else:
self.cur_desktop.windows.append(window)
return window
def on_map_notify(self, evname, xcb_event):
wid = xcb_event.window
if wid not in self.windows:
window = self.on_new_window(wid)
else:
window = self.windows[wid]
window.mapped = True
if window.above_all:
window.rise()
# if window.can_focus:
# window.focus()
self.log.on_map_notify.debug("map notify for %s" % window)
def on_window_unmap(self, evname, xcb_event):
wid = xcb_event.window
if wid not in self.windows:
return
window = self.windows[wid]
window.mapped = False
self.hook.fire("window_unmap", window)
def on_window_destroy(self, evname, xcb_event):
wid = xcb_event.window
if wid not in self.windows:
return
window = self.windows[wid]
assert isinstance(window, Window), "it's not a window: %s (%s)" % (
window, type(window))
for desktop in self.desktops:
try:
desktop.windows.remove(window)
self.log.debug("%s removed from %s" % (self, desktop))
except ValueError:
pass
del self.windows[wid]
if window in self.win2desk:
del self.win2desk[window]
def on_window_enter(self, evname, xcb_event):
wid = xcb_event.event
if wid not in self.windows:
# self.log.on_window_enter.error("no window with wid=%s" % wid)
self.hook.fire("unknown_window", wid)
return
window = self.windows[wid]
# self.log.on_window_enter("window_enter: %s %s" % (wid, window))
self.hook.fire("window_enter", window)
def grab_key(self, modifiers, key, owner_events=False, window=None):
""" Intercept this key when it is pressed. If owner_events=False then
the window in focus will not receive it. This is useful from WM hotkeys.
"""
# TODO: check if key already grabbed?
# Here is how X works with keys:
# key => keysym => keycode
# where `key' is something like 'a', 'b' or 'Enter',
# `keysum' is what should be written on they key cap (physical keyboard)
# and `keycode' is a number reported by the keyboard when the key is pressed.
# Modifiers are keys like Shift, Alt, Win and some other buttons.
self.log.grab_key.debug("intercept keys: %s %s" % (modifiers, key))
if window is None:
window = self.root
keycode = self.kbd.key_to_code(key)
modmask = get_modmask(modifiers) # TODO: move to Keyboard
event = ("on_key_press", modmask, keycode)
pointer_mode = xproto.GrabMode.Async
keyboard_mode = xproto.GrabMode.Async
self._conn.core.GrabKey(
owner_events,
window.wid,
modmask,
keycode,
pointer_mode,
keyboard_mode
)
self.flush() # TODO: do we need this?
return event
def on_key_press(self, evname, xcb_event):
# TODO: ignore capslock, scrolllock and other modifiers?
modmap = xcb_event.state
keycode = xcb_event.detail
event = ("on_key_press", modmap, keycode)
self.hook.fire(event)
def on_key_release(self, evname, xcb_event):
modmap = xcb_event.state
keycode = xcb_event.detail
event = ("on_key_release", modmap, keycode)
self.hook.fire(event)
def grab_mouse(self, modifiers, button, owner_events=False, window=None):
# http://www.x.org/archive/X11R7.7/doc/man/man3/xcb_grab_button.3.xhtml
wid = (window or self.root).wid
event_mask = xcffib.xproto.EventMask.ButtonPress | \
xcffib.xproto.EventMask.ButtonRelease | \
xcffib.xproto.EventMask.Button1Motion
modmask = get_modmask(modifiers)
pointer_mode = xproto.GrabMode.Async # I don't know what it is
keyboard_mode = xproto.GrabMode.Async # do not block other keyboard events
confine_to = xcffib.xproto.Atom._None # do not restrict cursor movements
cursor = xcffib.xproto.Atom._None # do not change cursor
event = ("on_mouse", modmask, button) # event to be used in hooks
self._conn.core.GrabButton(
owner_events,
wid,
event_mask,
pointer_mode,
keyboard_mode,
confine_to,
cursor,
button,
modmask,
)
self.flush() # TODO: do we need this?
return event
def hotkey(self, keys, cmd):
""" Setup hook to launch a command on specific hotkeys. """
@self.hook(self.grab_key(*keys))
def cb(event):
run_(cmd)
def focus_on(self, window, warp=False):
""" Focuses on given window. """
self.cur_desktop.focus_on(window, warp)
self.root.set_prop('_NET_ACTIVE_WINDOW', window.wid)
def switch_to(self, desktop: Desktop):
""" Switches to another desktop. """
if isinstance(desktop, int):
desktop = self.desktops[desktop]
if self.cur_desktop == desktop:
self.log.notice("attempt to switch to the same desktop")
return
self.log.debug("switching from {} to {}".format(
self.cur_desktop, desktop))
self.cur_desktop.hide()
self.cur_desktop = desktop
self.cur_desktop.show()
# TODO: move this code to Desktop.show()
self.root.props[self.atom._NET_CURRENT_DESKTOP] = desktop.id
def relocate_to(self, window: Window, to_desktop: Desktop):
""" Relocates window to a specific desktop. """
if window.sticky:
self.log.debug(
"%s is meant to be on all desktops, cannot relocate to specific one" % window)
return
from_desktop = self.cur_desktop
if from_desktop == to_desktop:
self.log.debug(
"no need to relocate %s because remains on the same desktop" % window)
return
from_desktop.remove(window)
to_desktop.add(window)
def on_mouse_event(self, evname, xcb_event):
"""evname is one of ButtonPress, ButtonRelease or MotionNotify."""
# l = [(attr, getattr(xcb_event, attr)) for attr in sorted(dir(xcb_event)) if not attr.startswith('_')]
# print(evname)
# print(l)
modmask = xcb_event.state & 0xff # TODO: is the mask correct?
if evname == 'MotionNotify':
button = 1 # TODO
else:
button = xcb_event.detail
event = ('on_mouse', modmask, button)
# print(event)
self.hook.fire(event, evname, xcb_event)
def on_configure_window(self, _, event):
# This code is so trivial that I just took it from fpwm as is :)
values = []
if event.value_mask & ConfigWindow.X:
values.append(event.x)
if event.value_mask & ConfigWindow.Y:
values.append(event.y)
if event.value_mask & ConfigWindow.Width:
values.append(event.width)
if event.value_mask & ConfigWindow.Height:
values.append(event.height)
if event.value_mask & ConfigWindow.BorderWidth:
values.append(event.border_width)
if event.value_mask & ConfigWindow.Sibling:
values.append(event.sibling)
if event.value_mask & ConfigWindow.StackMode:
values.append(event.stack_mode)
self._conn.core.ConfigureWindow(event.window, event.value_mask, values)
def create_window(self, x, y, width, height):
""" Create a window. Right now only used for initialization, see __init__. """
wid = self._conn.generate_id()
self._conn.core.CreateWindow(
self.xcb_default_screen.root_depth,
wid,
self.xcb_default_screen.root,
x, y, width, height, 0,
WindowClass.InputOutput,
self.xcb_default_screen.root_visual,
CW.BackPixel | CW.EventMask,
[
self.xcb_default_screen.black_pixel,
EventMask.StructureNotify | EventMask.Exposure
]
)
return Window(self, wid=wid, atoms=self.atoms)
def scan(self, focus=True):
""" Gets all windows in the system. """
self.log.debug("performing scan of all mapped windows")
q = self._conn.core.QueryTree(self.root.wid).reply()
for wid in q.children:
# attrs=self._conn.core.GetWindowAttributes(wid).reply()
# print(attrs, type(attrs))
# if attrs.map_state == xproto.MapState.Unmapped:
# self.log.scan.debug(
# "window %s is not mapped, skipping" % wid) # TODO
# continue
if wid not in self.windows:
self.on_new_window(wid)
self.log.scan.info("the following windows are active: %s" %
sorted(self.windows.values()))
if focus:
windows = sorted(self.windows.values())
windows = list(filter(lambda w: w != self.root and not w.skip, windows))
if windows:
# on empty desktop there is nothing to focus on
self.cur_desktop.focus_on(windows[-1], warp=True)
def finalize(self):
""" This code is run when event loop is terminated. """
pass # currently nothing to do here
def flush(self):
""" Force pending X request to be sent.
By default XCB aggressevly buffers for performance reasons. """
return self._conn.flush()
def xsync(self):
""" Flush XCB queue and wait till it is processed by X server. """
# The idea here is that pushing an innocuous request through the queue
# and waiting for a response "syncs" the connection, since requests are
# serviced in order.
self._conn.core.GetInputFocus().reply()
def stop(self, xserver_dead=False):
""" Stop WM to quit. """
self.hook.fire("on_exit")
# display all hidden windows
try:
if not xserver_dead:
for window in self.windows.values():
window.show()
self.xsync()
except Exception as err:
self.log.stop.error("error on stop: %s" % err)
self.log.stop.debug("stopping event loop")
self._eventloop.stop()
def replace(self, execv_args):
self.log.notice("replacing current process with %s" % (execv_args,))
self.stop()
import os
os.execv(*execv_args)
def loop(self):
""" DITTO """
self.scan()
try:
self._eventloop.run_forever()
finally:
self.finalize()
def _xpoll(self):
""" Fetch incomming events (if any) and call hooks. """
# OK, kids, today I'll teach you how to write reliable enterprise
# software! You just catch all the exceptions in the top-level loop
# and ignore them. No, I'm kidding, these exceptions are no use
# for us because we don't care if a window cannot be drawn or something.
# We actually only need to handle just a few events and ignore the rest.
# Exceptions happen because of the async nature of X.
while True:
try:
xcb_event = self._conn.poll_for_event()
if not xcb_event:
break
evname = xcb_event.__class__.__name__
if evname.endswith("Event"):
evname = evname[:-5]
if evname in self.ignoreEvents:
self.log._xpoll.info("ignoring %s" % xcb_event)
continue
self.log._xpoll.critical("got %s %s" % (evname, xcb_event))
self.hook.fire(evname, xcb_event)
self.flush() # xcb doesn't flush implicitly
except (WindowError, AccessError, DrawableError):
self.log.debug("(minor exception)")
except Exception as e:
self.log._xpoll.error(traceback.format_exc())
error_code = self._conn.has_error()
if error_code:
error_string = XCB_CONN_ERRORS[error_code]
self.log.critical("Shutting down due to X connection error %s (%s)" %
(error_string, error_code))
self.stop(xserver_dead=True)
break
class VppPapiProvider(object):
"""VPP-api provider using vpp-papi
@property hook: hook object providing before and after api/cli hooks
"""
_zero, _negative = range(2)
def __init__(self, name, shm_prefix, test_class, read_timeout):
self.hook = Hook("vpp-papi-provider")
self.name = name
self.shm_prefix = shm_prefix
self.test_class = test_class
self._expect_api_retval = self._zero
self._expect_stack = []
jsonfiles = []
install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
for root, dirnames, filenames in os.walk(install_dir):
for filename in fnmatch.filter(filenames, '*.api.json'):
jsonfiles.append(os.path.join(root, filename))
self.vpp = VPP(jsonfiles, logger=test_class.logger,
read_timeout=read_timeout)
self._events = deque()
def __enter__(self):
return self
def expect_negative_api_retval(self):
""" Expect API failure """
self._expect_stack.append(self._expect_api_retval)
self._expect_api_retval = self._negative
return self
def expect_zero_api_retval(self):
""" Expect API success """
self._expect_stack.append(self._expect_api_retval)
self._expect_api_retval = self._zero
return self
def __exit__(self, exc_type, exc_value, traceback):
self._expect_api_retval = self._expect_stack.pop()
def connect(self):
"""Connect the API to VPP"""
self.vpp.connect(self.name, self.shm_prefix)
self.papi = self.vpp.api
self.vpp.register_event_callback(self)
def disconnect(self):
"""Disconnect the API from VPP"""
self.vpp.disconnect()
def api(self, api_fn, api_args, expected_retval=0):
""" Call API function and check it's return value.
Call the appropriate hooks before and after the API call
:param api_fn: API function to call
:param api_args: tuple of API function arguments
:param expected_retval: Expected return value (Default value = 0)
:returns: reply from the API
"""
self.hook.before_api(api_fn.__name__, api_args)
reply = api_fn(**api_args)
if self._expect_api_retval == self._negative:
if hasattr(reply, 'retval') and reply.retval >= 0:
msg = "API call passed unexpectedly: expected negative "\
"return value instead of %d in %s" % \
(reply.retval, repr(reply))
self.test_class.logger.info(msg)
raise UnexpectedApiReturnValueError(msg)
elif self._expect_api_retval == self._zero:
if hasattr(reply, 'retval') and reply.retval != expected_retval:
msg = "API call failed, expected %d return value instead "\
"of %d in %s" % (expected_retval, reply.retval,
repr(reply))
self.test_class.logger.info(msg)
raise UnexpectedApiReturnValueError(msg)
else:
raise Exception("Internal error, unexpected value for "
"self._expect_api_retval %s" %
self._expect_api_retval)
self.hook.after_api(api_fn.__name__, api_args)
return reply
def cli(self, cli):
""" Execute a CLI, calling the before/after hooks appropriately.
:param cli: CLI to execute
:returns: CLI output
"""
self.hook.before_cli(cli)
cli += '\n'
r = self.papi.cli_inband(length=len(cli), cmd=cli)
self.hook.after_cli(cli)
if hasattr(r, 'reply'):
return r.reply.decode().rstrip('\x00')
def ppcli(self, cli):
""" Helper method to print CLI command in case of info logging level.
:param cli: CLI to execute
:returns: CLI output
"""
return cli + "\n" + str(self.cli(cli))
def sw_interface_dump(self, filter=None):
"""
:param filter: (Default value = None)
"""
if filter is not None:
args = {"name_filter_valid": 1, "name_filter": filter}
else:
args = {}
return self.api(self.papi.sw_interface_dump, args)
def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
return self.api(self.papi.ip_unnumbered_dump,
{'sw_if_index': sw_if_index})
def bridge_domain_dump(self, bd_id=0):
"""
:param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
existing bridge domains returned)
:return: Dictionary of bridge domain(s) data.
"""
return self.api(self.papi.bridge_domain_dump,
{'bd_id': bd_id})
def ip_fib_dump(self):
return self.api(self.papi.ip_fib_dump, {})
def ip6_fib_dump(self):
return self.api(self.papi.ip6_fib_dump, {})
def ip_neighbor_dump(self,
sw_if_index,
is_ipv6=0):
""" Return IP neighbor dump.
:param sw_if_index:
:param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
"""
def ip_dump(self,
is_ipv6=0,
):
""" Return IP dump.
:param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
"""
return self.api(
self.papi.ip_dump,
{'is_ipv6': is_ipv6,
}
)
def udp_encap_dump(self):
return self.api(self.papi.udp_encap_dump, {})
def mpls_fib_dump(self):
return self.api(self.papi.mpls_fib_dump, {})
def mpls_tunnel_dump(self, sw_if_index=0xffffffff):
return self.api(self.papi.mpls_tunnel_dump,
{'sw_if_index': sw_if_index})
def nat44_address_dump(self):
"""Dump NAT44 addresses
:return: Dictionary of NAT44 addresses
"""
return self.api(self.papi.nat44_address_dump, {})
def nat44_interface_dump(self):
"""Dump interfaces with NAT44 feature
:return: Dictionary of interfaces with NAT44 feature
"""
return self.api(self.papi.nat44_interface_dump, {})
def nat44_interface_output_feature_dump(self):
"""Dump interfaces with NAT44 output feature
:return: Dictionary of interfaces with NAT44 output feature
"""
return self.api(self.papi.nat44_interface_output_feature_dump, {})
def nat44_static_mapping_dump(self):
"""Dump NAT44 static mappings
:return: Dictionary of NAT44 static mappings
"""
return self.api(self.papi.nat44_static_mapping_dump, {})
def nat44_identity_mapping_dump(self):
"""Dump NAT44 identity mappings
:return: Dictionary of NAT44 identity mappings
"""
return self.api(self.papi.nat44_identity_mapping_dump, {})
def nat44_interface_addr_dump(self):
"""Dump NAT44 addresses interfaces
:return: Dictionary of NAT44 addresses interfaces
"""
return self.api(self.papi.nat44_interface_addr_dump, {})
def nat44_user_session_dump(
self,
ip_address,
vrf_id):
"""Dump NAT44 user's sessions
:param ip_address: ip adress of the user to be dumped
:param cpu_index: cpu_index on which the user is
:param vrf_id: VRF ID
:return: Dictionary of S-NAT sessions
"""
return self.api(
self.papi.nat44_user_session_dump,
{'ip_address': ip_address,
'vrf_id': vrf_id})
def nat44_user_dump(self):
"""Dump NAT44 users
:return: Dictionary of NAT44 users
"""
return self.api(self.papi.nat44_user_dump, {})
def nat44_lb_static_mapping_dump(self):
"""Dump NAT44 load balancing static mappings
:return: Dictionary of NAT44 load balancing static mapping
"""
return self.api(self.papi.nat44_lb_static_mapping_dump, {})
def nat_reass_dump(self):
"""Dump NAT virtual fragmentation reassemblies
:return: Dictionary of NAT virtual fragmentation reassemblies
"""
return self.api(self.papi.nat_reass_dump, {})
def nat_det_map_dump(self):
"""Dump deterministic NAT mappings
:return: Dictionary of deterministic NAT mappings
"""
return self.api(self.papi.nat_det_map_dump, {})
def nat_det_session_dump(
self,
user_addr):
"""Dump deterministic NAT sessions belonging to a user
:param user_addr - inside IP address of the user
:return: Dictionary of deterministic NAT sessions
"""
return self.api(
self.papi.nat_det_session_dump,
{'is_nat44': 1,
'user_addr': user_addr})
def nat64_pool_addr_dump(self):
"""Dump NAT64 pool addresses
:return: Dictionary of NAT64 pool addresses
"""
return self.api(self.papi.nat64_pool_addr_dump, {})
def nat64_interface_dump(self):
"""Dump interfaces with NAT64 feature
:return: Dictionary of interfaces with NAT64 feature
"""
return self.api(self.papi.nat64_interface_dump, {})
def nat64_bib_dump(self, protocol=255):
"""Dump NAT64 BIB
:param protocol: IP protocol (Default value = 255, all BIBs)
:returns: Dictionary of NAT64 BIB entries
"""
return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
def nat64_st_dump(self, protocol=255):
"""Dump NAT64 session table
:param protocol: IP protocol (Default value = 255, all STs)
:returns: Dictionary of NAT64 sesstion table entries
"""
return self.api(self.papi.nat64_st_dump, {'proto': protocol})
def nat64_prefix_dump(self):
"""Dump NAT64 prefix
:returns: Dictionary of NAT64 prefixes
"""
return self.api(self.papi.nat64_prefix_dump, {})
def nat66_interface_dump(self):
"""Dump interfaces with NAT66 feature
:return: Dictionary of interfaces with NAT66 feature
"""
return self.api(self.papi.nat66_interface_dump, {})
def nat66_static_mapping_dump(self):
"""Dump NAT66 static mappings
:return: Dictionary of NAT66 static mappings
"""
return self.api(self.papi.nat66_static_mapping_dump, {})
def bfd_udp_session_dump(self):
return self.api(self.papi.bfd_udp_session_dump, {})
def bfd_auth_keys_dump(self):
return self.api(self.papi.bfd_auth_keys_dump, {})
def dhcp_client_dump(self):
return self.api(self.papi.dhcp_client_dump, {})
def mfib_signal_dump(self):
return self.api(self.papi.mfib_signal_dump, {})
def ip_mfib_dump(self):
return self.api(self.papi.ip_mfib_dump, {})
def ip6_mfib_dump(self):
return self.api(self.papi.ip6_mfib_dump, {})
def lisp_locator_set_dump(self):
return self.api(self.papi.lisp_locator_set_dump, {})
def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
return self.api(
self.papi.lisp_locator_dump,
{
'is_index_set': is_index_set,
'ls_name': ls_name,
'ls_index': ls_index,
})
def lisp_eid_table_dump(self,
eid_set=0,
prefix_length=0,
vni=0,
eid_type=0,
eid=None,
filter_opt=0):
return self.api(
self.papi.lisp_eid_table_dump,
{
'eid_set': eid_set,
'prefix_length': prefix_length,
'vni': vni,
'eid_type': eid_type,
'eid': eid,
'filter': filter_opt,
})
def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
return self.api(self.papi.vxlan_gbp_tunnel_dump,
{'sw_if_index': sw_if_index})
def acl_dump(self, acl_index, expected_retval=0):
return self.api(self.papi.acl_dump,
{'acl_index': acl_index},
expected_retval=expected_retval)
def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
expected_retval=0):
return self.api(self.papi.acl_interface_list_dump,
{'sw_if_index': sw_if_index},
expected_retval=expected_retval)
def macip_acl_dump(self, acl_index=4294967295):
""" Return MACIP acl dump
"""
return self.api(
self.papi.macip_acl_dump, {'acl_index': acl_index})
def bier_table_dump(self):
return self.api(self.papi.bier_table_dump, {})
def bier_route_dump(self, bti):
return self.api(
self.papi.bier_route_dump,
{'br_tbl_id': {"bt_set": bti.set_id,
"bt_sub_domain": bti.sub_domain_id,
"bt_hdr_len_ def bier_disp_table_add_del(self,
bdti,
is_add=1):
""" BIER Disposition Table add/del """
return self.api(
self.papi.bier_disp_table_add_del,
{'bdt_tbl_id': bdti,
'bdt_is_add': is_add})id": bti.hdr_len_id}})
def bier_imp_dump(self):
return self.api(self.papi.bier_imp_dump, {})
def bier_disp_table_dump(self):
return self.api(self.papi.bier_disp_table_dump, {})
def bier_disp_entry_dump(self, bdti):
return self.api(
self.papi.bier_disp_entry_dump,
{'bde_tbl_id': bdti})
def gbp_endpoint_dump(self):
""" GBP endpoint Dump """
return self.api(self.papi.gbp_endpoint_dump, {})
def gbp_endpoint_group_dump(self):
""" GBP endpoint group Dump """
return self.api(self.papi.gbp_endpoint_group_dump, {})
def gbp_recirc_dump(self):
""" GBP recirc Dump """
return self.api(self.papi.gbp_recirc_dump, {})
def gbp_subnet_dump(self):
""" GBP Subnet Dump """
return self.api(self.papi.gbp_subnet_dump, {})
def gbp_contract_dump(self):
""" GBP contract Dump """
return self.api(self.papi.gbp_contract_dump, {})
def igmp_dump(self, sw_if_index=None):
""" Dump all (S,G) interface configurations """
if sw_if_index is None:
sw_if_index = 0xffffffff
return self.api(self.papi.igmp_dump,
{'sw_if_index': sw_if_index})
def sw_interface_slave_dump(
self,
sw_if_index):
"""
:param sw_if_index: bond sw_if_index
"""
return self.api(self.papi.sw_interface_slave_dump,
{'sw_if_index': sw_if_index})
def sw_interface_bond_dump(
self):
"""
"""
return self.api(self.papi.sw_interface_bond_dump,
{})
def sw_interface_vhost_user_dump(
self):
"""
"""
return self.api(self.papi.sw_interface_vhost_user_dump,
{})
def abf_policy_dump(self):
return self.api(
self.papi.abf_policy_dump, {})
def abf_itf_attach_dump(self):
return self.api(
self.papi.abf_itf_attach_dump, {})
def pipe_dump(self):
return self.api(self.papi.pipe_dump, {})
def memif_dump(self):
return self.api(self.papi.memif_dump, {})
def memif_socket_filename_dump(self):
return self.api(self.papi.memif_socket_filename_dump, {})
def svs_dump(self):
return self.api(self.papi.svs_dump, {})
class VppPapiProvider(object):
"""VPP-api provider using vpp-papi
@property hook: hook object providing before and after api/cli hooks
"""
def __init__(self, name, shm_prefix):
self.hook = Hook("vpp-papi-provider")
self.name = name
self.shm_prefix = shm_prefix
def register_hook(self, hook):
"""Replace hook registration with new hook
:param hook:
"""
self.hook = hook
def connect(self):
"""Connect the API to VPP"""
vpp_papi.connect(self.name, self.shm_prefix)
def disconnect(self):
"""Disconnect the API from VPP"""
vpp_papi.disconnect()
def api(self, api_fn, api_args, expected_retval=0):
"""Call API function and check it's return value
Call the appropriate hooks before and after the API call
:param api_fn: API function to call
:param api_args: tuple of API function arguments
:param expected_retval: Expected return value (Default value = 0)
:returns: reply from the API
"""
self.hook.before_api(api_fn.__name__, api_args)
reply = api_fn(*api_args)
if hasattr(reply, 'retval') and reply.retval != expected_retval:
msg = "API call failed, expected retval == %d, got %s" % (
expected_retval, repr(reply))
error(msg)
raise Exception(msg)
self.hook.after_api(api_fn.__name__, api_args)
return reply
def cli(self, cli):
"""
Execute a CLI, calling the before/after hooks appropriately.
:param cli: CLI to execute
:returns: CLI output
"""
self.hook.before_cli(cli)
cli += '\n'
r = vpp_papi.cli_inband(len(cli), cli)
self.hook.after_cli(cli)
if hasattr(r, 'reply'):
return r.reply[0].decode().rstrip('\x00')
def ppcli(self, cli):
"""
Helping method to print CLI command in case of info logging level.
:param cli: CLI to execute
:returns: CLI output
"""
return cli + "\n" + self.cli(cli)
def _convert_mac(self, mac):
return int(mac.replace(":", ""), 16) << 16
def show_version(self):
""" """
return vpp_papi.show_version()
def pg_create_interface(self, pg_index):
"""
:param pg_index:
"""
return self.api(vpp_papi.pg_create_interface, (pg_index, ))
def sw_interface_dump(self, filter=None):
"""
:param filter: (Default value = None)
"""
if filter is not None:
args = (1, filter)
else:
args = (0, b'')
return self.api(vpp_papi.sw_interface_dump, args)
def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
"""
Set the IPvX Table-id for the Interface
:param sw_if_index:
:param is_ipv6:
:param table_id:
"""
return self.api(vpp_papi.sw_interface_set_table,
(sw_if_index, is_ipv6, table_id))
def sw_interface_add_del_address(self,
sw_if_index,
addr,
addr_len,
is_ipv6=0,
is_add=1,
del_all=0):
"""
:param addr: param is_ipv6: (Default value = 0)
:param sw_if_index:
:param addr_len:
:param is_ipv6: (Default value = 0)
:param is_add: (Default value = 1)
:param del_all: (Default value = 0)
"""
return self.api(
vpp_papi.sw_interface_add_del_address,
(sw_if_index, is_add, is_ipv6, del_all, addr_len, addr))
def sw_interface_enable_disable_mpls(self, sw_if_index, is_enable=1):
"""
Enable/Disable MPLS on the interface
:param sw_if_index:
:param is_enable: (Default value = 1)
"""
return self.api(vpp_papi.sw_interface_set_mpls_enable,
(sw_if_index, is_enable))
def sw_interface_ra_suppress(self, sw_if_index):
suppress = 1
managed = 0
other = 0
ll_option = 0
send_unicast = 0
cease = 0
is_no = 0
default_router = 0
max_interval = 0
min_interval = 0
lifetime = 0
initial_count = 0
initial_interval = 0
async = False
return self.api(
vpp_papi.sw_interface_ip6nd_ra_config,
(sw_if_index, suppress, managed, other, ll_option, send_unicast,
cease, is_no, default_router, max_interval, min_interval,
lifetime, initial_count, initial_interval, async))
def vxlan_add_del_tunnel(self,
src_addr,
dst_addr,
is_add=1,
is_ipv6=0,
encap_vrf_id=0,
decap_next_index=0xFFFFFFFF,
vni=0):
"""
:param dst_addr:
:param src_addr:
:param is_add: (Default value = 1)
:param is_ipv6: (Default value = 0)
:param encap_vrf_id: (Default value = 0)
:param decap_next_index: (Default value = 0xFFFFFFFF)
:param vni: (Default value = 0)
"""
return self.api(vpp_papi.vxlan_add_del_tunnel,
(is_add, is_ipv6, src_addr, dst_addr, encap_vrf_id,
decap_next_index, vni))
def bridge_domain_add_del(self,
bd_id,
flood=1,
uu_flood=1,
forward=1,
learn=1,
arp_term=0,
is_add=1):
"""Create/delete bridge domain.
:param int bd_id: Bridge domain index.
:param int flood: Enable/disable bcast/mcast flooding in the BD.
(Default value = 1)
:param int uu_flood: Enable/disable unknown unicast flood in the BD.
(Default value = 1)
:param int forward: Enable/disable forwarding on all interfaces in
the BD. (Default value = 1)
:param int learn: Enable/disable learning on all interfaces in the BD.
(Default value = 1)
:param int arp_term: Enable/disable arp termination in the BD.
(Default value = 1)
:param int is_add: Add or delete flag. (Default value = 1)
"""
return self.api(
vpp_papi.bridge_domain_add_del,
(bd_id, flood, uu_flood, forward, learn, arp_term, is_add))
def l2fib_add_del(self,
mac,
bd_id,
sw_if_index,
is_add=1,
static_mac=0,
filter_mac=0,
bvi_mac=0):
"""Create/delete L2 FIB entry.
:param str mac: MAC address to create FIB entry for.
:param int bd_id: Bridge domain index.
:param int sw_if_index: Software interface index of the interface.
:param int is_add: Add or delete flag. (Default value = 1)
:param int static_mac: Set to 1 to create static MAC entry.
(Default value = 0)
:param int filter_mac: Set to 1 to drop packet that's source or
destination MAC address contains defined MAC address.
(Default value = 0)
:param int bvi_mac: Set to 1 to create entry that points to BVI
interface. (Default value = 0)
"""
return self.api(vpp_papi.l2fib_add_del,
(self._convert_mac(mac), bd_id, sw_if_index, is_add,
static_mac, filter_mac, bvi_mac))
def sw_interface_set_l2_bridge(self,
sw_if_index,
bd_id,
shg=0,
bvi=0,
enable=1):
"""Add/remove interface to/from bridge domain.
:param int sw_if_index: Software interface index of the interface.
:param int bd_id: Bridge domain index.
:param int shg: Split-horizon group index. (Default value = 0)
:param int bvi: Set interface as a bridge group virtual interface.
(Default value = 0)
:param int enable: Add or remove interface. (Default value = 1)
"""
return self.api(vpp_papi.sw_interface_set_l2_bridge,
(sw_if_index, bd_id, shg, bvi, enable))
def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
enable):
"""Create or delete unidirectional cross-connect from Tx interface to
Rx interface.
:param int rx_sw_if_index: Software interface index of Rx interface.
:param int tx_sw_if_index: Software interface index of Tx interface.
:param int enable: Create cross-connect if equal to 1, delete
cross-connect if equal to 0.
"""
return self.api(vpp_papi.sw_interface_set_l2_xconnect,
(rx_sw_if_index, tx_sw_if_index, enable))
def sw_interface_set_l2_tag_rewrite(self,
sw_if_index,
vtr_oper,
push=0,
tag1=0,
tag2=0):
"""L2 interface vlan tag rewrite configure request
:param client_index - opaque cookie to identify the sender
:param context - sender context, to match reply w/ request
:param sw_if_index - interface the operation is applied to
:param vtr_op - Choose from l2_vtr_op_t enum values
:param push_dot1q - first pushed flag dot1q id set, else dot1ad
:param tag1 - Needed for any push or translate vtr op
:param tag2 - Needed for any push 2 or translate x-2 vtr ops
"""
return self.api(vpp_papi.l2_interface_vlan_tag_rewrite,
(sw_if_index, vtr_oper, push, tag1, tag2))
def sw_interface_set_flags(self,
sw_if_index,
admin_up_down,
link_up_down=0,
deleted=0):
"""
:param admin_up_down:
:param sw_if_index:
:param link_up_down: (Default value = 0)
:param deleted: (Default value = 0)
"""
return self.api(vpp_papi.sw_interface_set_flags,
(sw_if_index, admin_up_down, link_up_down, deleted))
def create_subif(self,
sw_if_index,
sub_id,
outer_vlan,
inner_vlan,
no_tags=0,
one_tag=0,
two_tags=0,
dot1ad=0,
exact_match=0,
default_sub=0,
outer_vlan_id_any=0,
inner_vlan_id_any=0):
"""Create subinterface
from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
:param sub_id: param inner_vlan:
:param sw_if_index:
:param outer_vlan:
:param inner_vlan:
:param no_tags: (Default value = 0)
:param one_tag: (Default value = 0)
:param two_tags: (Default value = 0)
:param dot1ad: (Default value = 0)
:param exact_match: (Default value = 0)
:param default_sub: (Default value = 0)
:param outer_vlan_id_any: (Default value = 0)
:param inner_vlan_id_any: (Default value = 0)
"""
return self.api(vpp_papi.create_subif,
(sw_if_index, sub_id, no_tags, one_tag, two_tags,
dot1ad, exact_match, default_sub, outer_vlan_id_any,
inner_vlan_id_any, outer_vlan, inner_vlan))
def delete_subif(self, sw_if_index):
"""Delete subinterface
:param sw_if_index:
"""
return self.api(vpp_papi.delete_subif, ([sw_if_index]))
def create_vlan_subif(self, sw_if_index, vlan):
"""
:param vlan:
:param sw_if_index:
"""
return self.api(vpp_papi.create_vlan_subif, (sw_if_index, vlan))
def create_loopback(self, mac=''):
"""
:param mac: (Optional)
"""
return self.api(vpp_papi.create_loopback, (mac, ))
def ip_add_del_route(self,
dst_address,
dst_address_length,
next_hop_address,
next_hop_sw_if_index=0xFFFFFFFF,
table_id=0,
resolve_attempts=0,
classify_table_index=0xFFFFFFFF,
next_hop_out_label=MPLS_LABEL_INVALID,
next_hop_table_id=0,
create_vrf_if_needed=0,
resolve_if_needed=0,
is_add=1,
is_drop=0,
is_unreach=0,
is_prohibit=0,
is_ipv6=0,
is_local=0,
is_classify=0,
is_multipath=0,
is_resolve_host=0,
is_resolve_attached=0,
not_last=0,
next_hop_weight=1):
"""
:param dst_address_length:
:param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
:param dst_address:
:param next_hop_address:
:param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
:param vrf_id: (Default value = 0)
:param lookup_in_vrf: (Default value = 0)
:param resolve_attempts: (Default value = 0)
:param classify_table_index: (Default value = 0xFFFFFFFF)
:param create_vrf_if_needed: (Default value = 0)
:param resolve_if_needed: (Default value = 0)
:param is_add: (Default value = 1)
:param is_drop: (Default value = 0)
:param is_ipv6: (Default value = 0)
:param is_local: (Default value = 0)
:param is_classify: (Default value = 0)
:param is_multipath: (Default value = 0)
:param is_resolve_host: (Default value = 0)
:param is_resolve_attached: (Default value = 0)
:param not_last: (Default value = 0)
:param next_hop_weight: (Default value = 1)
"""
return self.api(
vpp_papi.ip_add_del_route,
(next_hop_sw_if_index, table_id, resolve_attempts,
classify_table_index, next_hop_out_label, next_hop_table_id,
create_vrf_if_needed, resolve_if_needed, is_add, is_drop,
is_unreach, is_prohibit, is_ipv6, is_local, is_classify,
is_multipath, is_resolve_host, is_resolve_attached, not_last,
next_hop_weight, dst_address_length, dst_address,
next_hop_address))
def ip_neighbor_add_del(
self,
sw_if_index,
mac_address,
dst_address,
vrf_id=0,
is_add=1,
is_ipv6=0,
is_static=0,
):
""" Add neighbor MAC to IPv4 or IPv6 address.
:param sw_if_index:
:param mac_address:
:param dst_address:
:param vrf_id: (Default value = 0)
:param is_add: (Default value = 1)
:param is_ipv6: (Default value = 0)
:param is_static: (Default value = 0)
"""
return self.api(vpp_papi.ip_neighbor_add_del,
(vrf_id, sw_if_index, is_add, is_ipv6, is_static,
mac_address, dst_address))
def sw_interface_span_enable_disable(self,
sw_if_index_from,
sw_if_index_to,
enable=1):
"""
:param sw_if_index_from:
:param sw_if_index_to:
:param enable
"""
return self.api(vpp_papi.sw_interface_span_enable_disable,
(sw_if_index_from, sw_if_index_to, enable))
def gre_tunnel_add_del(self,
src_address,
dst_address,
outer_fib_id=0,
is_teb=0,
is_add=1,
is_ip6=0):
""" Add a GRE tunnel
:param src_address:
:param dst_address:
:param outer_fib_id: (Default value = 0)
:param is_add: (Default value = 1)
:param is_ipv6: (Default value = 0)
:param is_teb: (Default value = 0)
"""
return self.api(
vpp_papi.gre_add_del_tunnel,
(is_add, is_ip6, is_teb, src_address, dst_address, outer_fib_id))
options = option_loader.from_json_and_command_line(json_path)
options.restore = True
elif choice == 'n':
options.restore = True
elif choice == 'a':
sys.exit(2)
else:
options.restore = False
option_loader.save_as_json(options)
if options.seed is not None:
torch.random.manual_seed(options.seed)
data = Data.from_options(options)
generator = Generator.from_options(options)
discriminator = Discriminator.from_options(options)
loss = Loss.from_options(options, discriminator)
noise = Noise.from_options(options)
hooks = Hook.from_options(options)
statistics = Statistics.from_options(options)
snapshot = Snapshot.from_options(options)
evaluation = Evaluation.from_options(options)
game = Game.from_options(options, generator, discriminator, loss, hooks)
for _ in range(options.epochs):
losses = game.run_epoch(data, noise)
statistics.log(losses)
snapshot.save(data, noise, generator)
if evaluation.has_improved(losses):
torch.save(generator.state_dict(), os.path.join(options.model_dir, options.experiment, 'generator.pt'))
torch.save(discriminator.state_dict(), os.path.join(options.model_dir, options.experiment, 'discriminator.pt'))
if platform.system() == 'Linux':
print('If the screen brightness is not restored properly after '
'exit, specify\nin atexit.sh how reset your screen '
'calibration.\n')
atexit_sh = os.path.join(app_path, 'atexit.sh')
if not os.path.isfile(atexit_sh):
with open(atexit_sh, mode='w') as f:
f.write('#!/bin/bash\n')
f.write('# This script is executed when the app exits.\n')
f.write('#\n')
f.write('# Examples:\n')
f.write('# xgamma -gamma 1.0\n')
f.write('# xcalib -display $DISPLAY -screen 0 '
'~/path/to/profile.icc\n')
f.write('# xrandr --output DVI-0 --gamma 1.0:1.0:1.0\n')
os.chmod(atexit_sh, 0o755)
def call_atexit_sh():
if platform.system() == 'Linux':
subprocess.check_call([atexit_sh])
atexit.register(call_atexit_sh)
print("PLEASE CLOSE THE APP WITH CTRL+C!\n")
with Hook(app, enable=app.enable_hook):
app.run()
class VppPapiProvider(object):
"""VPP-api provider using vpp-papi
@property hook: hook object providing before and after api/cli hooks
"""
def __init__(self, name, shm_prefix):
self.hook = Hook("vpp-papi-provider")
self.name = name
self.shm_prefix = shm_prefix
def register_hook(self, hook):
"""Replace hook registration with new hook
:param hook:
"""
self.hook = hook
def connect(self):
"""Connect the API to VPP"""
vpp_papi.connect(self.name, self.shm_prefix)
def disconnect(self):
"""Disconnect the API from VPP"""
vpp_papi.disconnect()
def api(self, api_fn, api_args, expected_retval=0):
"""Call API function and check it's return value
Call the appropriate hooks before and after the API call
:param api_fn: API function to call
:param api_args: tuple of API function arguments
:param expected_retval: Expected return value (Default value = 0)
:returns: reply from the API
"""
self.hook.before_api(api_fn.__name__, api_args)
reply = api_fn(*api_args)
if hasattr(reply, 'retval') and reply.retval != expected_retval:
msg = "API call failed, expected retval == %d, got %s" % (
expected_retval, repr(reply))
error(msg)
raise Exception(msg)
self.hook.after_api(api_fn.__name__, api_args)
return reply
def cli(self, cli):
"""Execute a CLI, calling the before/after hooks appropriately
:param cli: CLI to execute
:returns: CLI output
"""
self.hook.before_cli(cli)
cli += '\n'
r = vpp_papi.cli_inband(len(cli), cli)
self.hook.after_cli(cli)
if (hasattr(r, 'reply')):
return r.reply[0].decode().rstrip('\x00')
def show_version(self):
""" """
return vpp_papi.show_version()
def pg_create_interface(self, pg_index):
"""
:param pg_index:
"""
return self.api(vpp_papi.pg_create_interface, (pg_index, ))
def sw_interface_dump(self, filter=None):
"""
:param filter: (Default value = None)
"""
if filter is not None:
args = (1, filter)
else:
args = (0, b'')
return self.api(vpp_papi.sw_interface_dump, args)
def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
"""
Set the IPvX Table-id for the Interface
:param sw_if_index:
:param is_ipv6:
:param table_id:
"""
return self.api(vpp_papi.sw_interface_set_table,
(sw_if_index, is_ipv6, table_id))
def sw_interface_add_del_address(self,
sw_if_index,
addr,
addr_len,
is_ipv6=0,
is_add=1,
del_all=0):
"""
:param addr: param is_ipv6: (Default value = 0)
:param sw_if_index:
:param addr_len:
:param is_ipv6: (Default value = 0)
:param is_add: (Default value = 1)
:param del_all: (Default value = 0)
"""
return self.api(
vpp_papi.sw_interface_add_del_address,
(sw_if_index, is_add, is_ipv6, del_all, addr_len, addr))
def sw_interface_enable_disable_mpls(self, sw_if_index, is_enable=1):
"""
Enable/Disable MPLS on the interface
:param sw_if_index:
:param is_enable: (Default value = 1)
"""
return self.api(vpp_papi.sw_interface_set_mpls_enable,
(sw_if_index, is_enable))
def sw_interface_ra_suppress(self, sw_if_index):
suppress = 1
managed = 0
other = 0
ll_option = 0
send_unicast = 0
cease = 0
is_no = 0
default_router = 0
max_interval = 0
min_interval = 0
lifetime = 0
initial_count = 0
initial_interval = 0
async = False
return self.api(
vpp_papi.sw_interface_ip6nd_ra_config,
(sw_if_index, suppress, managed, other, ll_option, send_unicast,
cease, is_no, default_router, max_interval, min_interval,
lifetime, initial_count, initial_interval, async))
def vxlan_add_del_tunnel(self,
src_addr,
dst_addr,
is_add=1,
is_ipv6=0,
encap_vrf_id=0,
decap_next_index=0xFFFFFFFF,
vni=0):
"""
:param dst_addr:
:param src_addr:
:param is_add: (Default value = 1)
:param is_ipv6: (Default value = 0)
:param encap_vrf_id: (Default value = 0)
:param decap_next_index: (Default value = 0xFFFFFFFF)
:param vni: (Default value = 0)
"""
return self.api(vpp_papi.vxlan_add_del_tunnel,
(is_add, is_ipv6, src_addr, dst_addr, encap_vrf_id,
decap_next_index, vni))
def sw_interface_set_l2_bridge(self,
sw_if_index,
bd_id,
shg=0,
bvi=0,
enable=1):
"""
:param bd_id:
:param sw_if_index:
:param shg: (Default value = 0)
:param bvi: (Default value = 0)
:param enable: (Default value = 1)
"""
return self.api(vpp_papi.sw_interface_set_l2_bridge,
(sw_if_index, bd_id, shg, bvi, enable))
def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
enable):
"""Create or delete unidirectional cross-connect from Tx interface to
Rx interface.
:param rx_sw_if_index: Software interface index of Rx interface.
:param tx_sw_if_index: Software interface index of Tx interface.
:param enable: Create cross-connect if equal to 1, delete cross-connect
if equal to 0.
:type rx_sw_if_index: str or int
:type rx_sw_if_index: str or int
:type enable: int
"""
return self.api(vpp_papi.sw_interface_set_l2_xconnect,
(rx_sw_if_index, tx_sw_if_index, enable))
def sw_interface_set_flags(self,
sw_if_index,
admin_up_down,
link_up_down=0,
deleted=0):
"""
:param admin_up_down:
:param sw_if_index:
:param link_up_down: (Default value = 0)
:param deleted: (Default value = 0)
"""
return self.api(vpp_papi.sw_interface_set_flags,
(sw_if_index, admin_up_down, link_up_down, deleted))
def create_subif(self,
sw_if_index,
sub_id,
outer_vlan,
inner_vlan,
no_tags=0,
one_tag=0,
two_tags=0,
dot1ad=0,
exact_match=0,
default_sub=0,
outer_vlan_id_any=0,
inner_vlan_id_any=0):
"""Create subinterface
from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
:param sub_id: param inner_vlan:
:param sw_if_index:
:param outer_vlan:
:param inner_vlan:
:param no_tags: (Default value = 0)
:param one_tag: (Default value = 0)
:param two_tags: (Default value = 0)
:param dot1ad: (Default value = 0)
:param exact_match: (Default value = 0)
:param default_sub: (Default value = 0)
:param outer_vlan_id_any: (Default value = 0)
:param inner_vlan_id_any: (Default value = 0)
"""
return self.api(vpp_papi.create_subif,
(sw_if_index, sub_id, no_tags, one_tag, two_tags,
dot1ad, exact_match, default_sub, outer_vlan_id_any,
inner_vlan_id_any, outer_vlan, inner_vlan))
def create_vlan_subif(self, sw_if_index, vlan):
"""
:param vlan:
:param sw_if_index:
"""
return self.api(vpp_papi.create_vlan_subif, (sw_if_index, vlan))
def ip_add_del_route(self,
dst_address,
dst_address_length,
next_hop_address,
next_hop_sw_if_index=0xFFFFFFFF,
table_id=0,
resolve_attempts=0,
classify_table_index=0xFFFFFFFF,
next_hop_out_label=MPLS_LABEL_INVALID,
next_hop_table_id=0,
create_vrf_if_needed=0,
resolve_if_needed=0,
is_add=1,
is_drop=0,
is_unreach=0,
is_prohibit=0,
is_ipv6=0,
is_local=0,
is_classify=0,
is_multipath=0,
is_resolve_host=0,
is_resolve_attached=0,
not_last=0,
next_hop_weight=1):
"""
:param dst_address_length:
:param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
:param dst_address:
:param next_hop_address:
:param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
:param vrf_id: (Default value = 0)
:param lookup_in_vrf: (Default value = 0)
:param resolve_attempts: (Default value = 0)
:param classify_table_index: (Default value = 0xFFFFFFFF)
:param create_vrf_if_needed: (Default value = 0)
:param resolve_if_needed: (Default value = 0)
:param is_add: (Default value = 1)
:param is_drop: (Default value = 0)
:param is_ipv6: (Default value = 0)
:param is_local: (Default value = 0)
:param is_classify: (Default value = 0)
:param is_multipath: (Default value = 0)
:param is_resolve_host: (Default value = 0)
:param is_resolve_attached: (Default value = 0)
:param not_last: (Default value = 0)
:param next_hop_weight: (Default value = 1)
"""
return self.api(
vpp_papi.ip_add_del_route,
(next_hop_sw_if_index, table_id, resolve_attempts,
classify_table_index, next_hop_out_label, next_hop_table_id,
create_vrf_if_needed, resolve_if_needed, is_add, is_drop,
is_unreach, is_prohibit, is_ipv6, is_local, is_classify,
is_multipath, is_resolve_host, is_resolve_attached, not_last,
next_hop_weight, dst_address_length, dst_address,
next_hop_address))
def test_hook(self):
hook = Hook(self.hook_pin)
def __init__(self, display=None, desktops=None, loop=None):
self.log = Log("WM")
# INIT SOME BASIC STUFF
self.hook = Hook()
self.windows = {} # mapping between window id and Window
self.win2desk = {}
if not display:
display = os.environ.get("DISPLAY")
try:
self._conn = xcffib.connect(display=display)
except xcffib.ConnectionException:
sys.exit("cannot connect to %s" % display)
self.atoms = AtomVault(self._conn)
self.desktops = desktops or [Desktop()]
self.cur_desktop = self.desktops[0]
self.cur_desktop.show()
# CREATE ROOT WINDOW
xcb_setup = self._conn.get_setup()
xcb_screens = [i for i in xcb_setup.roots]
self.xcb_default_screen = xcb_screens[self._conn.pref_screen]
root_wid = self.xcb_default_screen.root
self.root = Window(self, wid=root_wid, atoms=self.atoms, mapped=True)
self.windows[root_wid] = self.root
# for desktop in self.desktops:
# desktop.windows.append(self.root)
self.root.set_attr(
eventmask=(
EventMask.StructureNotify
| EventMask.SubstructureNotify
| EventMask.FocusChange
# | EventMask.SubstructureRedirect
| EventMask.EnterWindow
# | EventMask.LeaveWindow
# | EventMask.PropertyChange
| EventMask.OwnerGrabButton
)
)
# INFORM X WHICH FEATURES WE SUPPORT
self.root.props[self.atoms._NET_SUPPORTED] = [self.atoms[a] for a in SUPPORTED_ATOMS]
# PRETEND TO BE A WINDOW MANAGER
supporting_wm_check_window = self.create_window(-1, -1, 1, 1)
supporting_wm_check_window.props['_NET_WM_NAME'] = "SWM"
self.root.props['_NET_SUPPORTING_WM_CHECK'] = supporting_wm_check_window.wid
self.root.props['_NET_NUMBER_OF_DESKTOPS'] = len(self.desktops)
self.root.props['_NET_CURRENT_DESKTOP'] = 0
# TODO: set cursor
# EVENTS THAT HAVE LITTLE USE FOR US...
self.ignoreEvents = {
"KeyRelease",
"ReparentNotify",
# "CreateNotify",
# DWM handles this to help "broken focusing windows".
# "MapNotify",
"ConfigureNotify",
"LeaveNotify",
"FocusOut",
"FocusIn",
"NoExposure",
}
# KEYBOARD
self.kbd = Keyboard(xcb_setup, self._conn)
self.mouse = Mouse(conn=self._conn, root=self.root)
# FLUSH XCB BUFFER
self.xsync() # apply settings
# the event loop is not yet there, but we might have some pending
# events...
self._xpoll()
# TODO: self.grabMouse
# NOW IT'S TIME TO GET PHYSICAL SCREEN CONFIGURATION
self.xrandr = Xrandr(root=self.root, conn=self._conn)
# TODO: self.update_net_desktops()
# SETUP EVENT LOOP
if not loop:
loop = asyncio.new_event_loop()
self._eventloop = loop
self._eventloop.add_signal_handler(signal.SIGINT, self.stop)
self._eventloop.add_signal_handler(signal.SIGTERM, self.stop)
self._eventloop.add_signal_handler(signal.SIGCHLD, self.on_sigchld)
self._eventloop.set_exception_handler(
lambda loop, ctx: self.log.error(
"Got an exception in {}: {}".format(loop, ctx))
)
fd = self._conn.get_file_descriptor()
self._eventloop.add_reader(fd, self._xpoll)
# HANDLE STANDARD EVENTS
self.hook.register("MapRequest", self.on_map_request)
self.hook.register("MapNotify", self.on_map_notify)
self.hook.register("UnmapNotify", self.on_window_unmap)
self.hook.register("KeyPress", self.on_key_press)
# self.hook.register("KeyRelease", self.on_key_release)
# self.hook.register("CreateNotify", self.on_window_create)
self.hook.register("PropertyNotify", self.on_property_notify)
self.hook.register("ClientMessage", self.on_client_message)
self.hook.register("DestroyNotify", self.on_window_destroy)
self.hook.register("EnterNotify", self.on_window_enter)
self.hook.register("ConfigureRequest", self.on_configure_window)
self.hook.register("MotionNotify", self.on_mouse_event)
self.hook.register("ButtonPress", self.on_mouse_event)
self.hook.register("ButtonRelease", self.on_mouse_event)
class VppPapiProvider(object):
"""VPP-api provider using vpp-papi
@property hook: hook object providing before and after api/cli hooks
"""
def __init__(self, name, shm_prefix, test_class):
self.hook = Hook("vpp-papi-provider")
self.name = name
self.shm_prefix = shm_prefix
self.test_class = test_class
jsonfiles = []
install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
for root, dirnames, filenames in os.walk(install_dir):
for filename in fnmatch.filter(filenames, '*.api.json'):
jsonfiles.append(os.path.join(root, filename))
self.papi = VPP(jsonfiles)
self._events = deque()
def register_hook(self, hook):
"""Replace hook registration with new hook
:param hook:
"""
self.hook = hook
def collect_events(self):
""" Collect all events from the internal queue and clear the queue. """
e = self._events
self._events = deque()
return e
def wait_for_event(self, timeout, name=None):
""" Wait for and return next event. """
if self._events:
self.test_class.logger.debug("Not waiting, event already queued")
limit = time.time() + timeout
while time.time() < limit:
if self._events:
e = self._events.popleft()
if name and type(e).__name__ != name:
raise Exception(
"Unexpected event received: %s, expected: %s" %
(type(e).__name__, name))
self.test_class.logger.debug("Returning event %s:%s" %
(name, e))
return e
time.sleep(0) # yield
if name is not None:
raise Exception("Event %s did not occur within timeout" % name)
raise Exception("Event did not occur within timeout")
def __call__(self, name, event):
""" Enqueue event in the internal event queue. """
# FIXME use the name instead of relying on type(e).__name__ ?
# FIXME #2 if this throws, it is eaten silently, Ole?
self.test_class.logger.debug("New event: %s: %s" % (name, event))
self._events.append(event)
def connect(self):
"""Connect the API to VPP"""
self.papi.connect(self.name, self.shm_prefix)
self.papi.register_event_callback(self)
def disconnect(self):
"""Disconnect the API from VPP"""
self.papi.disconnect()
def api(self, api_fn, api_args, expected_retval=0):
""" Call API function and check it's return value.
Call the appropriate hooks before and after the API call
:param api_fn: API function to call
:param api_args: tuple of API function arguments
:param expected_retval: Expected return value (Default value = 0)
:returns: reply from the API
"""
self.hook.before_api(api_fn.__name__, api_args)
reply = api_fn(**api_args)
if hasattr(reply, 'retval') and reply.retval != expected_retval:
msg = "API call failed, expected retval == %d, got %s" % (
expected_retval, repr(reply))
self.test_class.logger.info(msg)
raise Exception(msg)
self.hook.after_api(api_fn.__name__, api_args)
return reply
def cli(self, cli):
""" Execute a CLI, calling the before/after hooks appropriately.
:param cli: CLI to execute
:returns: CLI output
"""
self.hook.before_cli(cli)
cli += '\n'
r = self.papi.cli_inband(length=len(cli), cmd=cli)
self.hook.after_cli(cli)
if hasattr(r, 'reply'):
return r.reply.decode().rstrip('\x00')
def ppcli(self, cli):
""" Helper method to print CLI command in case of info logging level.
:param cli: CLI to execute
:returns: CLI output
"""
return cli + "\n" + str(self.cli(cli))
def _convert_mac(self, mac):
return int(mac.replace(":", ""), 16) << 16
def show_version(self):
""" """
return self.papi.show_version()
def pg_create_interface(self, pg_index):
"""
:param pg_index:
"""
return self.api(self.papi.pg_create_interface,
{"interface_id": pg_index})
def sw_interface_dump(self, filter=None):
"""
:param filter: (Default value = None)
"""
if filter is not None:
args = {"name_filter_valid": 1, "name_filter": filter}
else:
args = {}
return self.api(self.papi.sw_interface_dump, args)
def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
""" Set the IPvX Table-id for the Interface
:param sw_if_index:
:param is_ipv6:
:param table_id:
"""
return self.api(self.papi.sw_interface_set_table,
{'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
'vrf_id': table_id})
def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
is_ipv6=0, is_add=1, del_all=0):
"""
:param addr: param is_ipv6: (Default value = 0)
:param sw_if_index:
:param addr_len:
:param is_ipv6: (Default value = 0)
:param is_add: (Default value = 1)
:param del_all: (Default value = 0)
"""
return self.api(self.papi.sw_interface_add_del_address,
{'sw_if_index': sw_if_index,
'is_add': is_add,
'is_ipv6': is_ipv6,
'del_all': del_all,
'address_length': addr_len,
'address': addr})
def sw_interface_enable_disable_mpls(self, sw_if_index,
is_enable=1):
"""
Enable/Disable MPLS on the interface
:param sw_if_index:
:param is_enable: (Default value = 1)
"""
return self.api(self.papi.sw_interface_set_mpls_enable,
{'sw_if_index': sw_if_index,
'enable': is_enable})
def sw_interface_ra_suppress(self, sw_if_index):
return self.api(self.papi.sw_interface_ip6nd_ra_config,
{'sw_if_index': sw_if_index})
def vxlan_add_del_tunnel(
self,
src_addr,
dst_addr,
mcast_sw_if_index=0xFFFFFFFF,
is_add=1,
is_ipv6=0,
encap_vrf_id=0,
decap_next_index=0xFFFFFFFF,
vni=0):
"""
:param dst_addr:
:param src_addr:
:param is_add: (Default value = 1)
:param is_ipv6: (Default value = 0)
:param encap_vrf_id: (Default value = 0)
:param decap_next_index: (Default value = 0xFFFFFFFF)
:param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
:param vni: (Default value = 0)
"""
return self.api(self.papi.vxlan_add_del_tunnel,
{'is_add': is_add,
'is_ipv6': is_ipv6,
'src_address': src_addr,
'dst_address': dst_addr,
'mcast_sw_if_index': mcast_sw_if_index,
'encap_vrf_id': encap_vrf_id,
'decap_next_index': decap_next_index,
'vni': vni})
def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
learn=1, arp_term=0, is_add=1):
"""Create/delete bridge domain.
:param int bd_id: Bridge domain index.
:param int flood: Enable/disable bcast/mcast flooding in the BD.
(Default value = 1)
:param int uu_flood: Enable/disable unknown unicast flood in the BD.
(Default value = 1)
:param int forward: Enable/disable forwarding on all interfaces in
the BD. (Default value = 1)
:param int learn: Enable/disable learning on all interfaces in the BD.
(Default value = 1)
:param int arp_term: Enable/disable arp termination in the BD.
(Default value = 1)
:param int is_add: Add or delete flag. (Default value = 1)
"""
return self.api(self.papi.bridge_domain_add_del,
{'bd_id': bd_id,
'flood': flood,
'uu_flood': uu_flood,
'forward': forward,
'learn': learn,
'arp_term': arp_term,
'is_add': is_add})
def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
filter_mac=0, bvi_mac=0):
"""Create/delete L2 FIB entry.
:param str mac: MAC address to create FIB entry for.
:param int bd_id: Bridge domain index.
:param int sw_if_index: Software interface index of the interface.
:param int is_add: Add or delete flag. (Default value = 1)
:param int static_mac: Set to 1 to create static MAC entry.
(Default value = 0)
:param int filter_mac: Set to 1 to drop packet that's source or
destination MAC address contains defined MAC address.
(Default value = 0)
:param int bvi_mac: Set to 1 to create entry that points to BVI
interface. (Default value = 0)
"""
return self.api(self.papi.l2fib_add_del,
{'mac': self._convert_mac(mac),
'bd_id': bd_id,
'sw_if_index': sw_if_index,
'is_add': is_add,
'static_mac': static_mac,
'filter_mac': filter_mac,
'bvi_mac': bvi_mac})
def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
shg=0, bvi=0, enable=1):
"""Add/remove interface to/from bridge domain.
:param int sw_if_index: Software interface index of the interface.
:param int bd_id: Bridge domain index.
:param int shg: Split-horizon group index. (Default value = 0)
:param int bvi: Set interface as a bridge group virtual interface.
(Default value = 0)
:param int enable: Add or remove interface. (Default value = 1)
"""
return self.api(self.papi.sw_interface_set_l2_bridge,
{'rx_sw_if_index': sw_if_index,
'bd_id': bd_id,
'shg': shg,
'bvi': bvi,
'enable': enable})
def bridge_flags(self, bd_id, is_set, feature_bitmap):
"""Enable/disable required feature of the bridge domain with defined ID.
:param int bd_id: Bridge domain ID.
:param int is_set: Set to 1 to enable, set to 0 to disable the feature.
:param int feature_bitmap: Bitmap value of the feature to be set:
- learn (1 << 0),
- forward (1 << 1),
- flood (1 << 2),
- uu-flood (1 << 3) or
- arp-term (1 << 4).
"""
return self.api(self.papi.bridge_flags,
{'bd_id': bd_id,
'is_set': is_set,
'feature_bitmap': feature_bitmap})
def bridge_domain_dump(self, bd_id=0):
"""
:param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
existing bridge domains returned)
:return: Dictionary of bridge domain(s) data.
"""
return self.api(self.papi.bridge_domain_dump,
{'bd_id': bd_id})
def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
enable):
"""Create or delete unidirectional cross-connect from Tx interface to
Rx interface.
:param int rx_sw_if_index: Software interface index of Rx interface.
:param int tx_sw_if_index: Software interface index of Tx interface.
:param int enable: Create cross-connect if equal to 1, delete
cross-connect if equal to 0.
"""
return self.api(self.papi.sw_interface_set_l2_xconnect,
{'rx_sw_if_index': rx_sw_if_index,
'tx_sw_if_index': tx_sw_if_index,
'enable': enable})
def sw_interface_set_l2_tag_rewrite(
self,
sw_if_index,
vtr_oper,
push=0,
tag1=0,
tag2=0):
"""L2 interface vlan tag rewrite configure request
:param client_index - opaque cookie to identify the sender
:param context - sender context, to match reply w/ request
:param sw_if_index - interface the operation is applied to
:param vtr_op - Choose from l2_vtr_op_t enum values
:param push_dot1q - first pushed flag dot1q id set, else dot1ad
:param tag1 - Needed for any push or translate vtr op
:param tag2 - Needed for any push 2 or translate x-2 vtr ops
"""
return self.api(self.papi.l2_interface_vlan_tag_rewrite,
{'sw_if_index': sw_if_index,
'vtr_op': vtr_oper,
'push_dot1q': push,
'tag1': tag1,
'tag2': tag2})
def sw_interface_set_flags(self, sw_if_index, admin_up_down,
link_up_down=0, deleted=0):
"""
:param admin_up_down:
:param sw_if_index:
:param link_up_down: (Default value = 0)
:param deleted: (Default value = 0)
"""
return self.api(self.papi.sw_interface_set_flags,
{'sw_if_index': sw_if_index,
'admin_up_down': admin_up_down,
'link_up_down': link_up_down,
'deleted': deleted})
def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
"""Create subinterface
from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
:param sub_id: param inner_vlan:
:param sw_if_index:
:param outer_vlan:
:param inner_vlan:
:param no_tags: (Default value = 0)
:param one_tag: (Default value = 0)
:param two_tags: (Default value = 0)
:param dot1ad: (Default value = 0)
:param exact_match: (Default value = 0)
:param default_sub: (Default value = 0)
:param outer_vlan_id_any: (Default value = 0)
:param inner_vlan_id_any: (Default value = 0)
"""
return self.api(
self.papi.create_subif,
{'sw_if_index': sw_if_index,
'sub_id': sub_id,
'no_tags': no_tags,
'one_tag': one_tag,
'two_tags': two_tags,
'dot1ad': dot1ad,
'exact_match': exact_match,
'default_sub': default_sub,
'outer_vlan_id_any': outer_vlan_id_any,
'inner_vlan_id_any': inner_vlan_id_any,
'outer_vlan_id': outer_vlan,
'inner_vlan_id': inner_vlan})
def delete_subif(self, sw_if_index):
"""Delete subinterface
:param sw_if_index:
"""
return self.api(self.papi.delete_subif,
{'sw_if_index': sw_if_index})
def create_vlan_subif(self, sw_if_index, vlan):
"""
:param vlan:
:param sw_if_index:
"""
return self.api(self.papi.create_vlan_subif,
{'sw_if_index': sw_if_index,
'vlan_id': vlan})
def create_loopback(self, mac=''):
"""
:param mac: (Optional)
"""
return self.api(self.papi.create_loopback,
{'mac_address': mac})
def ip_add_del_route(
self,
dst_address,
dst_address_length,
next_hop_address,
next_hop_sw_if_index=0xFFFFFFFF,
table_id=0,
next_hop_table_id=0,
next_hop_weight=1,
next_hop_n_out_labels=0,
next_hop_out_label_stack=[],
next_hop_via_label=MPLS_LABEL_INVALID,
create_vrf_if_needed=0,
is_resolve_host=0,
is_resolve_attached=0,
classify_table_index=0xFFFFFFFF,
is_add=1,
is_drop=0,
is_unreach=0,
is_prohibit=0,
is_ipv6=0,
is_local=0,
is_classify=0,
is_multipath=0,
not_last=0):
"""
:param dst_address_length:
:param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
:param dst_address:
:param next_hop_address:
:param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
:param vrf_id: (Default value = 0)
:param lookup_in_vrf: (Default value = 0)
:param classify_table_index: (Default value = 0xFFFFFFFF)
:param create_vrf_if_needed: (Default value = 0)
:param is_add: (Default value = 1)
:param is_drop: (Default value = 0)
:param is_ipv6: (Default value = 0)
:param is_local: (Default value = 0)
:param is_classify: (Default value = 0)
:param is_multipath: (Default value = 0)
:param is_resolve_host: (Default value = 0)
:param is_resolve_attached: (Default value = 0)
:param not_last: (Default value = 0)
:param next_hop_weight: (Default value = 1)
"""
return self.api(
self.papi.ip_add_del_route,
{'next_hop_sw_if_index': next_hop_sw_if_index,
'table_id': table_id,
'classify_table_index': classify_table_index,
'next_hop_table_id': next_hop_table_id,
'create_vrf_if_needed': create_vrf_if_needed,
'is_add': is_add,
'is_drop': is_drop,
'is_unreach': is_unreach,
'is_prohibit': is_prohibit,
'is_ipv6': is_ipv6,
'is_local': is_local,
'is_classify': is_classify,
'is_multipath': is_multipath,
'is_resolve_host': is_resolve_host,
'is_resolve_attached': is_resolve_attached,
'not_last': not_last,
'next_hop_weight': next_hop_weight,
'dst_address_length': dst_address_length,
'dst_address': dst_address,
'next_hop_address': next_hop_address,
'next_hop_n_out_labels': next_hop_n_out_labels,
'next_hop_via_label': next_hop_via_label,
'next_hop_out_label_stack': next_hop_out_label_stack})
def ip_fib_dump(self):
return self.api(self.papi.ip_fib_dump, {})
def ip_neighbor_add_del(self,
sw_if_index,
mac_address,
dst_address,
vrf_id=0,
is_add=1,
is_ipv6=0,
is_static=0,
):
""" Add neighbor MAC to IPv4 or IPv6 address.
:param sw_if_index:
:param mac_address:
:param dst_address:
:param vrf_id: (Default value = 0)
:param is_add: (Default value = 1)
:param is_ipv6: (Default value = 0)
:param is_static: (Default value = 0)
"""
return self.api(
self.papi.ip_neighbor_add_del,
{'vrf_id': vrf_id,
'sw_if_index': sw_if_index,
'is_add': is_add,
'is_ipv6': is_ipv6,
'is_static': is_static,
'mac_address': mac_address,
'dst_address': dst_address
}
)
def sw_interface_span_enable_disable(
self, sw_if_index_from, sw_if_index_to, state=1):
"""
:param sw_if_index_from:
:param sw_if_index_to:
:param state:
"""
return self.api(self.papi.sw_interface_span_enable_disable,
{'sw_if_index_from': sw_if_index_from,
'sw_if_index_to': sw_if_index_to,
'state': state})
def gre_tunnel_add_del(self,
src_address,
dst_address,
outer_fib_id=0,
is_teb=0,
is_add=1,
is_ip6=0):
""" Add a GRE tunnel
:param src_address:
:param dst_address:
:param outer_fib_id: (Default value = 0)
:param is_add: (Default value = 1)
:param is_ipv6: (Default value = 0)
:param is_teb: (Default value = 0)
"""
return self.api(
self.papi.gre_add_del_tunnel,
{'is_add': is_add,
'is_ipv6': is_ip6,
'teb': is_teb,
'src_address': src_address,
'dst_address': dst_address,
'outer_fib_id': outer_fib_id}
)
def mpls_route_add_del(
self,
label,
eos,
next_hop_proto_is_ip4,
next_hop_address,
next_hop_sw_if_index=0xFFFFFFFF,
table_id=0,
next_hop_table_id=0,
next_hop_weight=1,
next_hop_n_out_labels=0,
next_hop_out_label_stack=[],
next_hop_via_label=MPLS_LABEL_INVALID,
create_vrf_if_needed=0,
is_resolve_host=0,
is_resolve_attached=0,
is_add=1,
is_drop=0,
is_multipath=0,
classify_table_index=0xFFFFFFFF,
is_classify=0,
not_last=0):
"""
:param dst_address_length:
:param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
:param dst_address:
:param next_hop_address:
:param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
:param vrf_id: (Default value = 0)
:param lookup_in_vrf: (Default value = 0)
:param classify_table_index: (Default value = 0xFFFFFFFF)
:param create_vrf_if_needed: (Default value = 0)
:param is_add: (Default value = 1)
:param is_drop: (Default value = 0)
:param is_ipv6: (Default value = 0)
:param is_local: (Default value = 0)
:param is_classify: (Default value = 0)
:param is_multipath: (Default value = 0)
:param is_resolve_host: (Default value = 0)
:param is_resolve_attached: (Default value = 0)
:param not_last: (Default value = 0)
:param next_hop_weight: (Default value = 1)
"""
return self.api(
self.papi.mpls_route_add_del,
{'mr_label': label,
'mr_eos': eos,
'mr_table_id': table_id,
'mr_classify_table_index': classify_table_index,
'mr_create_table_if_needed': create_vrf_if_needed,
'mr_is_add': is_add,
'mr_is_classify': is_classify,
'mr_is_multipath': is_multipath,
'mr_is_resolve_host': is_resolve_host,
'mr_is_resolve_attached': is_resolve_attached,
'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
'mr_next_hop_weight': next_hop_weight,
'mr_next_hop': next_hop_address,
'mr_next_hop_n_out_labels': next_hop_n_out_labels,
'mr_next_hop_sw_if_index': next_hop_sw_if_index,
'mr_next_hop_table_id': next_hop_table_id,
'mr_next_hop_via_label': next_hop_via_label,
'mr_next_hop_out_label_stack': next_hop_out_label_stack})
def mpls_ip_bind_unbind(
self,
label,
dst_address,
dst_address_length,
table_id=0,
ip_table_id=0,
is_ip4=1,
create_vrf_if_needed=0,
is_bind=1):
"""
"""
return self.api(
self.papi.mpls_ip_bind_unbind,
{'mb_mpls_table_id': table_id,
'mb_label': label,
'mb_ip_table_id': ip_table_id,
'mb_create_table_if_needed': create_vrf_if_needed,
'mb_is_bind': is_bind,
'mb_is_ip4': is_ip4,
'mb_address_length': dst_address_length,
'mb_address': dst_address})
def mpls_tunnel_add_del(
self,
tun_sw_if_index,
next_hop_proto_is_ip4,
next_hop_address,
next_hop_sw_if_index=0xFFFFFFFF,
next_hop_table_id=0,
next_hop_weight=1,
next_hop_n_out_labels=0,
next_hop_out_label_stack=[],
next_hop_via_label=MPLS_LABEL_INVALID,
create_vrf_if_needed=0,
is_add=1,
l2_only=0):
"""
:param dst_address_length:
:param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
:param dst_address:
:param next_hop_address:
:param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
:param vrf_id: (Default value = 0)
:param lookup_in_vrf: (Default value = 0)
:param classify_table_index: (Default value = 0xFFFFFFFF)
:param create_vrf_if_needed: (Default value = 0)
:param is_add: (Default value = 1)
:param is_drop: (Default value = 0)
:param is_ipv6: (Default value = 0)
:param is_local: (Default value = 0)
:param is_classify: (Default value = 0)
:param is_multipath: (Default value = 0)
:param is_resolve_host: (Default value = 0)
:param is_resolve_attached: (Default value = 0)
:param not_last: (Default value = 0)
:param next_hop_weight: (Default value = 1)
"""
return self.api(
self.papi.mpls_tunnel_add_del,
{'mt_sw_if_index': tun_sw_if_index,
'mt_is_add': is_add,
'mt_l2_only': l2_only,
'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
'mt_next_hop_weight': next_hop_weight,
'mt_next_hop': next_hop_address,
'mt_next_hop_n_out_labels': next_hop_n_out_labels,
'mt_next_hop_sw_if_index': next_hop_sw_if_index,
'mt_next_hop_table_id': next_hop_table_id,
'mt_next_hop_out_label_stack': next_hop_out_label_stack})
def snat_interface_add_del_feature(
self,
sw_if_index,
is_inside=1,
is_add=1):
"""Enable/disable S-NAT feature on the interface
:param sw_if_index: Software index of the interface
:param is_inside: 1 if inside, 0 if outside (Default value = 1)
:param is_add: 1 if add, 0 if delete (Default value = 1)
"""
return self.api(
self.papi.snat_interface_add_del_feature,
{'is_add': is_add,
'is_inside': is_inside,
'sw_if_index': sw_if_index})
def snat_add_static_mapping(
self,
local_ip,
external_ip,
local_port=0,
external_port=0,
addr_only=1,
vrf_id=0,
is_add=1,
is_ip4=1):
"""Add/delete S-NAT static mapping
:param local_ip: Local IP address
:param external_ip: External IP address
:param local_port: Local port number (Default value = 0)
:param external_port: External port number (Default value = 0)
:param addr_only: 1 if address only mapping, 0 if address and port
:param vrf_id: VRF ID
:param is_add: 1 if add, 0 if delete (Default value = 1)
:param is_ip4: 1 if address type is IPv4 (Default value = 1)
"""
return self.api(
self.papi.snat_add_static_mapping,
{'is_add': is_add,
'is_ip4': is_ip4,
'addr_only': addr_only,
'local_ip_address': local_ip,
'external_ip_address': external_ip,
'local_port': local_port,
'external_port': external_port,
'vrf_id': vrf_id})
def snat_add_address_range(
self,
first_ip_address,
last_ip_address,
is_add=1,
is_ip4=1):
"""Add/del S-NAT address range
:param first_ip_address: First IP address
:param last_ip_address: Last IP address
:param is_add: 1 if add, 0 if delete (Default value = 1)
:param is_ip4: 1 if address type is IPv4 (Default value = 1)
"""
return self.api(
self.papi.snat_add_address_range,
{'is_ip4': is_ip4,
'first_ip_address': first_ip_address,
'last_ip_address': last_ip_address,
'is_add': is_add})
def snat_address_dump(self):
"""Dump S-NAT addresses
:return: Dictionary of S-NAT addresses
"""
return self.api(self.papi.snat_address_dump, {})
def snat_interface_dump(self):
"""Dump interfaces with S-NAT feature
:return: Dictionary of interfaces with S-NAT feature
"""
return self.api(self.papi.snat_interface_dump, {})
def snat_static_mapping_dump(self):
"""Dump S-NAT static mappings
:return: Dictionary of S-NAT static mappings
"""
return self.api(self.papi.snat_static_mapping_dump, {})
def snat_show_config(self):
"""Show S-NAT config
:return: S-NAT config parameters
"""
return self.api(self.papi.snat_show_config, {})
def control_ping(self):
self.api(self.papi.control_ping)
def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
detect_mult, local_addr, peer_addr, is_ipv6=0):
return self.api(self.papi.bfd_udp_add,
{
'sw_if_index': sw_if_index,
'desired_min_tx': desired_min_tx,
'required_min_rx': required_min_rx,
'local_addr': local_addr,
'peer_addr': peer_addr,
'is_ipv6': is_ipv6,
'detect_mult': detect_mult,
})
def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
return self.api(self.papi.bfd_udp_del,
{
'sw_if_index': sw_if_index,
'local_addr': local_addr,
'peer_addr': peer_addr,
'is_ipv6': is_ipv6,
})
def bfd_udp_session_dump(self):
return self.api(self.papi.bfd_udp_session_dump, {})
def bfd_session_set_flags(self, bs_idx, admin_up_down):
return self.api(self.papi.bfd_session_set_flags, {
'bs_index': bs_idx,
'admin_up_down': admin_up_down,
})
def want_bfd_events(self, enable_disable=1):
return self.api(self.papi.want_bfd_events, {
'enable_disable': enable_disable,
'pid': os.getpid(),
})
def classify_add_del_table(
self,
is_add,
mask,
match_n_vectors=1,
table_index=0xFFFFFFFF,
nbuckets=2,
memory_size=2097152,
skip_n_vectors=0,
next_table_index=0xFFFFFFFF,
miss_next_index=0xFFFFFFFF,
current_data_flag=0,
current_data_offset=0):
"""
:param is_add:
:param mask:
:param match_n_vectors (Default value = 1):
:param table_index (Default value = 0xFFFFFFFF)
:param nbuckets: (Default value = 2)
:param memory_size: (Default value = 2097152)
:param skip_n_vectors: (Default value = 0)
:param next_table_index: (Default value = 0xFFFFFFFF)
:param miss_next_index: (Default value = 0xFFFFFFFF)
:param current_data_flag: (Default value = 0)
:param current_data_offset: (Default value = 0)
"""
return self.api(
self.papi.classify_add_del_table,
{'is_add' : is_add,
'table_index' : table_index,
'nbuckets' : nbuckets,
'memory_size': memory_size,
'skip_n_vectors' : skip_n_vectors,
'match_n_vectors' : match_n_vectors,
'next_table_index' : next_table_index,
'miss_next_index' : miss_next_index,
'current_data_flag' : current_data_flag,
'current_data_offset' : current_data_offset,
'mask' : mask})
def classify_add_del_session(
self,
is_add,
table_index,
match,
opaque_index=0xFFFFFFFF,
hit_next_index=0xFFFFFFFF,
advance=0,
action=0,
metadata=0):
"""
:param is_add:
:param table_index:
:param match:
:param opaque_index: (Default value = 0xFFFFFFFF)
:param hit_next_index: (Default value = 0xFFFFFFFF)
:param advance: (Default value = 0)
:param action: (Default value = 0)
:param metadata: (Default value = 0)
"""
return self.api(
self.papi.classify_add_del_session,
{'is_add' : is_add,
'table_index' : table_index,
'hit_next_index' : hit_next_index,
'opaque_index' : opaque_index,
'advance' : advance,
'action' : action,
'metadata' : metadata,
'match' : match})
def input_acl_set_interface(
self,
is_add,
sw_if_index,
ip4_table_index=0xFFFFFFFF,
ip6_table_index=0xFFFFFFFF,
l2_table_index=0xFFFFFFFF):
"""
:param is_add:
:param sw_if_index:
:param ip4_table_index: (Default value = 0xFFFFFFFF)
:param ip6_table_index: (Default value = 0xFFFFFFFF)
:param l2_table_index: (Default value = 0xFFFFFFFF)
"""
return self.api(
self.papi.input_acl_set_interface,
{'sw_if_index' : sw_if_index,
'ip4_table_index' : ip4_table_index,
'ip6_table_index' : ip6_table_index,
'l2_table_index' : l2_table_index,
'is_add' : is_add})
