aboutsummaryrefslogtreecommitdiffstats
path: root/vicn/resource/linux/veth_pair.py
blob: 52050074bfae84bf8cca7030cf55c4a2cd0f213f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Copyright (c) 2017 Cisco and/or its affiliates.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

from netmodel.model.key                 import Key
from netmodel.model.type                import String, Bool
from vicn.core.attribute                import Attribute, Reference
from vicn.core.task                     import BashTask, inline_task, get_attributes_task
from vicn.resource.linux.net_device     import NetDevice, NetDeviceName
from vicn.resource.node                 import Node
from vicn.resource.symmetric_channel    import SymmetricChannel

CMD_CREATE='''
# Create veth pair in the host node
ip link add name {self.device_name} type veth peer name {self.peer_device_name}
'''

DEPRECATED_CMD_UP='''
# The host interface will always be up...
ip link set dev {interface.host.device_name} up

# Move interface into container and rename it
ip link set dev {tmp_name} netns {pid} name {interface.device_name}
ip link set dev {interface.device_name} up
'''

# Forward declaration
class VethPair(SymmetricChannel):
    pass

class VethNetDevice(NetDevice):
    parent = Attribute(VethPair, mandatory = True, ro = True)

    __get__ = None
    __create__ = None
    __delete__ = None

class VethPair(SymmetricChannel):
    # Mimics NetDevice for using its __get__ and __delete__ functions
    node = Attribute(Node)
    device_name = Attribute(NetDeviceName)
    peer_device_name = Attribute(NetDeviceName)
    capacity = Attribute(String)
    src = Attribute(ro = True, mandatory = False)
    dst = Attribute(ro = True, mandatory = False)
    auto_commit = Attribute(Bool, description = 'Auto commit interfaces')

    __key1__ = Key(node, device_name)
    __key2__ = Key(node, peer_device_name)

    @inline_task
    def _commit(self):
        if self.auto_commit:
            manager = self._state.manager

            manager.commit_resource(self.src)
            manager.commit_resource(self.dst)

    def __initialize__(self):
        # XXX owner prevents the resource to be committed
        self.src = VethNetDevice(node = self.node,
                parent = self,
                device_name = self.device_name,
                channel = self,
                capacity = Reference(self, 'capacity'),
                owner = self)
        self.dst = VethNetDevice(node = self.node,
                parent = self,
                device_name = self.peer_device_name,
                channel = self,
                capacity = Reference(self, 'capacity'),
                owner = self)

    def __create__(self):
        veth = BashTask(self.node, CMD_CREATE, {'self': self})
        return (veth > super().__create__()) > self._commit()

    def __get__(self):
        return NetDevice.__get__(self) > self._commit()

    def __delete__(self):
        return NetDevice.__delete__(self)