hE ` d Z ddlZddlZddlZddlZddlZddlZddlZddl Zddl
Zddl Zddl m
Z
ddlZdZej" j% rddlmZ nddlmZ ej, ej. d Zej4 dk( Zi Z ej: j< j? d d
d d Z e d
Z! e d Z" e d Z#d Z$d Z%d Z&d Z'd Z(d dZ)d Z*d Z+d Z,d Z-d Z.d Z/d Z0e"Z1e#Z2e$Z3e%Z4e&Z5e'Z6e)Z7y# e$ r dZY w xY w# e$ r dZY w xY w) 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)COMMANDcommand) CPU_UTIMEutime) CPU_STIMEstime)
START_TIMEz
start timec t j dk7 ryd} | D ]# }t j j | r# y y)z
Checks if proc information is available on this platform.
:returns: **True** if proc contents exist on this platform, **False** otherwise
LinuxF)
/proc/stat
/proc/meminfo
/proc/net/tcp
/proc/net/udpT)platformsystemospathexists)
proc_pathsr s X/var/www/betterdocs.net/sherlock_api/venv/lib/python3.12/site-packages/stem/util/proc.py is_availabler [ sE __'! SJ
WW^^D
! c t j d}} t dd| } t |j j d }t |d| |S # t
d|z }t || |xY w)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 btime z/proc/stat[btime]z.unable to parse the /proc/stat btime entry: %s)time _get_linefloatstripsplit _log_runtimeIOError _log_failure)
start_time parameter
btime_lineresultexcs r system_start_timer- p s ))+':i* w :*
:##%++-a0
1F /< M
BZO
PCC
Is 8A A<c t j d}} t dd| } t |j d dz }t |d| |S # t d|z }t
|| |xY w)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) mem_total_liner+ r, s r physical_memoryr3 s| ))+'?i* _k9E.
%%'*
+d
2F 5zB M
H>Y
ZCC
Is -A A1c t j d}}d| z }| dk( rd}n t j | }t
||| |S # t $ r t d|z }t || |w xY w)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)
proc_cwd_linkr5 r, s r r5 r5 s ))+ui* 3&-AX
C KK
&c y-4 *
'-7 8c9c" is A &A/c t j d}}d| z }t |d| } t |j d }t |d|z | |S # t d|d| }t
|| |xY w)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]unable to parse the z Uid entry: r0 )r9 r( r) status_pathuid_liner+ r, s r r< r< s ))+ui*!C'+
{FI
6(
!!$
%FI 3Z@ M
KR
SCC
Is -A !A9c v | dk( ryt j d}}d| z }t |d| } t |d j d dz }t |d j d dz }t |d
|z | ||fS # t d |d d
j
| }t || |xY w)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 usager= )VmRSS:VmSize:rB r r/ rC z%s[VmRSS|VmSize]r> z VmRSS and VmSize entries: , )r
_get_linesr1 r$ r% r& joinr' )r9 r( r) r? mem_lines residentSize virtualSizer, s r memory_usagerJ s AX ))+~i*!C'+&;YG) y*002156=Li *002156=K . ? dnn $ ss52 /+=>? doo % ""
Yr]+k9 s<*;*==>?1@4 y)Z0 w r c t | } | dk rt d| z t t j d| z S # t t f$ r t d| z w xY w# t $ r}t d|z d}~ww xY w)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)r1 r&
ValueError TypeErrorrY r listdir Exception)r9 r, s r file_descriptors_usedrn 8 s ;
c(C
Qw 83> ??
O rzz-#-. // i ;
3c9
::;
O
G#M
NNOs" A A$ A!$ B -A;;B c
t j g }}| r%d| z } t | } | dk rt d| z n
|rd|z }nd} t
s t d | r t
| n t }|rOt j j j t t j | j nd}d D ]t }|j! d
r t" j$ j' | s5|d d j) d
}|j! d
} t+ |d 5 }
|
j- |
D ] } | j/ dd \
} }
}}} } } }} }|r||vr(|r||k7 r0|d
k( r|dk7 r;|
j1 d }t3 |
d| }t |
|dz d d }|j1 d }t3 |d| }t ||dz d d }|dk( s|dk( r|dk( s|dk( r|j5 t j j6 j9 |||||| ddd w t= |d| |S # t t f$ r t d| z w xY w# 1 sw Y Bjjl3B>O ;AueVQ1c1e%v- !3U"v**T"C!%+.FsQwx "-F**T"C!%+.FsQwx "-F"f0O&O1! KK ,,77PVX`bij k/ l l&JP 1:> Ko
" = 5; <<=, l l6 I>3GHH
JNCHIIJ
C
sm I
CJ9 ! I:-DI.3I:;J9
I+.I7 3I:: J6J J6 J11J66J9 9 K
KKc t } t j d| z }|D ]l }d| d|} t j
| }|j
d r;|j t j j j |dd n |S # t $ r}t d|z d}~ww xY w# t $ r:}t j j | sY d}~t d |d
| d}~ww xY w) 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/z/fd/zsocket:[ rN z1unable to determine file descriptor destination (): )rx r rl r8 r& r7
startswithaddry rz r{ r| r r )r9 r fd_contentsr, fdfd_pathfd_names r rw rw s 5&C**]S 01K
ab"%r*G a G$g J '
499&&002 ?@a"
-)
C
;cA
BBC a
WW^^G
$
RUW^_ `` as5 B A!B6 B3 B..B36 C9? C4#C44C9c
| t vrEt | dk( rjt rt j | ddd nt j | }t j t
j | t | < t | S t r`g }t d D ]> }| d|z d|dz z }|t d D cg c] }|d|z d|dz z c}ddd z
}@ dj | }n| }t j j j t j t
j t j | t | < t | S c c}w )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
r NrN r r ) ENCODED_ADDRrY IS_LITTLE_ENDIANbase64 b16decodesocket inet_ntopAF_INETrangerF ry rz r expand_ipv6_addressAF_INET6)addrdecodedinvertedigroupingencodeds r r r sC
4yA~0@ &tt,fFVFVW[F\g!++FNNGDl4*
d #
q LA!a%QU ,(
E!HEqxAa1q5k2EddK
K( L ((8$ 99//CCFDTDTU[UdUdflfvfvw~f EA Bl4 d Fs 4Ec H | D ]
}t | y# t $ r Y yw xY w)NTF)r" rj )valuevs r rZ rZ s4
Ah s !!c $ t | |f| | S )N)rE ) file_path line_prefixr) s r r! r! s I :; GGr c t | }t | i }}|D ]6 }|s n2|D ]+ }|j | s|||< |j | 6 8 |j |rFt | dk( r| d|d d}t | | ddj
| d}t | |S # t $ r} t || d} ~ ww xY w) 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 did not contain a r z entryz did not contain rD z entriesN) listr r removecloserY rF r& r' )
r
line_prefixesr) remaining_prefixesr rc r prefixmsgr, s
r rE rE s
m, i "wI
& & ??6 " '&/
#
#F
+
OO
A %1:r s ,\
;;&&(!+
2++L9:+ ==H, yy~~06
(
,
,
82 BAHO6R
j#L) XH)
X
Y< * %
e +s# D D# D D #D-,D-