Current File : //lib/python2.7/site-packages/salt/transport/ipc.pyo
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l
Z
d d l Z
d d l Z
d d l
Z
d d l m Z d d l m Z m Z d d l m Z m Z d d l Z d d l Z d d l m Z e j e � Z d � Z d e
j j! f d
� � YZ" d e# f d � � YZ$ d
e# f d � � YZ% d e% f d � � YZ& d e$ f d � � YZ' d e# f d � � YZ( d e% f d � � YZ) d S( u
IPC transport classes
i ( t absolute_importt print_functiont unicode_literalsN( t Lock( t IOLoopt TimeoutError( t IOStreamt StreamClosedError( t sixc C@ s& | j d k r" | j j | � n d S( N( t _future_with_timeoutt Nonet _done_callback( t future( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt future_with_timeout_callback$ s t FutureWithTimeoutc B@ s# e Z d � Z d � Z d � Z RS( c C@ s� t t | � j � | | _ | | _ | d k rq | d k rF d } n | j j | j j � | | j � | _ n d | _ t
| j d � r� | | j _ | j j � r� t
| j � q� n | | j _ | j j t
� d S( Ng�������?u _future_with_timeout( t superR t __init__t io_loopt _futureR
t add_timeoutt timet _timeout_callbackt _timeout_handlet hasattrR t doneR
t add_done_callback( t selfR R t timeout( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR * s " c C@ s) d | _ d | j _ | j t � � d S( N( R
R R R t
set_exceptiont TornadoTimeoutError( R ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR A s c C@ sl yE | j d k r1 | j j | j � d | _ n | j | j � � Wn t k
rg } | j | � n Xd S( N( R R
R t remove_timeoutt
set_resultt resultt ExceptionR ( R R t exc( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR J s ( t __name__t
__module__R R R ( ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR ) s t IPCServerc B@ sV e Z d Z d d d � Z d � Z e j j d � � Z d � Z
d � Z d � Z RS( u�
A Tornado IPC server very similar to Tornado's TCPServer class
but using either UNIX domain sockets or TCP sockets
c C@ sF | | _ t | _ | | _ d | _ | p3 t j � | _ t | _ d S( u
Create a new Tornado IPC server
:param str/int socket_path: Path on the filesystem for the
socket to bind to. This socket does
not need to exist prior to calling
this method, but parent directories
should.
It may also be of type 'int', in
which case it is used as the port
for a tcp localhost connection.
:param IOLoop io_loop: A Tornado ioloop to handle scheduling
:param func payload_handler: A function to customize handling of
incoming data.
N(
t socket_patht Falset _startedt payload_handlerR
t sockR t currentR t _closing( R R& R R) ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR Z s c C@ s� t j d | j � t | j t � r� t j t j t j � | _ | j j t j
t j d � | j j d � | j j
d | j f � | j j d � n t j j | j � | _ t j j j | j � � t j j | j | j � Wd QXt | _ d S( uy
Perform the work necessary to start up a Tornado IPC server
Blocks until socket is established
u IPCServer: binding to socket: %si i u 127.0.0.1i� N( t logt traceR& t
isinstancet intt sockett AF_INETt SOCK_STREAMR* t
setsockoptt
SOL_SOCKETt SO_REUSEADDRt setblockingt bindt listent tornadot netutilt bind_unix_sockett saltt utilst asynchronoust current_ioloopR t add_accept_handlert handle_connectiont TrueR( ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt starts s c #@ s� t j j d � � � � f d � } t j d k rF i t j d 6} n& t j r_ i d d 6} n
i d d 6} t j | � } x | j � s�yh | j
d d
t �V} | j | � x> | D]6 } | d } | j
j | j | | | | d � � q� WWq~ t k
rt j d
| j � Pq~ t j k
r`} | j d k rMt j d | � q�t j d | � q~ t k
r�} t j d | � q~ Xq~ Wd S( u�
Override this to handle the streams as they arrive
:param IOStream stream: An IOStream for processing
See https://tornado.readthedocs.io/en/latest/iostream.html#tornado.iostream.IOStream
for additional details.
c S@ s t j j d � � d S( N( R: t gent ReturnR
( t msg( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt _null� s c @ s9 � j d � r1 t j j � � f d � � } | S� Sd S( Nu midc 3@ s> t j j j | d i � d d 6d t �} � j | � Vd S( Nt headeru midt raw_body( R= t transportt framet
frame_msg_ipcRC t write( RG t pack( RI t stream( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt return_message� s
( t getR: RE t coroutine( RP RI RQ ( RH ( RI RP s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt write_callback� s i i i u rawu encodingu utf-8i t partialu bodyu headu Client disconnected from IPC %su= Exception occured with error number 0, spurious exception: %su, Exception occurred while handling stream: %sN( i i i ( R: RE RS t msgpackt versionR t PY2R
t Unpackert closedt
read_bytesRC t feedR t spawn_callbackR) R R- R. R& R1 t errort errnoR! ( R RP RT t msgpack_kwargst unpackert
wire_bytest
framed_msgt bodyR" ( ( RH s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt
handle_stream� s6
.
c C@ s t j d | � yE t j j j | j � � t | � } Wd QX| j j | j | � Wn# t
k
rz } t j d | � n Xd S( Nu- IPCServer: Handling connection to address: %su IPC streaming error: %s( R- R. R= R> R? R@ R R R] Re R! R^ ( R t
connectiont addressRP R" ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyRB � s c C@ s< | j r
d St | _ t | j d � r8 | j j � n d S( u�
Routines to handle any cleanup before the instance shuts down.
Sockets and filehandles should be closed explicitly, to prevent
leaks.
Nu close( R, RC R R* t close( R ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyRh � s
c C@ s& y | j � Wn t k
r! n Xd S( N( Rh t TypeError( R ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt __del__� s
N(
R# R$ t __doc__R
R RD R: RE RS Re RB Rh Rj ( ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR% U s < t IPCClientc B@ s\ e Z d Z d d � Z d � Z d d d � Z e j j d d � � Z
d � Z d � Z RS( u�
A Tornado IPC client very similar to Tornado's TCPClient class
but using either UNIX domain sockets or TCP sockets
This was written because Tornado does not have its own IPC
server/client implementation.
:param IOLoop io_loop: A Tornado ioloop to handle scheduling
:param str/int socket_path: A path on the filesystem where a socket
belonging to a running IPCServer can be
found.
It may also be of type 'int', in which
case it is used as the port for a tcp
localhost connection.
c C@ s� | p t j j j � | _ | | _ t | _ d | _ t
j d k rX i t j
d 6} n& t j
rq i d d 6} n
i d d 6} t
j | � | _ d S( u�
Create a new IPC client
IPC clients cannot bind to ports, but must connect to
existing IPC servers. Clients can then send messages
to the server.
i i i u rawu encodingu utf-8N( i i i ( R: t ioloopR R+ R R& R' R, R
RP RV RW R RX RY Ra ( R R& R R` ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR � s
c C@ s | j d k o | j j � S( N( RP R
RZ ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt connected s c @ s� t � d � r+ � j j � r+ � j } nG t � d � rJ � j j � n t j j � } | � _ � j d | � � d k r� � � f d � } | j | � n | S( u+
Connect to the IPC socket
u _connecting_futureR c @ s# | j � } � j j � | � d S( N( R R t add_callback( R t response( t callbackR ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt
handle_future# s N(
R t _connecting_futureR t exceptionR: t
concurrentt Futuret _connectR
R ( R Rq R R Rr ( ( Rq R s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt connect s c c@ s� t | j t � r- t j } d | j f } n t j } | j } d | _ | d k rg t j � | } n x;t r�| j
r} Pn | j d k r� t j j
j | j � �# t t j | t j � � | _ Wd QXn y9 t j d | j � | j j | � V| j j t � PWqj t k
r�} | j j � r2d | _ n | d k sPt j � | k r�| j d k rx| j j � d | _ n | j j | � Pn t j j d � Vqj Xqj Wd S( u0
Connect to a running IPCServer
u 127.0.0.1Nu# IPCClient: Connecting to socket: %si ( R/ R& R0 R1 R2 t AF_UNIXR
RP R RC R, R= R> R? R@ R R R3 R- R. Rx Rs R R! RZ Rh R R: RE t sleep( R R t sock_typet sock_addrt
timeout_att e( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyRw * s< $
c C@ sS y | j � Wn> t j k
r> } | j t j k rO � qO n t k
rN n Xd S( N( Rh R1 R^ R_ t EBADFRi ( R R" ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyRj U s
c C@ s_ | j r
d St | _ t j d | j j � | j d k r[ | j j � r[ | j j � n d S( u�
Routines to handle any cleanup before the instance shuts down.
Sockets and filehandles should be closed explicitly, to prevent
leaks.
Nu Closing %s instance(
R, RC R- t debugt __class__R# RP R
RZ Rh ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyRh a s N(
R# R$ Rk R
R Rn Rx R: RE RS Rw Rj Rh ( ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyRl � s * t IPCMessageClientc B@ s) e Z d Z e j j d d d � � Z RS( u�
Salt IPC message client
Create an IPC client to send messages to an IPC server
An example of a very simple IPCMessageClient connecting to an IPCServer. This
example assumes an already running IPCMessage server.
IMPORTANT: The below example also assumes a running IOLoop process.
# Import Tornado libs
import tornado.ioloop
# Import Salt libs
import salt.config
import salt.transport.ipc
io_loop = tornado.ioloop.IOLoop.current()
ipc_server_socket_path = '/var/run/ipc_server.ipc'
ipc_client = salt.transport.ipc.IPCMessageClient(ipc_server_socket_path, io_loop=io_loop)
# Connect to the server
ipc_client.connect()
# Send some data
ipc_client.send('Hello world')
c c@ sJ | j � s | j � Vn t j j j | d t �} | j j | � Vd S( u
Send a message to an IPC socket
If the socket is not currently connected, a connection will be established.
:param dict msg: The message to be sent
:param int timeout: Timeout when sending message (Currently unimplemented)
RJ N( Rn Rx R= RK RL RM RC RP RN ( R RG R t triesRO ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt send� s
N( R# R$ Rk R: RE RS R
R� ( ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR� r s t IPCMessageServerc B@ s e Z d Z RS( uN
Salt IPC message server
Creates a message server which can create and bind to a socket on a given
path and then respond to messages asynchronously.
An example of a very simple IPCServer which prints received messages to
a console:
# Import Tornado libs
import tornado.ioloop
# Import Salt libs
import salt.transport.ipc
import salt.config
opts = salt.config.master_opts()
io_loop = tornado.ioloop.IOLoop.current()
ipc_server_socket_path = '/var/run/ipc_server.ipc'
ipc_server = salt.transport.ipc.IPCMessageServer(opts, io_loop=io_loop
stream_handler=print_to_console)
# Bind to the socket and prepare to run
ipc_server.start(ipc_server_socket_path)
# Start the server
io_loop.start()
# This callback is run whenever a message is received
def print_to_console(payload):
print(payload)
See IPCMessageClient() for an example of sending messages to an IPCMessageServer instance
( R# R$ Rk ( ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR� � s "t IPCMessagePublisherc B@ s\ e Z d Z d d � Z d � Z e j j d � � Z d � Z
d � Z d � Z d � Z
RS( u~
A Tornado IPC Publisher similar to Tornado's TCPServer class
but using either UNIX domain sockets or TCP sockets
c C@ sR | | _ | | _ t | _ d | _ | p3 t j � | _ t | _ t
� | _ d S( u�
Create a new Tornado IPC server
:param dict opts: Salt options
:param str/int socket_path: Path on the filesystem for the
socket to bind to. This socket does
not need to exist prior to calling
this method, but parent directories
should.
It may also be of type 'int', in
which case it is used as the port
for a tcp localhost connection.
:param IOLoop io_loop: A Tornado ioloop to handle scheduling
N( t optsR& R' R( R
R* R R+ R R, t sett streams( R R� R& R ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR � s c C@ s� t j d | j � t | j t � r� t j t j t j � | _ | j j t j
t j d � | j j d � | j j
d | j f � | j j d � n t j j | j � | _ t j j j | j � � t j j | j | j � Wd QXt | _ d S( uy
Perform the work necessary to start up a Tornado IPC server
Blocks until socket is established
u* IPCMessagePublisher: binding to socket: %si i u 127.0.0.1i� N( R- R. R& R/ R0 R1 R2 R3 R* R4 R5 R6 R7 R8 R9 R: R; R< R= R> R? R@ R RA RB RC R( ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyRD � s c c@ s� y | j | � VWn t k
rH t j d | j � | j j | � nL t k
r� } t j d | � | j � s� | j
� n | j j | � n Xd S( Nu Client disconnected from IPC %su, Exception occurred while handling stream: %s( RN R R- R. R& R� t discardR! R^ RZ Rh ( R RP RO R" ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt _write� s
c C@ s_ t | j � s d St j j j | d t �} x* | j D] } | j j | j | | � q8 Wd S( u7
Send message to all connected sockets
NRJ (
t lenR� R= RK RL RM RC R R] R� ( R RG RO RP ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt publish
s
c @ s� t j d | � y� i } � j d d k rW � j d | d <t j d � j d � n t j j j � j � � t | | � � Wd QX� j j
� � � � f d � } � j | � Wn# t k
r� } t j
d | � n Xd S( Nu- IPCServer: Handling connection to address: %su ipc_write_bufferi u max_write_buffer_sizeu' Setting IPC connection write buffer: %sc @ s � j j � � d S( N( R� R� ( ( R RP ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt discard_after_closed$ s u IPC streaming error: %s( R- R. R� R= R> R? R@ R R R� t addt set_close_callbackR! R^ ( R Rf Rg t kwargsR� R" ( ( R RP s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyRB s c C@ sg | j r
d St | _ x | j D] } | j � q W| j j � t | j d � rc | j j � n d S( u�
Routines to handle any cleanup before the instance shuts down.
Sockets and filehandles should be closed explicitly, to prevent
leaks.
Nu close( R, RC R� Rh t clearR R* ( R RP ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyRh + s
c C@ s& y | j � Wn t k
r! n Xd S( N( Rh Ri ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyRj : s
N( R# R$ Rk R
R RD R: RE RS R� R� RB Rh Rj ( ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR� � s
t IPCMessageSubscriberc B@ se e Z d Z d d � Z e j j d d � � Z d d � Z e j j d � � Z
d � Z d � Z RS( u�
Salt IPC message subscriber
Create an IPC client to receive messages from IPC publisher
An example of a very simple IPCMessageSubscriber connecting to an IPCMessagePublisher.
This example assumes an already running IPCMessagePublisher.
IMPORTANT: The below example also assumes the IOLoop is NOT running.
# Import Tornado libs
import tornado.ioloop
# Import Salt libs
import salt.config
import salt.transport.ipc
# Create a new IO Loop.
# We know that this new IO Loop is not currently running.
io_loop = tornado.ioloop.IOLoop()
ipc_publisher_socket_path = '/var/run/ipc_publisher.ipc'
ipc_subscriber = salt.transport.ipc.IPCMessageSubscriber(ipc_server_socket_path, io_loop=io_loop)
# Connect to the server
# Use the associated IO Loop that isn't running.
io_loop.run_sync(ipc_subscriber.connect)
# Wait for some data
package = ipc_subscriber.read_sync()
c C@ s> t t | � j | d | �d | _ g | _ t � | _ d S( NR ( R R� R R
t _read_stream_futuret _saved_dataR t _read_in_progress( R R& R ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR d s
c c@ s y | j j d d � VWn) t j j k
rC t j j d � � n Xd } d } y x� t rN| j d k r� | j j
d d t �| _ n | d k r� | j V} n t | j | j | � V} d | _ d } | j
j | � t } x^ | j
D]S } | r| j j | | d � q� | r)| d } t } q� | j j | d � q� W| sV PqV qV WWn| t k
rid } nf t k
r�} t j d | j � d | _ | } n2 t k
r�} t j d | � d | _ | } n X| j j � | d k r�| � n t j j | � � d S( NR g:�0�yE>i RU u bodyu# Subscriber disconnected from IPC %su: Exception occurred in Subscriber while handling stream: %s( R� t acquireR: RE R RF R
RC R� RP R[ R R Ra R\ R] R' R� t appendR R R- R. R& R! R^ t release( R R Rq t exc_to_raiset retRb t first_sync_msgRc R" ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt _readk sT
c @ s5 � j r � j j d � S� j j � � f d � � S( uZ
Read a message from an IPC socket
The socket must already be connected.
The associated IO Loop must NOT be running.
:param int timeout: Timeout when receiving message
:return: message data if successful. None if timed out. Will raise an
exception for all other error conditions.
i c @ s
� j � � S( N( R� ( ( R R ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt <lambda>� s ( R� t popR t run_sync( R R ( ( R R s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt read_sync� s
c c@ s� x� | j � s� y | j d d � VWq t k
r[ t j d | j � t j j d � Vq t k
r� } t j
d | � t j j d � Vq Xq W| j d | � Vd S( u�
Asynchronously read messages and invoke a callback when they are ready.
:param callback: A callback with the received data
R i u1 Subscriber closed stream on IPC %s before connecti u2 Exception occurred while Subscriber connecting: %sN(
Rn Rx R R- R. R& R: RE Rz R! R^ R� R
( R Rq R" ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt
read_async� s
c C@ s} | j r
d St t | � j � | j d k ry | j j � ry | j j � } | ry t | t � ry t
j d | � qy n d S( u�
Routines to handle any cleanup before the instance shuts down.
Sockets and filehandles should be closed explicitly, to prevent
leaks.
Nu! Read future returned exception %r( R, R R� Rh R� R
R Rt R/ R R- R^ ( R R" ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyRh � s c C@ s t t � k r | j � n d S( N( R� t globalsRh ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyRj � s N(
R# R$ Rk R
R R: RE RS R� R� R� Rh Rj ( ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyR� C s : (* Rk t
__future__R R R R_ t loggingR1 R RV R: t tornado.gent tornado.netutilt tornado.concurrentt
tornado.locksR t tornado.ioloopR R R t tornado.iostreamR R t salt.transport.clientR= t salt.transport.framet salt.extR t getLoggerR# R- R
Ru Rv R t objectR% Rl R� R� R� R� ( ( ( s6 /usr/lib/python2.7/site-packages/salt/transport/ipc.pyt <module> s2 ,��0%|
Mini Shell