3
ܓi> @ s d dl Z d dlZd dlmZ d dlmZ d dlmZ d dl m
Z
d dl m Z d dl
mZ d dlmZ d d lmZ d d
lmZmZmZmZ d Zd Zd
ZG dd deZG dd deZ dS ) N)_sos)Policy)
InitSystem) SystemdInit)CrioContainerRuntime)PodmanContainerRuntime)DockerContainerRuntime)LxdContainerRuntime) shell_out
is_executableboldsos_get_command_outputz/etc/os-releaseZ containerZHOSTc s. e Zd ZdZdZdZdZdZdZdZ dZ
dZ dZ dZ
dZdZdZdZd ZdZdZd9 fd d Zed
d Zed:ddZdd Zdd Zdd Zdd Z dd Z dd Z ed d Z ed d Z ed!d" Z!d#d$ Z"d%d& Z#d'd( Z$d)d* Z%d+d, Z&d-d. Z'd/d0 Z(d1d2 Z)d;d3d4Z*d5d6 Z+d7d8 Z, Z-S )< LinuxPolicyzfThis policy is meant to be an abc class that provides common
implementations used in Linux distrosNonez /bin:/sbin:/usr/bin:/usr/sbinN dockerFz/usr/binzsos-collector-tmpTc s" t j|||d |r || _n| j p(d| _| j |d k rD|| _n$tjjdr`t | jd| _nt
| _i | _ | j r t
| dt| dt| dt| dg}xN|D ]F}|j r|| j |j< |j| jkr| j |j | j d< | j |j j qW | j od| j kr t| j j }| j |d | j d< d S )N)sysroot
probe_runtime remote_exec/z/run/systemd/system/)chroot)Zpolicydefaultr )super__init__r _container_initinit_kernel_modulesZ init_systemospathisdirr r Zruntimesr r r r r Zcheck_is_activenamedefault_container_runtimeZload_container_infolistkeys)selfr initr r Z_crunZruntimeidx) __class__ /usr/lib/python3.6/__init__.pyr ; s6
zLinuxPolicy.__init__c C s ddgS )Nz /etc/passwdz /etc/shadowr' )clsr' r' r( set_forbidden_pathsd s z LinuxPolicy.set_forbidden_pathsc st fdd}|r||S t jj jrNt jj jt jjt jj jkrNdS ttddd}||j S Q R X dS )z|
This function is responsible for determining if the underlying system
is supported by this policy.
c sb j g} jr|j j xB| j D ]6}|jd r$|jddd d jd}||kr$dS q$W dS )
NNAME=ID== r z"'TF)r+ r, )os_release_name
os_release_idappend
splitlines
startswithsplitstrip)ZcontentZ_matcheslineZ_distro)r) r' r( _check_releaseq s
z)LinuxPolicy.check.._check_releaseTrzutf-8)encodingN) r r isfileos_release_filebasenamerealpathopen
OS_RELEASEread)r) remoter7 fr' )r) r( checkk s zLinuxPolicy.checkc C s | j S )N)release)r# r' r' r( kernel_version s zLinuxPolicy.kernel_versionc C s | j S )N)Zhostname)r# r' r' r( host_name s zLinuxPolicy.host_namec C s | j S )N)Zsmp)r# r' r' r(
is_kernel_smp s zLinuxPolicy.is_kernel_smpc C s | j S )N)machine)r# r' r' r( get_arch s zLinuxPolicy.get_archc C s | j S )z)Returns the name usd in the pre_work step)rF )r# r' r' r( get_local_name s zLinuxPolicy.get_local_namec C s t jdd|S )Nz[^-a-z,A-Z.0-9]r )resub)r# r r' r' r( sanitize_filename s z LinuxPolicy.sanitize_filenamec C s4 | t kr| j| n |j| j d | j| d S )Nz Distribution Policy)r display_self_help set_titler/ display_distro_help)r) sectionr' r' r( display_help s zLinuxPolicy.display_helpc C s |j d |jd d S )NzSoS Distribution PolicieszDistributions supported by SoS will each have a specific policy defined for them, to ensure proper operation of SoS on those systems.)rO add_text)r) rQ r' r' r( rN s
z LinuxPolicy.display_self_helpc C s> | j r | j tj k r |j| j n
|jd | d d d}|jd|j |jd|j dd |jd|j dd |jd}x6| jD ],}|jdd |d
d |d d
dd qW |jd}|jtdd dddddd dd xN|j j
D ]@\}}dj |j j
}|jdd |d|jd|d dd qW d S )Nz;
Detailed help information for this policy is not availableFzDefault --upload location: zDefault container runtime: )newlinez $PATH used when running report: zReference URLs z>8r z<30r. z<40z#Presets Available With This Policy
z Preset Namez<20Z Descriptionz<45zEnabled Options)__doc__r rS _upload_urlr PATHZ add_section vendor_urlsr ZpresetsitemsjoinZoptsZto_argsZdesc) r) rQ Z_polZrefsecZurlZpresecZpresetvalueZ_optsr' r' r( rP s4
,
z LinuxPolicy.display_distro_helpc C s^ t tjkrZtjt dkrZd| _ttjkrZtjt s6dS tjjtjt | j | _tjt S dS )zCheck if sos is running in a container and perform container
specific initialisation based on ENV_HOST_SYSROOT.
r ocipodmanTN)r r] r^ )
ENV_CONTAINERr environZ
_in_containerENV_HOST_SYSROOTr abspathZ_tmp_dir)r# r' r' r( r s
zLinuxPolicy._container_initc C s g | _ tj j}tdd| jdj }| j jdd |dd D | jd| d }yPt |d
d d 8}x0|D ](}|j
d
d j
dd }| j j | qlW W dQ R X W n4 t k
r } z| j
jd| W Y dd}~X nX ddd}d| d| df} x<| D ]$}
| j|
}
tjj|
r |
} P q W | j
jd dS g } yLt | d
d d 4} x,| D ]$}d|krT| j |j
dd qTW W dQ R X W n6 t k
r } z| j
jd| W Y dd}~X nX x,|j D ] \}
}|| kr| j j |
qW dS )zxObtain a list of loaded kernel modules to reference later for plugin
enablement and SoSPredicate checks
Zlsmodr )timeoutr c S s g | ]}|j d j qS )r )r4 r5 ).0r6 r' r' r(
s z3LinuxPolicy.init_kernel_modules..r. Nz/usr/lib/modules/z/modules.builtinr8 zutf-8)r9 r z.koz Unable to read kernel builtins: ZCONFIG_NET_DEVLINKZCONFIG_BLK_DEV_DM)ZdevlinkZdm_modz
/boot/config-z
/lib/modules/z/configz#Unable to find booted kernel configz=yz%Unable to read booted kernel config: )Z kernel_modsr unamerD r
r r2 extend join_sysrootr> r4 r1 IOErrorsoslogwarningr existsrZ )r# rD linesbuiltinsZmfiler6 ZkmoderrZconfig_stringsZkconfigsZkconfigZ
booted_configZkfileZbuiltinr\ r' r' r( r sH
$
($
z LinuxPolicy.init_kernel_modulesc C s* | j r&| j dkr&tjj| j |jd}|S )Nr )r r r r[ lstrip)r# r r' r' r( ri # s zLinuxPolicy.join_sysrootc C s( | j d }|jr| j | j|| _d S )NZ cmdlineopts)ZcommonsZ low_priority_configure_low_priorityprompt_for_case_idcase_id)r# cmdline_optsr' r' r( pre_work( s
zLinuxPolicy.pre_workc C s< |j r$|j r$|js$ttd|_|jr0|jnd| _| jS )NzNOptionally, please enter the case id that you are generating this report for: r )Zbatchquietrt input_)r# ru r' r' r( rs 3 s z LinuxPolicy.prompt_for_case_idc C s t j }tdrdtd| dd}|d dkr<| jjd qpd|d d
|d d }| jj| n | jjd yt j d
| jjd W n4 t
k
r } z| jjd| W Y dd}~X nX dS )ay Used to constrain sos to a 'low priority' execution, potentially
letting individual policies set their own definition of what that is.
By default, this will attempt to assign sos to an idle io class via
ionice if available. We will also renice our own pid to 19 in order to
not cause competition with other host processes for CPU time.
Zionicezionice -c3 -p )rc Zstatusr zSet IO class to idlez Error setting IO class to idle: outputz (exit code )zNWarning: unable to constrain report to idle IO class: ionice is not available. z Set niceness of report to 19z%Error setting report niceness to 19: N) r getpidr r
rk infoerrorZui_logrl nice Exception)r# Z_pidretmsgrp r' r' r( rr @ s
z#LinuxPolicy._configure_low_priorityc C s dS )zIf sos report commands need to always be prefixed with something,
for example running in a specific container image, then it should be
defined here.
If no prefix should be set, return an empty string instead of None.
r r' )r# r' r' r( set_sos_prefix_ s zLinuxPolicy.set_sos_prefixc C s dS )zcIf a host requires additional cleanup, the command should be set and
returned here
r r' )r# r' r' r( set_cleanup_cmdh s zLinuxPolicy.set_cleanup_cmdc C s dS )aI Returns the command that will create the container that will be
used for running commands inside a container on hosts that require it.
This will use the container runtime defined for the host type to
launch a container. From there, we use the defined runtime to exec into
the container's namespace.
:param image: The name of the image if not using the policy default
:type image: ``str`` or ``None``
:param auth: The auth string required by the runtime to pull an
image from the registry
:type auth: ``str`` or ``None``
:param force_pull: Should the runtime forcibly pull the image
:type force_pull: ``bool``
:returns: The command to execute to launch the temp container
:rtype: ``str``
r r' )r# ZimageZauthZ
force_pullr' r' r( create_sos_containero s z LinuxPolicy.create_sos_containerc C s | j d| j S )a Restarts the container created for sos collect if it has stopped.
This is called immediately after create_sos_container() as the command
to create the container will exit and the container will stop. For
current container runtimes, subsequently starting the container will
default to opening a bash shell in the container to keep it running,
thus allowing us to exec into it again.
z start )container_runtimesos_container_name)r# r' r' r( restart_sos_container s
z!LinuxPolicy.restart_sos_containerc C s" | j r | j d| j d| S |S )a Returns the command that allows us to exec into the created
container for sos collect.
:param cmd: The command to run in the sos container
:type cmd: ``str``
:returns: The command to execute to run `cmd` in the container
:rtype: ``str``
z exec rU )r r )r# cmdr' r' r( format_container_command s z$LinuxPolicy.format_container_command)NNTN)r )NNF).__name__
__module__ __qualname__rV vendorrX r$ r; r/ r0 rW r Z_preferred_hash_nameZ
containerizedZcontainer_imageZsos_path_stripZ sos_pkg_nameZ sos_bin_pathr Zcontainer_version_commandZcontainer_authfiler classmethodr* rC rE rF rG rI rJ rM rR rN rP r r ri rv rs rr r r r r r
__classcell__r' r' )r& r( r # sV ( +;
r c @ s, e Zd ZdZd
gZdZdZed ddZd S ) GenericLinuxPolicyzThis Policy will be returned if no other policy can be loaded. This
should allow for IndependentPlugins to be executed on any systemUpstream Project https://github.com/sosreport/sosZSoSa SoS was unable to determine that the distribution of this system is supported, and has loaded a generic configuration. This may not provide desired behavior, and users are encouraged to request a new distribution-specifc policy at the GitHub project above.
r c C s t dS )z|
This function is responsible for determining if the underlying system
is supported by this policy.
N)NotImplementedError)r) rA r' r' r( rC s zGenericLinuxPolicy.checkN)r r )r ) r r r rV rY r Z vendor_textr rC r' r' r' r( r s r ) r rK Zsosr ry Z sos.policiesr Zsos.policies.init_systemsr Z!sos.policies.init_systems.systemdr Zsos.policies.runtimes.crior Z sos.policies.runtimes.podmanr Z sos.policies.runtimes.dockerr Zsos.policies.runtimes.lxdr Z
sos.utilitiesr
r r r
r? r_ ra r r r' r' r' r(
s$