File: //usr/lib/python3/dist-packages/sos/policies/distros/__pycache__/__init__.cpython-310.pyc
o
([Qh�> � @ 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� de�ZG dd� de�Z dS )� N)�_sos)�Policy)�
InitSystem)� SystemdInit)�CrioContainerRuntime)�PodmanContainerRuntime)�DockerContainerRuntime)�LxdContainerRuntime)� shell_out�
is_executable�bold�sos_get_command_outputz/etc/os-release� container�HOSTc s2 e Zd ZdZdZdZdZdZdZdZ dZ
dZ dZ dZ
dZdZdZdZd ZdZdZ
d9� fd d � Zed
d� �Zed:dd��Zdd� 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;d3d4�Z*d5d6� Z+d7d8� Z,� Z-S )<� LinuxPolicyzfThis policy is meant to be an abc class that provides common
implementations used in Linux distros�Nonez /bin:/sbin:/usr/bin:/usr/sbinN� �dockerFz/usr/binzsos-collector-tmpTc s& t � j|||d� |r|| _n| �� pd| _| �� |d ur"|| _ntj�d�r0t | jd�| _nt
� | _i | _ | j r�t
| d�t| d�t| d�t| d�g}|D ]#}|�� rq|| j |j< |j| jkri| j |j | j d< | j |j �� qN| j r�d| j vr�t| j �� �}| j |d | j d< d S d S d S d S )N)�sysroot�
probe_runtime� remote_exec�/z/run/systemd/system/)�chroot)�policy�defaultr )�super�__init__r �_container_init�init_kernel_modules� init_system�os�path�isdirr r �runtimesr r r r r �check_is_active�name�default_container_runtime�load_container_info�list�keys)�selfr �initr r �_crun�runtime�idx�� __class__� �?/usr/lib/python3/dist-packages/sos/policies/distros/__init__.pyr ; s@ � � ��zLinuxPolicy.__init__c C s ddgS )Nz /etc/passwdz /etc/shadowr1 ��clsr1 r1 r2 �set_forbidden_pathsd s �z LinuxPolicy.set_forbidden_pathsc s� � fdd�}|r ||�S t j�� j�r't j�� j�t j�t j�� j��kr'dS ttddd��}||�� �W d � S 1 s?w Y dS )�|
This function is responsible for determining if the underlying system
is supported by this policy.
c s` � j g}� jr
|�� j� | �� D ] }|�d�r-|�d�dd � d �d�}||v r- dS qdS )N)zNAME=zID=�=� r z"'TF)�os_release_name�
os_release_id�append�
splitlines�
startswith�split�strip)�content�_matches�line�_distror3 r1 r2 �_check_releaseq s
�z)LinuxPolicy.check.<locals>._check_releaseT�r�utf-8��encodingN) r r! �isfile�os_release_file�basename�realpath�open�
OS_RELEASE�read)r4 �remoterD �fr1 r3 r2 �checkk s �
$�zLinuxPolicy.checkc C � | j S �N)�release�r* r1 r1 r2 �kernel_version� � zLinuxPolicy.kernel_versionc C rS rT )�hostnamerV r1 r1 r2 � host_name� rX zLinuxPolicy.host_namec C rS rT )�smprV r1 r1 r2 �
is_kernel_smp� rX zLinuxPolicy.is_kernel_smpc C rS rT )�machinerV r1 r1 r2 �get_arch� rX zLinuxPolicy.get_archc C s | � � S )z)Returns the name usd in the pre_work step)rZ rV r1 r1 r2 �get_local_name� s zLinuxPolicy.get_local_namec C s t �dd|�S )Nz[^-a-z,A-Z.0-9]r )�re�sub)r* r% r1 r1 r2 �sanitize_filename� s z LinuxPolicy.sanitize_filenamec C s6 | t kr | �|� d S |�| j� d�� | �|� d S )Nz Distribution Policy)r �display_self_help� set_titler9 �display_distro_help�r4 �sectionr1 r1 r2 � display_help� s zLinuxPolicy.display_helpc C s |� d� |�d� d S )NzSoS Distribution Policiesz�Distributions supported by SoS will each have a specific policy defined for them, to ensure proper operation of SoS on those systems.)rd �add_textrf r1 r1 r2 rc � s
�z LinuxPolicy.display_self_helpc C s6 | j r| j tj ur|�| j � n|�d� | d d d�}|�d|j� �� |jd|j� �dd� |jd|j� �dd� |�d�}| jD ]}|jdd �|d
d �|d d
��dd� qB|�d�}|jtdd �dd�dd�dd ���dd� |j �
� D ] \}}d� |j �
� �}|jdd �|d�|jd�|d ��dd� qxd 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<30r8 z<40z#Presets Available With This Policy
z Preset Namez<20� Descriptionz<45zEnabled Options)�__doc__r ri � _upload_urlr& �PATH� add_section� vendor_urlsr �presets�items�join�opts�to_args�desc) r4 rg �_pol�refsec�url�presec�preset�value�_optsr1 r1 r2 re � sH �
�
�
�
*
��� ��z LinuxPolicy.display_distro_helpc C s^ t tjv r-tjt dv r-d| _ttjv r-tjt sdS tj�tjt | j �| _tjt S dS )z�Check if sos is running in a container and perform container
specific initialisation based on ENV_HOST_SYSROOT.
)r �oci�podmanTN)�
ENV_CONTAINERr �environ�
_in_container�ENV_HOST_SYSROOTr! �abspath�_tmp_dirrV r1 r1 r2 r � s
�
zLinuxPolicy._container_initc
C s g | _ t�� j}tdd| jd��� }| j �dd� |dd� D �� | �d|� d ��}z0t |d
d d �� }|D ]}|�
d
�d �
d�d }| j � |� q5W d � n1 sTw Y W n t yu } z| j
�d|� �� W Y d}~nd}~ww ddd�}d|� �d|� d�f} | D ]}
| �|
�}
tj�|
�r�|
} n q�| j
�d� dS g } z,t | d
d d ��} | D ]}d|v r�| � |�
d�d � q�W d � n1 s�w Y W n t y� } z| j
�d|� �� W Y d}~nd}~ww |�� D ]\}
}|| v r�| j � |
� q�dS )zxObtain a list of loaded kernel modules to reference later for plugin
enablement and SoSPredicate checks
�lsmodr )�timeoutr c S s g | ]
}|� � d �� �qS )r )r> r? )�.0rB r1 r1 r2 �
<listcomp>� s �z3LinuxPolicy.init_kernel_modules.<locals>.<listcomp>r8 Nz/usr/lib/modules/z/modules.builtinrE rF rG r ���z.koz Unable to read kernel builtins: �CONFIG_NET_DEVLINK�CONFIG_BLK_DEV_DM)�devlink�dm_modz
/boot/config-z
/lib/modules/z/configz#Unable to find booted kernel configz=yz%Unable to read booted kernel config: )� kernel_modsr �unamerU r
r r< �extend� join_sysrootrM r> r; �IOError�soslog�warningr! �existsrs )r* rU �lines�builtins�mfilerB �kmod�err�config_strings�kconfigs�kconfig�
booted_config�kfile�builtinr} r1 r1 r2 r � sl
�
�� �� ���
�
� �� �� �� ��z LinuxPolicy.init_kernel_modulesc C s* | j r| j dkrtj�| j |�d��}|S )Nr )r r r! rt �lstrip)r* r! r1 r1 r2 r� # s zLinuxPolicy.join_sysrootc C s( | j d }|jr | �� | �|�| _d S )N� cmdlineopts)�commons� low_priority�_configure_low_priority�prompt_for_case_id�case_id�r* � cmdline_optsr1 r1 r2 �pre_work( s
zLinuxPolicy.pre_workc C s8 |j s|js|jsttd��|_|jr|jnd| _| jS )NzNOptionally, please enter the case id that you are generating this report for: r )�batch�quietr� �input�_r� r1 r1 r2 r� 3 s ����z LinuxPolicy.prompt_for_case_idc
C s� t �� }td�r2td|� �dd�}|d dkr | j�d� nd|d � d
|d � d �}| j�|� n| j�d � zt � d
� | j�d� W dS t
yb } z| j�d|� �� W Y d}~dS d}~ww )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.
�ionicezionice -c3 -p � )r� �statusr 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
r� �info�error�ui_logr� �nice� Exception)r* �_pid�ret�msgr� r1 r1 r2 r� @ s*
� ��
��z#LinuxPolicy._configure_low_priorityc C � dS )z�If 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 r1 rV r1 r1 r2 �set_sos_prefix_ s zLinuxPolicy.set_sos_prefixc C r� )zcIf a host requires additional cleanup, the command should be set and
returned here
r r1 rV r1 r1 r2 �set_cleanup_cmdh s zLinuxPolicy.set_cleanup_cmdc C r� )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 r1 )r* �image�auth�
force_pullr1 r1 r2 �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_runtime�sos_container_namerV r1 r1 r2 �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 rk r� )r* �cmdr1 r1 r2 �format_container_command� s
�z$LinuxPolicy.format_container_command)NNTN�r )NNF).�__name__�
__module__� __qualname__rm �vendorro r+ rJ r9 r: rn r& �_preferred_hash_name�
containerized�container_image�sos_path_strip� sos_pkg_name� sos_bin_pathr� �container_version_command�container_authfiler � classmethodr5 rR rW rZ r\ r^ r_ rb rh rc re r r r� r� r� r� r� r� r� r� r� �
__classcell__r1 r1 r/ r2 r # sb �)
*;
r c @ s, e Zd ZdZdgZdZdZed dd��ZdS )
�GenericLinuxPolicyz�This Policy will be returned if no other policy can be loaded. This
should allow for IndependentPlugins to be executed on any system)zUpstream Projectz https://github.com/sosreport/sos�SoSa 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 �)r6 )�NotImplementedError)r4 rP r1 r1 r2 rR � s zGenericLinuxPolicy.checkNr� ) r� r� r� rm rq r� � vendor_textr� rR r1 r1 r1 r2 r� � s r� ) r r` �sosr r� � sos.policiesr �sos.policies.init_systemsr �!sos.policies.init_systems.systemdr �sos.policies.runtimes.crior � sos.policies.runtimes.podmanr � sos.policies.runtimes.dockerr �sos.policies.runtimes.lxdr �
sos.utilitiesr
r r r
rN r� r� r r� r1 r1 r1 r2 �<module> s&