PNG  IHDRxsBIT|d pHYs+tEXtSoftwarewww.inkscape.org<,tEXtComment File Manager

File Manager

Path: /opt/alt/python311/lib/python3.11/site-packages/pyroute2/netlink/rtnl/

Viewing File: iprsocket.py

import errno
import os
import struct
from collections.abc import Callable
from typing import Optional
from unittest import mock

from pyroute2 import config
from pyroute2.common import msg_done
from pyroute2.iproute.ipmock import IPEngine
from pyroute2.netlink import NETLINK_ROUTE, NLM_F_REQUEST, nlmsg, rtnl
from pyroute2.netlink.exceptions import NetlinkError
from pyroute2.netlink.nlsocket import (
    AsyncNetlinkSocket,
    ChaoticNetlinkSocket,
    NetlinkRequest,
    NetlinkSocket,
)
from pyroute2.netlink.rtnl.ifinfmsg.tuntap import manage_tun, manage_tuntap
from pyroute2.netlink.rtnl.marshal import MarshalRtnl
from pyroute2.netlink.rtnl.probe_msg import proxy_newprobe
from pyroute2.netns import setns
from pyroute2.process import ChildProcess, ChildProcessReturnValue


def _run_in_netns(
    netns: str, target: Callable[[nlmsg], bytes], msg: nlmsg
) -> ChildProcessReturnValue:
    setns(netns)
    return ChildProcessReturnValue(target(msg), [])


class IPRouteProxy:
    route: dict[
        int,
        tuple[tuple[Callable[[nlmsg], bool], Callable[[nlmsg], bytes]], ...],
    ] = {
        rtnl.RTM_NEWLINK: (
            (lambda x: x.get(('linkinfo', 'kind')) == 'tuntap', manage_tuntap),
            (lambda x: x.get(('linkinfo', 'kind')) == 'tun', manage_tun),
        ),
        rtnl.RTM_NEWPROBE: ((lambda x: True, proxy_newprobe),),
    }

    def __init__(self, netns: Optional[str] = None):
        self.netns = netns

    def handle(self, msg: nlmsg) -> bytes:
        ret: bytes = b''
        key = msg['header']['type']
        if key not in self.route:
            return ret
        for predicate, target in self.route[key]:
            if predicate(msg):
                try:
                    if self.netns is not None:
                        with ChildProcess(
                            target=_run_in_netns,
                            args=[self.netns, target, msg],
                        ) as proc:
                            ret = proc.get_data(timeout=4)
                    else:
                        ret = target(msg)
                    return ret or msg_done(msg)
                except Exception as e:
                    # errmsg
                    if isinstance(e, (OSError, IOError)):
                        code = e.errno or errno.ENODATA
                    elif isinstance(e, NetlinkError):
                        code = e.code
                    else:
                        code = errno.ECOMM
                    newmsg = struct.pack('HH', 2, 0)
                    newmsg += msg.data[8:16]
                    newmsg += struct.pack('I', code)
                    newmsg += msg.data
                    newmsg = struct.pack('I', len(newmsg) + 4) + newmsg
                    return newmsg
        return b''


class AsyncIPRSocket(AsyncNetlinkSocket):
    '''A low-level class to provide RTNL socket.

    This is a low-level class designed to provide an RTNL
    asyncio-controlled socket. It does not include high-level
    methods like those found in AsyncIPRoute. Instead, it provides
    only common netlink methods such as `get()` and `put()`. For
    more details, refer to the `AsyncNetlinkSocket` documentation.

    .. testcode::
        :hide:

        from pyroute2 import AsyncIPRSocket

        iprsock = AsyncIPRSocket()
        assert callable(iprsock.get)
        assert callable(iprsock.put)
        assert callable(iprsock.nlm_request)
        assert callable(iprsock.bind)

    Since the underlying socket is controlled by asyncio, it is
    not possible to use it in poll/select loops. If you want
    such API, consider using synchronous `IPRSocket`.

    .. warning::

        Your code must process incoming messages quickly enough to
        prevent the RCVBUF from overflowing. If the RCVBUF overflows,
        all subsequent socket operations will raise an OSError:

    .. code::

        >>> [ x async for x in ipr.get() ]
        Traceback (most recent call last):
          File ".../python3.13/futures/_base.py", line 456, in result
            return self.__get_result()
                   ~~~~~~~~~~~~~~~~~^^
          ...
        OSError: [Errno 105] No buffer space available


    If this exception occurs, the only solution is to close the
    socket and create a new one.

    This class does not handle protocol-level error propagation; it
    only provides socket-level error handling. It is the user's
    responsibility to catch and manage protocol-level errors:

    .. testsetup:: as0

        from pyroute2.netlink import nlmsgerr, NLMSG_ERROR
        msg = nlmsgerr()
        msg['header']['type'] = NLMSG_ERROR
        msg['error'] = 42
        msg.reset()
        msg.encode()
        msg.decode()

    .. testcode:: as0

        if msg.get(('header', 'type')) == NLMSG_ERROR:
            # prints error code and the request that
            # triggered the error
            print(
                msg.get('error'),
                msg.get('msg'),
            )

    .. testoutput:: as0
        :hide:

        42 None


    '''

    def __init__(
        self,
        port=None,
        pid=None,
        fileno=None,
        sndbuf=1048576,
        rcvbuf=1048576,
        rcvsize=16384,
        all_ns=False,
        async_qsize=None,
        nlm_generator=None,
        target='localhost',
        ext_ack=False,
        strict_check=False,
        groups=rtnl.RTMGRP_DEFAULTS,
        nlm_echo=False,
        netns=None,
        netns_path=None,
        flags=os.O_CREAT,
        libc=None,
        use_socket=None,
        use_event_loop=None,
        telemetry=None,
        exception_factory=None,
    ):
        if config.mock_netlink:
            use_socket = IPEngine()
            if netns is not None:
                use_socket.netns = netns
            use_socket.flags = flags
            use_socket.initdb()
        self.marshal = MarshalRtnl()
        super().__init__(
            family=NETLINK_ROUTE,
            port=port,
            pid=pid,
            fileno=fileno,
            sndbuf=sndbuf,
            rcvbuf=rcvbuf,
            rcvsize=rcvsize,
            all_ns=all_ns,
            async_qsize=async_qsize,
            nlm_generator=nlm_generator,
            target=target,
            ext_ack=ext_ack,
            strict_check=strict_check,
            groups=groups,
            nlm_echo=nlm_echo,
            use_socket=use_socket,
            netns=netns,
            flags=flags,
            libc=libc,
            use_event_loop=use_event_loop,
            telemetry=telemetry,
            exception_factory=exception_factory,
        )
        if not config.mock_netlink:
            self.request_proxy = IPRouteProxy(netns)
        self.status['netns_path'] = netns_path or config.netns_path

    async def bind(self, groups=None, **kwarg):
        return await super().bind(
            groups if groups is not None else self.status['groups'], **kwarg
        )


class NotLocal:
    event_loop = None
    msg_queue = mock.Mock()


class IPRSocket(NetlinkSocket):
    '''Synchronous select-compatible netlink socket.

    `IPRSocket` is the synchronous counterpart to `AsyncIPRSocket`.
    A key feature of `IPRSocket` is that the underlying netlink
    socket operates out of asyncio control, allowing it to be
    used in poll/select loops.

    .. warning::

        Your code must process incoming messages quickly enough to
        prevent the RCVBUF from overflowing. If the RCVBUF overflows,
        all subsequent socket operations will raise an OSError:

    .. code::

        >>> iprsock.get()
        Traceback (most recent call last):
          File "<python-input-12>", line 1, in <module>
            iprsock.get()
            ~~~~~~~~^^
          File ".../pyroute2/netlink/rtnl/iprsocket.py", line 276, in get
            data = self.socket.recv(16384)
        OSError: [Errno 105] No buffer space available
        >>>

    If this exception occurs, the only solution is to close the
    socket and create a new one.

    Some usage examples:

    .. testcode::

        import select

        from pyroute2 import IPRSocket
        from pyroute2.netlink import NLM_F_DUMP, NLM_F_REQUEST
        from pyroute2.netlink.rtnl import RTM_GETLINK
        from pyroute2.netlink.rtnl.ifinfmsg import ifinfmsg

        with IPRSocket() as iprsock:
            iprsock.put(
                ifinfmsg(),
                msg_type=RTM_GETLINK,
                msg_flags=NLM_F_REQUEST | NLM_F_DUMP
            )

            ret = []

            while True:
                rl, wl, xl = select.select([iprsock], [], [], 0)
                if not len(rl):
                    break
                ret.extend(iprsock.get())

            for link in ret:
                if link.get('event') == 'RTM_NEWLINK':
                    print(
                        link.get('ifname'),
                        link.get('state'),
                        link.get('address'),
                    )

    .. testoutput::

        lo up 00:00:00:00:00:00
        eth0 up 52:54:00:72:58:b2

    Threadless RT netlink monitoring with blocking I/O calls:

        >>> from pyroute2 import IPRSocket
        >>> from pprint import pprint
        >>> s = IPRSocket()
        >>> s.bind()
        >>> pprint(s.get())
        [{'attrs': [('RTA_TABLE', 254),
                    ('RTA_OIF', 2),
                    ('RTA_GATEWAY', '192.168.122.1')],
          'dst_len': 0,
          'event': 'RTM_NEWROUTE',
          'family': 2,
          'flags': 0,
          'header': {'error': None,
                     'flags': 2,
                     'length': 52,
                     'pid': 325359,
                     'sequence_number': 255,
                     'type': 24},
          'proto': 2,
          'scope': 0,
          'src_len': 0,
          'table': 254,
          'tos': 0,
          'type': 1}]
        >>>

    Like `AsyncIPRSocket`, it does not perform response reassembly,
    protocol-level error propagation, or packet buffering.
    '''

    def __init__(
        self,
        port=None,
        pid=None,
        fileno=None,
        sndbuf=1048576,
        rcvbuf=1048576,
        rcvsize=16384,
        all_ns=False,
        async_qsize=None,
        nlm_generator=None,
        target='localhost',
        ext_ack=False,
        strict_check=False,
        groups=rtnl.RTMGRP_DEFAULTS,
        nlm_echo=False,
        netns=None,
        netns_path=None,
        flags=os.O_CREAT,
        libc=None,
        use_socket=None,
        use_event_loop=None,
    ):
        self.asyncore = AsyncIPRSocket(
            port=port,
            pid=pid,
            fileno=fileno,
            sndbuf=sndbuf,
            rcvbuf=rcvbuf,
            rcvsize=rcvsize,
            all_ns=all_ns,
            target=target,
            ext_ack=ext_ack,
            strict_check=strict_check,
            groups=groups,
            nlm_echo=nlm_echo,
            netns=netns,
            netns_path=netns_path,
            flags=flags,
            libc=libc,
            use_socket=use_socket,
            use_event_loop=use_event_loop,
        )
        self.asyncore.local = NotLocal()

    @property
    def addr_pool(self):
        return self.asyncore.addr_pool

    @property
    def socket(self):
        return self.asyncore.socket

    @property
    def fileno(self):
        return self.asyncore.local.socket.fileno

    def bind(self, groups=None, pid=None, **kwarg):
        self.asyncore._sync_bind(groups, pid, **kwarg)

    def put(
        self,
        msg,
        msg_type,
        msg_flags=NLM_F_REQUEST,
        addr=(0, 0),
        msg_seq=0,
        msg_pid=None,
    ):
        if msg is None:
            msg_class = self.marshal.msg_map[msg_type]
            msg = msg_class()

        request = NetlinkRequest(
            self,
            msg,
            msg_type=msg_type,
            msg_flags=msg_flags,
            msg_seq=msg_seq,
            msg_pid=msg_pid,
        )
        request.msg.encode()
        return request.sock.send(request.msg.data)

    def get(self, msg_seq=0, terminate=None, callback=None, noraise=False):
        data = self.socket.recv(16384)
        return [x for x in self.marshal.parse(data)]


class ChaoticIPRSocket(AsyncIPRSocket, ChaoticNetlinkSocket):
    pass
b IDATxytVսϓ22 A@IR :hCiZ[v*E:WũZA ^dQeQ @ !jZ'>gsV仿$|?g)&x-EIENT ;@xT.i%-X}SvS5.r/UHz^_$-W"w)Ɗ/@Z &IoX P$K}JzX:;` &, ŋui,e6mX ԵrKb1ԗ)DADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADA݀!I*]R;I2$eZ#ORZSrr6mteffu*((Pu'v{DIߔ4^pIm'77WEEE;vƎ4-$]'RI{\I&G :IHJ DWBB=\WR޽m o$K(V9ABB.}jѢv`^?IOȅ} ڶmG}T#FJ`56$-ھ}FI&v;0(h;Б38CӧOWf!;A i:F_m9s&|q%=#wZprrrla A &P\\СC[A#! {olF} `E2}MK/vV)i{4BffV\|ۭX`b@kɶ@%i$K z5zhmX[IXZ` 'b%$r5M4º/l ԃߖxhʔ)[@=} K6IM}^5k㏷݆z ΗÿO:gdGBmyT/@+Vɶ纽z񕏵l.y޴it뭷zV0[Y^>Wsqs}\/@$(T7f.InݺiR$푔n.~?H))\ZRW'Mo~v Ov6oԃxz! S,&xm/yɞԟ?'uaSѽb,8GלKboi&3t7Y,)JJ c[nzӳdE&KsZLӄ I?@&%ӟ۶mSMMњ0iؐSZ,|J+N ~,0A0!5%Q-YQQa3}$_vVrf9f?S8`zDADADADADADADADADAdqP,تmMmg1V?rSI꒟]u|l RCyEf٢9 jURbztѰ!m5~tGj2DhG*{H9)꒟ר3:(+3\?/;TUݭʴ~S6lڧUJ*i$d(#=Yݺd{,p|3B))q:vN0Y.jkק6;SɶVzHJJЀ-utѹսk>QUU\޲~]fFnK?&ߡ5b=z9)^|u_k-[y%ZNU6 7Mi:]ۦtk[n X(e6Bb."8cۭ|~teuuw|ήI-5"~Uk;ZicEmN/:]M> cQ^uiƞ??Ңpc#TUU3UakNwA`:Y_V-8.KKfRitv޲* 9S6ֿj,ՃNOMߤ]z^fOh|<>@Å5 _/Iu?{SY4hK/2]4%it5q]GGe2%iR| W&f*^]??vq[LgE_3f}Fxu~}qd-ږFxu~I N>\;͗O֊:̗WJ@BhW=y|GgwܷH_NY?)Tdi'?խwhlmQi !SUUsw4kӺe4rfxu-[nHtMFj}H_u~w>)oV}(T'ebʒv3_[+vn@Ȭ\S}ot}w=kHFnxg S 0eޢm~l}uqZfFoZuuEg `zt~? b;t%>WTkķh[2eG8LIWx,^\thrl^Ϊ{=dž<}qV@ ⠨Wy^LF_>0UkDuʫuCs$)Iv:IK;6ֲ4{^6եm+l3>݆uM 9u?>Zc }g~qhKwڭeFMM~pМuqǿz6Tb@8@Y|jx](^]gf}M"tG -w.@vOqh~/HII`S[l.6nØXL9vUcOoB\xoǤ'T&IǍQw_wpv[kmO{w~>#=P1Pɞa-we:iǏlHo׈꒟f9SzH?+shk%Fs:qVhqY`jvO'ρ?PyX3lх]˾uV{ݞ]1,MzYNW~̈́ joYn}ȚF߾׮mS]F z+EDxm/d{F{-W-4wY듏:??_gPf ^3ecg ҵs8R2מz@TANGj)}CNi/R~}c:5{!ZHӋӾ6}T]G]7W6^n 9*,YqOZj:P?Q DFL|?-^.Ɵ7}fFh׶xe2Pscz1&5\cn[=Vn[ĶE鎀uˌd3GII k;lNmشOuuRVfBE]ۣeӶu :X-[(er4~LHi6:Ѻ@ԅrST0trk%$Č0ez" *z"T/X9|8.C5Feg}CQ%͞ˣJvL/?j^h&9xF`њZ(&yF&Iݻfg#W;3^{Wo^4'vV[[K';+mӍִ]AC@W?1^{එyh +^]fm~iԵ]AB@WTk̏t uR?l.OIHiYyԶ]Aˀ7c:q}ힽaf6Z~қm(+sK4{^6}T*UUu]n.:kx{:2 _m=sAߤU@?Z-Vކеz왍Nэ{|5 pڶn b p-@sPg]0G7fy-M{GCF'%{4`=$-Ge\ eU:m+Zt'WjO!OAF@ik&t݆ϥ_ e}=]"Wz_.͜E3leWFih|t-wZۍ-uw=6YN{6|} |*={Ѽn.S.z1zjۻTH]흾 DuDvmvK.`V]yY~sI@t?/ϓ. m&["+P?MzovVЫG3-GRR[(!!\_,^%?v@ҵő m`Y)tem8GMx.))A]Y i`ViW`?^~!S#^+ѽGZj?Vģ0.))A꨷lzL*]OXrY`DBBLOj{-MH'ii-ϰ ok7^ )쭡b]UXSְmռY|5*cֽk0B7镹%ڽP#8nȎq}mJr23_>lE5$iwui+ H~F`IjƵ@q \ @#qG0".0" l`„.0! ,AQHN6qzkKJ#o;`Xv2>,tێJJ7Z/*A .@fفjMzkg @TvZH3Zxu6Ra'%O?/dQ5xYkU]Rֽkق@DaS^RSּ5|BeHNN͘p HvcYcC5:y #`οb;z2.!kr}gUWkyZn=f Pvsn3p~;4p˚=ē~NmI] ¾ 0lH[_L hsh_ғߤc_њec)g7VIZ5yrgk̞W#IjӪv>՞y睝M8[|]\շ8M6%|@PZڨI-m>=k='aiRo-x?>Q.}`Ȏ:Wsmu u > .@,&;+!!˱tﭧDQwRW\vF\~Q7>spYw$%A~;~}6¾ g&if_=j,v+UL1(tWake:@Ș>j$Gq2t7S?vL|]u/ .(0E6Mk6hiۺzښOrifޱxm/Gx> Lal%%~{lBsR4*}{0Z/tNIɚpV^#Lf:u@k#RSu =S^ZyuR/.@n&΃z~B=0eg뺆#,Þ[B/?H uUf7y Wy}Bwegל`Wh(||`l`.;Ws?V@"c:iɍL֯PGv6zctM̠':wuW;d=;EveD}9J@B(0iհ bvP1{\P&G7D޴Iy_$-Qjm~Yrr&]CDv%bh|Yzni_ˆR;kg}nJOIIwyuL}{ЌNj}:+3Y?:WJ/N+Rzd=hb;dj͒suݔ@NKMԄ jqzC5@y°hL m;*5ezᕏ=ep XL n?מ:r`۵tŤZ|1v`V뽧_csج'ߤ%oTuumk%%%h)uy]Nk[n 'b2 l.=͜E%gf$[c;s:V-͞WߤWh-j7]4=F-X]>ZLSi[Y*We;Zan(ӇW|e(HNNP5[= r4tP &0<pc#`vTNV GFqvTi*Tyam$ߏWyE*VJKMTfFw>'$-ؽ.Ho.8c"@DADADADADADADADADA~j*֘,N;Pi3599h=goضLgiJ5փy~}&Zd9p֚ e:|hL``b/d9p? fgg+%%hMgXosج, ΩOl0Zh=xdjLmhݻoO[g_l,8a]٭+ӧ0$I]c]:粹:Teꢢ"5a^Kgh,&= =՟^߶“ߢE ܹS J}I%:8 IDAT~,9/ʃPW'Mo}zNƍ쨓zPbNZ~^z=4mswg;5 Y~SVMRXUյڱRf?s:w ;6H:ºi5-maM&O3;1IKeamZh͛7+##v+c ~u~ca]GnF'ټL~PPPbn voC4R,ӟgg %hq}@#M4IÇ Oy^xMZx ) yOw@HkN˖-Sǎmb]X@n+i͖!++K3gd\$mt$^YfJ\8PRF)77Wא!Cl$i:@@_oG I{$# 8磌ŋ91A (Im7֭>}ߴJq7ޗt^ -[ԩSj*}%]&' -ɓ'ꫯVzzvB#;a 7@GxI{j޼ƌ.LÇWBB7`O"I$/@R @eee@۷>}0,ɒ2$53Xs|cS~rpTYYY} kHc %&k.], @ADADADADADADADADA@lT<%''*Lo^={رc5h %$+CnܸQ3fҥK}vUVVs9G R,_{xˇ3o߾;TTTd}馛]uuuG~iԩ@4bnvmvfϞ /Peeeq}}za I~,誫{UWW뮻}_~YƍSMMMYχ֝waw\ďcxꩧtEƍկ_?۷5@u?1kNׯWzz/wy>}zj3 k(ٺuq_Zvf̘:~ ABQ&r|!%KҥKgԞ={<_X-z !CyFUUz~ ABQIIIjݺW$UXXDٳZ~ ABQƍecW$<(~<RSSvZujjjԧOZQu@4 8m&&&jԩg$ď1h ͟?_{768@g =@`)))5o6m3)ѣƌJ;wҿUTT /KZR{~a=@0o<*狔iFɶ[ˎ;T]]OX@?K.ۈxN pppppppppppppppppPfl߾] ,{ァk۶mڿo5BTӦMӴiӴ|r DB2e|An!Dy'tkΝ[A $***t5' "!駟oaDnΝ:t֭[gDШQ06qD;@ x M6v(PiizmZ4ew"@̴ixf [~-Fٱc&IZ2|n!?$@{[HTɏ#@hȎI# _m(F /6Z3z'\r,r!;w2Z3j=~GY7"I$iI.p_"?pN`y DD?: _  Gÿab7J !Bx@0 Bo cG@`1C[@0G @`0C_u V1 aCX>W ` | `!<S `"<. `#c`?cAC4 ?c p#~@0?:08&_MQ1J h#?/`7;I  q 7a wQ A 1 Hp !#<8/#@1Ul7=S=K.4Z?E_$i@!1!E4?`P_  @Bă10#: "aU,xbFY1 [n|n #'vEH:`xb #vD4Y hi.i&EΖv#O H4IŶ}:Ikh @tZRF#(tXҙzZ ?I3l7q@õ|ۍ1,GpuY Ꮿ@hJv#xxk$ v#9 5 }_$c S#=+"K{F*m7`#%H:NRSp6I?sIՖ{Ap$I$I:QRv2$Z @UJ*$]<FO4IENDB`