o
u]E @ s d Z ddlZddlZddlZddlZddlZddlZddlZddl Zddl
Zddl Zddl m
Z
zddlZdZW n eyC dZY nw ej rPddlmZ nddlmZ z
eejd ZW n eyk dZY nw ejdkZi Z ej j d d
d d Z e d
d Z!e dd Z"e dd Z#dd Z$dd Z%dd Z&dd Z'dd Z(d-d d Z)d d Z*d!d" Z+d#d$ Z,d%d& Z-d'd( Z.d)d* Z/d+d, Z0e"Z1e#Z2e$Z3e%Z4e&Z5e'Z6e)Z7dS ).a7
Helper functions for querying process and system information from the /proc
contents. Fetching information this way provides huge performance benefits
over lookups via system utilities (ps, netstat, etc). For instance, resolving
connections this way cuts the runtime by around 90% verses the alternatives.
These functions may not work on all platforms (only Linux?).
The method for reading these files (and a little code) are borrowed from
`psutil `_, which was written by Jay Loden,
Dave Daeschler, Giampaolo Rodola' and is under the BSD license.
**These functions are not being vended to stem users. They may change in the
future, use them at your own risk.**
.. versionchanged:: 1.3.0
Dropped the get_* prefix from several function names. The old names still
work, but are deprecated aliases.
**Module Overview:**
::
is_available - checks if proc utilities can be used on this system
system_start_time - unix timestamp for when the system started
physical_memory - memory available on this system
cwd - provides the current working directory for a process
uid - provides the user id a process is running under
memory_usage - provides the memory usage of a process
stats - queries statistics about a process
file_descriptors_used - number of file descriptors used by a process
connections - provides the connections made by a process
.. data:: Stat (enum)
Types of data available via the :func:`~stem.util.proc.stats` function.
============== ===========
Stat Description
============== ===========
**COMMAND** command name under which the process is running
**CPU_UTIME** total user time spent on the process
**CPU_STIME** total system time spent on the process
**START_TIME** when this process began, in unix time
============== ===========
N)logTF) lru_cache
SC_CLK_TCKlittle)COMMANDZcommand) CPU_UTIMEutime) CPU_STIMEZstime)
START_TIMEz
start timec C s4 t dkrdS d} | D ] }tj|s dS q dS )z
Checks if proc information is available on this platform.
:returns: **True** if proc contents exist on this platform, **False** otherwise
ZLinuxF)
/proc/stat
/proc/meminfo
/proc/net/tcp
/proc/net/udpT)platformsystemospathexists)Z
proc_pathsr r 0/usr/lib/python3/dist-packages/stem/util/proc.py is_available[ s r c C sb t d} }tdd|}zt| d }t|d| |W S td| }t|| |)z
Provides the unix time (seconds since epoch) when the system started.
:returns: **float** for the unix time of when the system started
:raises: **IOError** if it can't be determined
zsystem start timer Zbtime z/proc/stat[btime]z.unable to parse the /proc/stat btime entry: %s)time _get_linefloatstripsplit _log_runtimeIOError _log_failure)
start_time parameterZ
btime_lineresultexcr r r system_start_timep
r$ c C sb t d} }tdd|}zt| d d }t|d| |W S td| }t|| |)z
Provides the total physical memory on the system in bytes.
:returns: **int** for the bytes of physical memory this system has
:raises: **IOError** if it can't be determined
zsystem physical memoryr z MemTotal:r z/proc/meminfo[MemTotal]z4unable to parse the /proc/meminfo MemTotal entry: %sr r intr r r r )r r! Zmem_total_liner" r# r r r physical_memory r% r) c C sl t d}}d| }| dkrd}n zt|}W n ty- td| }t|| |w t||| |S )z
Provides the current working directory for the given process.
:param int pid: process id of the process to be queried
:returns: **str** with the path of the working directory for the process
:raises: **IOError** if it can't be determined
cwdz /proc/%s/cwdr zunable to read %s)r r readlinkOSErrorr r r )pidr r! Z
proc_cwd_linkr* r# r r r r* s
r* c C sn t d}}d| }t|d|}zt| d }t|d| | |W S td||f }t|| |)z
Provides the user ID the given process is running under.
:param int pid: process id of the process to be queried
:returns: **int** with the user id for the owner of the process
:raises: **IOError** if it can't be determined
uid/proc/%s/statuszUid:r z%s[Uid]z$unable to parse the %s Uid entry: %sr' )r. r r! status_pathZuid_liner" r# r r r r/ s
r/ c C s | dkrdS t d}}d| }t|d|}z%t|d d d }t|d d d }t|d
| | ||fW S td |d |f }t|| |)
a'
Provides the memory usage in bytes for the given process.
:param int pid: process id of the process to be queried
:returns: **tuple** of two ints with the memory usage of the process, of the
form **(resident_size, virtual_size)**
:raises: **IOError** if it can't be determined
r )r r z memory usager0 )VmRSS:VmSize:r2 r r& r3 z%s[VmRSS|VmSize]z3unable to parse the %s VmRSS and VmSize entries: %s, )r
_get_linesr( r r r joinr )r. r r! r1 Z mem_linesZ residentSizeZ virtualSizer# r r r memory_usage s
r7 c
G s t du rtdt dd| }}d| }t|t| |}g }|d|d}}|dkrU|dkrU||d| |||d | |||d d 7 }t |d
k rtt
|d |d |d
rttd| } t || | g }
|D ]s} | t j
kr| dkr|
d qx|
|d qx| t jkr| dkr|
d qx|
tt|d t qx| t jkr| dkr|
d qx|
tt|d t qx| t jkr| dkrt S t|d
t } |
t| t qxt||| t|
S )aY
Provides process specific information. See the :data:`~stem.util.proc.Stat`
enum for valid options.
:param int pid: process id of the process to be queried
:param Stat stat_types: information to be provided back
:returns: **tuple** with all of the requested statistics as strings
:raises: **IOError** if it can't be determined
Nz Unable to look up SC_CLK_TCKz
process %sr4 z
/proc/%s/stat()r ,
z&stat file had an unexpected format: %sr Zsched0) CLOCK_TICKSr r r6 r strfindappendr len _is_floatr Statr r r r r
r$ r tuple)
r. Z
stat_typesr r! Z stat_pathZ stat_lineZ stat_compZ cmd_startZcmd_endr# resultsZ stat_typeZ p_start_timer r r stats sJ
$
rI c
C sz zt | } | dk rtd| W n ttfy td| w z
ttd| W S ty< } ztd| d}~ww )a
Provides the number of file descriptors currently being used by a process.
.. versionadded:: 1.3.0
:param int pid: process id of the process to be queried
:returns: **int** of the number of file descriptors used
:raises: **IOError** if it can't be determined
r "Process pids can't be negative: %s Process pid was non-numeric: %sz /proc/%i/fdz3Unable to check number of file descriptors used: %sN)r( r
ValueError TypeErrorrD r listdir Exception)r. r# r r r file_descriptors_used8 s
rP c
C s t g }}| r-d| }zt| } | dk r td| W n ttfy, td| w |r4d| }nd}z ts>td| rDt| nt }|rVtj j
t t
|jnd}d D ]}|d
rhtj|shqZ|d d d
}|d
} zt|d }
|
|
D ]|} | dd \
} }
}}} } } }} }|r||vrq|r||krq|d
kr|dkrq|
d}t|
d| }t|
|d d d}|d}t|d| }t||d d d}|dks|dkrq|dks|dkrq|tj j |||||| qW d n 1 s w Y W qZ ty& } ztd||f d}~w t y: } ztd||f d}~ww t |d| |W S tyV } zt || d}~ww )a
Queries connections from the proc contents. This matches netstat, lsof, and
friends but is much faster. If no **pid** or **user** are provided this
provides all present connections.
:param int pid: pid to provide connections for
:param str user: username to look up connections for
:returns: **list** of :class:`~stem.util.connection.Connection` instances
:raises: **IOError** if it can't be determined
zconnections for pid %sr rJ rK zconnections for user %szall connectionszCThis requires python's pwd module, which is unavailable on Windows.N)r
z/proc/net/tcp6r z/proc/net/udp66
rbZtcps 01 :r z0.0.0.0z 0000:0000:0000:0000:0000:0000zunable to read '%s': %szunable to parse '%s': %sz/proc/net/[tcp|udp]) r r( r rL rM IS_PWD_AVAILABLE_inodes_for_socketssetstemutil str_tools _to_bytesrA pwdgetpwnamZpw_uidendswithr r r rstripopenreadliner rB _unpack_addrrC
connectionZ
ConnectionrO r r )r. userr Zconnr! inodesZ process_uidZproc_file_pathZprotocolZis_ipv6 proc_fileline_Zl_dstZr_dststatusr/ inodeZdivZl_addrZl_portZr_addrZr_portr# r r r connectionsS s~
"
$
rl c C s t }z td| }W n ty } ztd| d}~ww |D ]B}d| |f }zt|}|drB|tj j
|dd W q! tyc } ztj
|sWW Y d}~q!td||f d}~ww |S ) z
Provides inodes in use by a process for its sockets.
:param int pid: process id of the process to be queried
:returns: **set** with inodes for its sockets
:raises: **IOError** if it can't be determined
z /proc/%s/fdz'Unable to read our file descriptors: %sNz/proc/%s/fd/%szsocket:[ r: z8unable to determine file descriptor destination (%s): %s)rX r rN r- r r,
startswithaddrY rZ r[ r\ r r )r. rf Z fd_contentsr# fdZfd_pathZfd_namer r r rW s*
rW c s | t vrjt| dkr(trt| ddd nt| }ttj|t | < t | S trWg }tdD ] }| d| d|d | fddtdD ddd 7 }q0d |}n| }t
j j
ttjt|t | < t | S ) a
Translates an address entry in the /proc/net/* contents to a human readable
form (`reference `_,
for instance:
::
"0500000A" -> "10.0.0.5"
"F804012A4A5190010000000002000000" -> "2a01:4f8:190:514a::2"
:param str addr: proc address entry to be decoded
:returns: **str** of the decoded address
rm Nr: r c s$ g | ]} d | d |d qS ) r r ).0igroupingr r
s $ z _unpack_addr.. ) ENCODED_ADDRrD IS_LITTLE_ENDIANbase64Z b16decodesocketZ inet_ntopZAF_INETranger6 rY rZ rd Zexpand_ipv6_addressZAF_INET6)ZaddrZdecodedinvertedrt Zencodedr ru r rc s " & "rc c G s. z | D ]}t | qW dS ty Y dS w )NTF)r rL )valuevr r r rE s
rE c C s t | |f|| S )N)r5 ) file_pathZ line_prefixr! r r r r s r c
C s zQt |}t| i }}|D ]}|s n|D ]}||r(|||< || nqq| |rOt|dkrBd| |d f }t|d| d|f }t||W S tyc } zt|| d} ~ ww )a
Fetches lines with the given prefixes from a file. This only provides back
the first instance of each prefix.
:param str file_path: path of the file to read
:param tuple line_prefixes: string prefixes of the lines to return
:param str parameter: description of the proc attribute being fetch
:returns: mapping of prefixes to the matching line
:raises: **IOError** if unable to read the file or can't find all of the prefixes
r z %s did not contain a %s entryr z %s did not contain %s entriesr4 N) listra rn removecloserD r6 r r )
r Z
line_prefixesr! Zremaining_prefixesrg rH rh prefixmsgr# r r r r5 s4
r5 c C s$ t | }td| ||f dS )z
Logs a message indicating a successful proc query.
:param str parameter: description of the proc attribute being fetch
:param str proc_location: proc files we were querying
:param int start_time: unix time for when this query was started
z#proc call (%s): %s (runtime: %0.4f)N)r r debug)r! Z
proc_locationr Zruntimer r r r 4 s r c C s t d| |f dS )z
Logs a message indicating that the proc query failed.
:param str parameter: description of the proc attribute being fetch
:param Exception exc: exception that we're raising
zproc call failed (%s): %sN)r r )r! r# r r r r A s r )NN)8__doc__r{ r r r| sysr Z stem.prereqrY Zstem.util.connectionZstem.util.enumZstem.util.str_toolsZ stem.utilr r] rV ImportErrorZprereqZ_is_lru_cache_available functoolsr Zstem.util.lru_cachesysconf
sysconf_namesr@ AttributeError byteorderrz ry rZ enumEnumrF r r$ r) r* r/ r7 rI rP rl rW rc rE r r5 r r Zget_system_start_timeZget_physical_memoryZget_cwdZget_uidZget_memory_usageZ get_statsZget_connectionsr r r r st .
!D
U&,
,