3
d? Z&e j fd@dAZ'dBdC Z(dDdE Z)dFdG Z*dHdI Z+dJdK Z,dLdM Z-d|dOdPZ.d}dQdRZ/d~dSdTZ0ddUdVZ1dWdX Z2dYdZ Z3d[d\ Z4d]d^ Z5d_d` Z6ddbdcZ7ddddeZ8dfdg Z9dhdi Z:djdk Z;ddldmZdrds Z?dtdu Z@ddvdwZAddxdyZBdzd{ ZCdNS )Plugina
Base class for all plugins.
Plugins change various system settings in order to get desired performance or power
saving. Plugins use Monitor objects to get information from the running system.
Intentionally a lot of logic is included in the plugin to increase plugin flexibility.
c C sn |j | jj| _|| _|| _|| _|| _|| _t j
| _ | j || _
|| _d| _d| _| j | _t | _dS )zPlugin constructor.FN)create __class____name___storageZ_monitors_repositoryZ_hardware_inventory_device_matcher_device_matcher_udev_instance_factory collections OrderedDict
_instances_init_commands _global_cfg
_variables_has_dynamic_options_devices_inited#_get_config_options_used_by_dynamic_options_used_by_dynamicr _cmd) selfZmonitors_repositoryZstorage_factoryZhardware_inventoryZdevice_matcherZdevice_matcher_udevZinstance_factoryZ
global_cfg variables r /usr/lib/python3.6/base.py__init__ s
zPlugin.__init__c C s | j d S )N)destroy_instances)r r r r cleanup, s zPlugin.cleanupc C s | j s| j d| _ d S )NT)r
_init_devices)r r r r init_devices/ s zPlugin.init_devicesc C s | j jjdd jddd S )N. _)r
__module__split)r r r r name4 s z Plugin.namec C s i S )z-Default configuration options for the plugin.r )r r r r _get_config_options< s zPlugin._get_config_optionsc C s i S )z*Explanation of each config option functionr )clsr r r get_config_options_hintsA s z Plugin.get_config_options_hintsc C s g S )znList of config options used by dynamic tuning. Their previous values will be automatically saved and restored.r )r r r r r F s z*Plugin._get_config_options_used_by_dynamicc C sP | j j }x>|D ]6}||ks$| jr2|| ||< qtjd|| jjf qW |S )z3Merge provided options with plugin default options.z$Unknown option '%s' for plugin '%s'.)r( copyr logwarnr r )r optionsZ effectivekeyr r r _get_effective_optionsK s
z Plugin._get_effective_optionsc C s, t |tkr|S t|j }|dkp*|dkS )Ntrue1)typeboolstrlower)r valuer r r _option_boolV s zPlugin._option_boolc C sF || j krtd| | j|}| jj| ||||||}|| j |< |S )z8Create new instance of the plugin and seize the devices.z.Plugin instance with name '%s' already exists.)r Exceptionr0 r r ) r r' devices_expressiondevices_udev_regex
script_pre script_postr. Zeffective_optionsinstancer r r create_instance` s
zPlugin.create_instancec C sV |j | krtd|| f |j| jkr2td| | j|j }| j| | j|j= dS )zDestroy existing instance.z9Plugin instance '%s' does not belong to this plugin '%s'.z+Plugin instance '%s' was already destroyed.N)Z_pluginr9 r' r _destroy_instance)r r> r r r destroy_instancel s
zPlugin.destroy_instancec C s$ t jd|j| jf | j| dS )zInitialize an instance.z initializing instance %s (%s)N)r, debugr' _instance_init)r r> r r r initialize_instancew s zPlugin.initialize_instancec C sF x6t | jj D ]$}tjd|j| jf | j| qW | jj dS )zDestroy all instances.zdestroying instance %s (%s)N)listr valuesr, rB r' r@ clear)r r> r r r r | s zPlugin.destroy_instancesc C s | j | | j| d S )N)release_devices_instance_cleanup)r r> r r r r@ s
zPlugin._destroy_instancec C s
t d S )N)NotImplementedError)r r> r r r rC s zPlugin._instance_initc C s
t d S )N)rJ )r r> r r r rI s zPlugin._instance_cleanupc C s d| _ t | _t | _d S )NF)_devices_supportedset_assigned_devices
_free_devices)r r r r r s zPlugin._init_devicesc C s dS )zOverride this in a subclass to transform a list of device names (e.g. ['sda'])
to a list of pyudev.Device objects, if your plugin supports itNr )r devicesr r r _get_device_objects s zPlugin._get_device_objectsc C sj |j d kr t| jj|j|S | j|}|d krDtjd| j t S | j j|j |}tdd |D S d S )Nz s z0Plugin._get_matching_devices..)
r; rL r
Z
match_listr: rP r, errorr' r )r r> rO Z udev_devicesr r r _get_matching_devices s
z Plugin._get_matching_devicesc C s | j s
d S tjd|j | j|| j}t|dk|_|jsNtjd|j n`|j}|j| jkrn|d| j 7 }tj d|dj
|f |j j | | j
|O _
| j|8 _d S )Nz assigning devices to instance %sr z*instance %s: no matching devices availablez (%s)z!instance %s: assigning devices %sz, )rK r, rB r' rU rN lenactiver- infojoinassigned_devicesupdaterM )r r> Z to_assignr' r r r assign_free_devices s zPlugin.assign_free_devicesc C sV | j s
d S |j|jB | j@ }d|_|jj |jj | j|8 _| j|O _d S )NF)rK processed_devicesrZ rM rW rG rN )r r> Z
to_releaser r r rH s
zPlugin.release_devicesc C s( | j s d g}x|D ]}||| qW d S )N)rK )r r> callbackrO devicer r r _run_for_each_device s
zPlugin._run_for_each_devicec C s d S )Nr )r r> enablingr r r _instance_pre_static s zPlugin._instance_pre_staticc C s d S )Nr )r r> ra r r r _instance_post_static s z Plugin._instance_post_staticc C sn |d kr d S t |dkr0tjd|j|f d S |jdsHtjd dS tjj|}d}x|D ]}tj } | j
| j j |g}
|t
jkr|
jd |
j| tjd |t|
f tjd
tt| j yVt|g|
ttd| |dd } | j \} }
| jr$tjd || j|
d d f d}W q` ttfk
rd } z tjd||f d}W Y d d }~X q`X q`W |S )Nr z1Instance '%s': no device to call script '%s' for./z ZscriptoprO rollbackZdir_nameretZdevrm Z argumentsprocouterrer r r _call_device_script sB
zPlugin._call_device_scriptc C s |j s
dS |jrZ| j||jd|j | j|d | j| | j|d | j||jd|j |j r| j
j t j
t jr| j|| j|j |jj|j |jj dS )zG
Apply static and dynamic tuning if the plugin instance is active.
NZapplyT)rW has_static_tuningr{ r< rZ rb _instance_apply_staticrc r= has_dynamic_tuningr getrn CFG_DYNAMIC_TUNINGCFG_DEF_DYNAMIC_TUNINGr` _instance_apply_dynamicr] r[ rG )r r> r r r instance_apply_tuning s
z Plugin.instance_apply_tuningc C s |j s
dS t|jdkr.tjddj|j |jj }|jr| j ||j
d|dkrXdS | j |||dkrndS | j ||j d|dkrdS dS dS dS )z<
Verify static tuning if the plugin instance is active.
Nr z)BUG: Some devices have not been tuned: %sz, ZverifyFT)
rW rV rZ r, rT rY r] r+ r| r{ r< _instance_verify_staticr= )r r> ignore_missingrO r r r instance_verify_tuning s
z Plugin.instance_verify_tuningc C s< |j s
dS |jr8| jjtjtjr8| j|| j|j j
dS )z<
Apply dynamic tuning if the plugin instance is active.
N) rW r~ r r rn r r r` _instance_update_dynamicr] r+ )r r> r r r instance_update_tuning$ s z Plugin.instance_update_tuningc C s |t jkrdS |jr8| jjt jt jr8| j|| j|j |j
r| j ||j d|j |d | j
|d | j|| | j|d | j ||jd|j |d dS )z8
Remove all tunings applied by the plugin instance.
NZunapply)ru F)rn Z
ROLLBACK_NONEr~ r r r r r` _instance_unapply_dynamicr] r| r{ r= rb _instance_unapply_staticrc r< )r r> ru r r r instance_unapply_tuning- s
z Plugin.instance_unapply_tuningc C s | j | | j||j d S )N) _execute_all_non_device_commands _execute_all_device_commandsrZ )r r> r r r r} ? s
z Plugin._instance_apply_staticc C s2 d}| j ||dkrd}| j|||dkr.d}|S )NTF) _verify_all_non_device_commands_verify_all_device_commands)r r> r rO rv r r r r C s z Plugin._instance_verify_staticc C s | j ||j | j| d S )N) _cleanup_all_device_commandsr] _cleanup_all_non_device_commands)r r> ru r r r r K s z Plugin._instance_unapply_staticc sF x4 fddj D D ]}jj| qW j d S )Nc s( g | ] }j j| d kr|qS )N) _storage_get _commands)rQ opt)r_ r> r r r rS Q s z2Plugin._instance_apply_dynamic..)r _check_and_save_valuer r )r r> r_ Zoptionr )r_ r> r r r P s z Plugin._instance_apply_dynamicc C s
t d S )N)rJ )r r> r_ r r r r V s z Plugin._instance_unapply_dynamicc C s
t d S )N)rJ )r r> r_ r r r r Y s z Plugin._instance_update_dynamicc C s t j | _| j | j dS )z
Initialize commands.
N)r
r r _autoregister_commands_check_commands)r r r r r ` s
zPlugin._init_commandsc C s x| j jD ]}|jdrq
t| |}t|ds0q
|jd }| jj|d|i}d|jkrd|d< ||d< |jd |d< |jd |d< nBd |jkr||d < n.d|jkr||d< |jd |d< |jd |d< || j|< q
W tj t
t | jj d
d d | _dS )
zd
Register all commands marked using @command_set, @command_get, and @command_custom decorators.
___commandr' rL Ncustom
per_devicepriorityr c S s | d d S )Nr" r r )Z name_infor r r s z/Plugin._autoregister_commands..)r/ )
r __dict__ri getattrhasattrr r r r
r sortediterrp )r member_namemember command_namerX r r r r h s*
z Plugin._autoregister_commandsc C sJ xDt | jj D ]2\}}|jddr&qd|ks6d|krtd| qW dS )z2
Check if all commands are defined correctly.
r Fr rL z,Plugin command '%s' is not defined correctlyN)rE r rp r TypeError)r r commandr r r r s
zPlugin._check_commandsNc C sJ t | j}|d krdn|}|d kr&dn|}|d kr6dn|}d||||f S )N z %s/%s/%s/%s)r3 r )r Z
instance_namer device_name
class_namer r r _storage_key s
zPlugin._storage_keyc C s& | j |j|d |}| jj|| d S )Nr' )r r' r rL )r r> r r7 r r/ r r r _storage_set s zPlugin._storage_setc C s | j |j|d |}| jj|S )Nr' )r r' r r )r r> r r r/ r r r r s zPlugin._storage_getc C s | j |j|d |}| jj|S )Nr' )r r' r Zunset)r r> r r r/ r r r _storage_unset s zPlugin._storage_unsetc C sV xPdd t | jj D D ]4}| jj|jj|d d }|d k r| j||| qW d S )Nc S s g | ]}|d s|qS )r r )rQ r r r r rS s z;Plugin._execute_all_non_device_commands..r' )rE r rF r expandr. r _execute_non_device_command)r r> r new_valuer r r r s z'Plugin._execute_all_non_device_commandsc C sh xbdd t | jj D D ]F}| jj|jj|d d }|d krBqx |D ]}| j|||| qHW qW d S )Nc S s g | ]}|d r|qS )r r )rQ r r r r rS s z7Plugin._execute_all_device_commands..r' )rE r rF r r r. r _execute_device_command)r r> rO r r r_ r r r r s
z#Plugin._execute_all_device_commandsc C sd d}xZdd t | jj D D ]>}| jj|jj|d d }|d k r | j||||dkr d}q W |S )NTc S s g | ]}|d s|qS )r r )rQ r r r r rS s z:Plugin._verify_all_non_device_commands..r' F)rE r rF r r r. r _verify_non_device_command)r r> r rv r r r r r r s z&Plugin._verify_all_non_device_commandsc C sn d}xddd t | jj D D ]H}|jj|d d }|d kr>q x&|D ] }| j|||||dkrDd}qDW q W |S )NTc S s g | ]}|d r|qS )r r )rQ r r r r rS s z6Plugin._verify_all_device_commands..r' F)rE r rF r. r _verify_device_command)r r> rO r rv r r r_ r r r r s
z"Plugin._verify_all_device_commandsc C s |d k rt |}t|dkr |S |d d }|dd }|d krP|dkrL|S |S yF|dkrtt|t|krn|S d S n |dkrt|t|k r|S d S W n* tk
r tjd||||f Y nX |S )Nr" <>zhcannot compare new value '%s' with current value '%s' by operator '%s', using '%s' directly as new value)r r )r5 rV int
ValueErrorr, r- )r r
current_valueZnwsrt valr r r _process_assignment_modifiers s( z$Plugin._process_assignment_modifiersFc C s& |d k r|d ||dS |d S d S )Nr )r r )r r r_ r r r r _get_current_value s zPlugin._get_current_valuec C s< | j ||}| j||}|d k r8|d k r8| j|||| |S )N)r r r )r r> r r_ r r r r r r s
z Plugin._check_and_save_valuec C sR |d d k r"|d d||dd n,| j ||||}|d k rN|d ||ddd d S )Nr TFrL )simremove)r )r r> r r_ r r r r r s
z Plugin._execute_device_commandc C sN |d d k r |d d|dd n*| j ||d |}|d k rJ|d |ddd d S )Nr TFrL )r r )r )r r> r r r r r r s
z"Plugin._execute_non_device_commandc C s. | j jt|}tjd|r*tjdd|S |S )Nz \s*(0+,?)+([\da-fA-F]*,?)*\s*$z ^\s*(0+,?)+r )r Zunquoter5 rematchsub)r r7 vr r r _norm_value s zPlugin._norm_valuec C s( |d kr d S d}|d krN|rN|d kr6t jtj| nt jtj||f dS |d k r| j|}| j|}yt|t|k}W n tk
r yt|dt|dk}W n^ tk
r t|t|k}|st|j d}x"|D ]}|j
}||k}|rP qW Y nX Y nX | j |||||d |S )NFT |)r_ ) r, rX rn Z STR_VERIFY_PROFILE_VALUE_MISSINGZ'STR_VERIFY_PROFILE_DEVICE_VALUE_MISSINGr r r r5 r& strip_log_verification_result) r r' r r r r_ rv valsr r r r
_verify_value
s8
zPlugin._verify_valuec C s |rL|d kr*t jtj|t|j f n t jtj||t|j f dS |d kr|t jtj|t|j t|j f n(t jtj ||t|j t|j f dS d S )NTF)
r, rX rn ZSTR_VERIFY_PROFILE_VALUE_OKr5 r Z"STR_VERIFY_PROFILE_DEVICE_VALUE_OKrT Z STR_VERIFY_PROFILE_VALUE_FAILZ$STR_VERIFY_PROFILE_DEVICE_VALUE_FAIL)r r' successr r r_ r r r r - s ((z Plugin._log_verification_resultc C sp |d d k r |d d||d|S | j |||d}| j||}|d krHd S |d ||dd}| j|d ||||S )Nr T)r rL Fr' )r r r )r r> r r_ r r r r r r r < s z Plugin._verify_device_commandc C sd |d d k r |d d|d|S | j |}| j||}|d kr@d S |d |dd}| j|d |||S )Nr TrL Fr' )r r r )r r> r r r r r r r r F s
z!Plugin._verify_non_device_commandc C sZ xTt dd t| jj D D ]4}|jj|d d d k sF|d | jkr | j|| q W d S )Nc S s g | ]}|d s|qS )r r )rQ r r r r rS Q s z;Plugin._cleanup_all_non_device_commands..r' )reversedrE r rF r. r r _cleanup_non_device_command)r r> r r r r r P s "$z'Plugin._cleanup_all_non_device_commandsc C sl xft dd t| jj D D ]F}|jj|d d d k sF|d | jkr x |D ]}| j|||| qLW q W d S )Nc S s g | ]}|d r|qS )r r )rQ r r r r rS V s z7Plugin._cleanup_all_device_commands..r' )r rE r rF r. r r _cleanup_device_command)r r> rO r r r_ r r r r U s "$
z#Plugin._cleanup_all_device_commandsc C s^ |d d k r"|d dd |dd n8| j |||}|d k rL|d ||d|d | j||| d S )Nr FrL )r r )r r )r r> r r_ r old_valuer r r r [ s z Plugin._cleanup_device_commandc C sV |d d k r |d dd dd n2| j ||}|d k rF|d |ddd | j|| d S )Nr FrL )r r )r r )r r> r r r r r r d s z"Plugin._cleanup_non_device_command)NNN)N)N)N)NF)NN)N)N)F)F)Dr r% __qualname____doc__r r r propertyr' classmethodr( r* r r0 r8 r? rA rD r r@ rC rI r rP rU r\ rH r` rb rc rn Z
ROLLBACK_SOFTr{ r r r r r} r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r s|
#
!
r )r Z tuned.constsrn Ztuned.profiles.variablesZtunedZ
tuned.logsr
Ztuned.utils.commandsr rj
subprocessr r Zlogsr r, objectr r r r r s