a
Á]›i
[ ã @ sn d dl Z d dlmZ d dlZd dlZd dlZd dlmZ d dl Z d dl
m Z m Z ej
¡ ZG dd„ deƒZdS )é N)Úcommands)ÚPopenÚPIPEc @ s6 e Zd ZdZdd„ Zdd„ Zdd„ Zedd „ ƒZe d
d „ ƒZ
e d d
„ ƒZ e dd„ ƒZ dd„ Z
dd„ Zdd„ Zdd„ Zdd„ Zdd„ Zd d „ Zd d „ Zd d!„ Zd"d#„ Zd$d%„ Zd&d'„ Zd(d)„ Zd*d+„ Zd,d-„ Zd.d/„ Z d0d1„ Z d2d3„ Z e j fd4d5„Z!d6d7„ Z"d8d9„ Z#d:d;„ Z$e j fdd?„ Z&d@dA„ Z'e j fdBdC„Z(dDdE„ Z)dFdG„ Z*dHdI„ Z+dJdK„ Z,dLdM„ Z-dNdO„ Z.dPdQ„ Z/d€dSdT„Z0ddUdV„Z1d‚dWdX„Z2dƒdYdZ„Z3d[d\„ Z4d]d^„ Z5d_d`„ Z6dadb„ Z7dcdd„ Z8d„dfdg„Z9d…dhdi„Z:djdk„ Z;dldm„ Zd‡drds„Z?dtdu„ Z@dvdw„ ZAdxdy„ ZBdˆdzd{„ZCd‰d|d}„ZDd~d„ ZEdRS )ŠÚ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 | | jj¡| _|| _|| _|| _|| _|| _t
¡ | _ | ¡ || _
|| _d| _d| _| ¡ | _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_cfgZ variables© r ú6/usr/lib/python3.9/site-packages/tuned/plugins/base.pyÚ__init__ s
zPlugin.__init__c C s | ¡ d S ©N)Údestroy_instances©r r r r Úcleanup, s zPlugin.cleanupc C s | j s| ¡ d| _ d S )NT)r Ú
_init_devicesr r r r Ú init_devices/ s zPlugin.init_devicesc C s | j j d¡d dd¡d S )NÚ.éÿÿÿÿÚ_é )r Ú
__module__Úsplitr 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 sL | ¡ ¡ }|D ]6}||v s"| jr0|| ||< qt d|| jjf ¡ q|S )z3Merge provided options with plugin default options.z$Unknown option '%s' for plugin '%s'.)r) Úcopyr ÚlogÚwarningr r )r ÚoptionsZ effectiveÚkeyr r r Ú_get_effective_optionsK s z Plugin._get_effective_optionsc C s, t |ƒtu r|S t|ƒ ¡ }|dkp*|dkS )NÚtrueÚ1)ÚtypeÚboolÚstrÚlower)r Úvaluer r r Ú _option_boolV s zPlugin._option_boolc
C sf || j v rtd| ƒ‚| |¡}| j | |||||||¡} | | j |< t t| j ¡ dd„ d¡| _ | S )z8Create new instance of the plugin and seize the devices.z.Plugin instance with name '%s' already exists.c S s
| d j S )Nr% )Úpriority)Úxr r r Úi ó z(Plugin.create_instance..©r0 ) r Ú Exceptionr1 r r r
r ÚsortedÚitems)
r r( r: Údevices_expressionÚdevices_udev_regexÚ
script_preÚ script_postr/ Zeffective_optionsÚinstancer r r Úcreate_instance` s
ÿ
zPlugin.create_instancec C sV |j | krtd|| f ƒ‚|j| jvr2td| ƒ‚| 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_pluginr? r( r Ú_destroy_instance©r rF r r r Údestroy_instancem s
zPlugin.destroy_instancec C s$ t d|j| jf ¡ | |¡ dS )zInitialize an instance.z initializing instance %s (%s)N)r- Údebugr( Ú_instance_initrI r r r Úinitialize_instancex s zPlugin.initialize_instancec C sB t | j ¡ ƒD ]$}t d|j| jf ¡ | |¡ q| j ¡ dS )zDestroy all instances.zdestroying instance %s (%s)N)Úlistr Úvaluesr- rK r( rH ÚclearrI r r r r } s zPlugin.destroy_instancesc C s | |¡ | |¡ d S r )Úrelease_devicesÚ_instance_cleanuprI r r r rH „ s
zPlugin._destroy_instancec C s
t ƒ ‚d S r ©ÚNotImplementedErrorrI r r r rL ˆ s zPlugin._instance_initc C s
t ƒ ‚d S r rS rI r r r rR ‹ s zPlugin._instance_cleanupc C s d| _ tƒ | _tƒ | _d S ©NF)Ú_devices_supportedÚsetÚ_assigned_devicesÚ
_free_devicesr r r r r ’ s zPlugin._init_devicesc C s dS )z’Override 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 u r t| j |j|¡ƒS | |¡}|d u rDt d| j¡ tƒ S | j |j |¡}tdd„ |D ƒƒS d S )Nz¥ r= z0Plugin._get_matching_devices..)
rC rW r
Z
match_listrB r[ r- Úerrorr( r )r rF rZ Z udev_devicesr r r Ú_get_matching_devicesœ s
z Plugin._get_matching_devicesc C s² | j s
d S t d|j ¡ | || j¡}t|ƒdk|_|jsNt d|j ¡ n`|j}|j| jkrn|d| j 7 }t d|d
|¡f ¡ |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 %sú, )rV r- rK r( r_ rY ÚlenÚactiver. ÚinfoÚjoinÚassigned_devicesÚupdaterX )r rF Z to_assignr( r r r Úassign_free_devices§ s zPlugin.assign_free_devicesc C sV | j s
d S |j|jB | j@ }d|_|j ¡ |j ¡ | j|8 _| j|O _d S rU )rV Úprocessed_devicesre rX rb rP rY )r rF Z
to_releaser r r rQ ¹ s ÿþ
zPlugin.release_devicesc C s$ | j s d g}|D ]}|||ƒ qd S r )rV )r rF ÚcallbackrZ Údevicer r r Ú_run_for_each_deviceË s zPlugin._run_for_each_devicec C s d S r r ©r rF Zenablingr r r Ú_instance_pre_staticÒ s zPlugin._instance_pre_staticc C s d S r r rl r r r Ú_instance_post_staticÕ s z Plugin._instance_post_staticc C s< t j |¡}| j tjtj¡}|D ]}| |¡r" dS q"dS ©NTF) ÚosÚpathÚrealpathr Zget_listÚconstsZCFG_PROFILE_DIRSZCFG_DEF_PROFILE_DIRSÚ
startswith)r rq Z
profile_pathsÚpr r r Ú_safe_script_pathØ s
zPlugin._safe_script_pathc C sŠ |d u r d S t |ƒdkr0t d|j|f ¡ d S | d¡sHt d¡ dS | |¡sht dd| ¡ dS tj |¡}d}|D ]}tj
} | | j
¡ ¡ |g}
|tjkr²|
d ¡ |
|¡ t d
|t|
ƒf ¡ t d tt| ¡ ƒƒ ¡ zVt|g|
ttd| |dd } | ¡ \} }
| jr@t d
|| j|
d d… f ¡ d}W q| ttfy‚ } z"t d||f ¡ d}W Y d }~q|d }~0 0 q||S )Nr z1Instance '%s': no device to call script '%s' for.ú/zQRelative paths cannot be used in script_pre or script_post. Use ${i:PROFILE_DIR}.Fz?Paths outside of the profile directories cannot be used in the z0script_pre or script_post, ignoring script: '%s'TZ
full_rollbackz'calling script '%s' with arguments '%s'zusing environment '%s')ÚstdoutÚstderrZ close_fdsÚenvÚcwdZuniversal_newlineszscript '%s' error: %d, '%s'r# zscript '%s' error: %s) ra r- r. r( rt r^ rv rp rq ÚdirnameÚenvironrf r Zget_envrs Z
ROLLBACK_FULLÚappendrc r6 rK rN rA r r Z communicateÚ
returncodeÚOSErrorÚIOError)r rF ZscriptÚoprZ ÚrollbackZdir_nameÚretÚdevr} Z argumentsÚprocÚoutÚerrÚer r r Ú_call_device_scriptà sL
ÿ
ý zPlugin._call_device_scriptc C sª |j s
dS |jrZ| ||jd|j¡ | |d¡ | |¡ | |d¡ | ||jd|j¡ |j rŽ| j
t j
t j¡rŽ| |¡ | || j|j¡ |j |j¡ |j ¡ dS )zG
Apply static and dynamic tuning if the plugin instance is active.
NZapplyT)rb Úhas_static_tuningrŠ rD re rm Ú_instance_apply_staticrn rE Úhas_dynamic_tuningr Úgetrs ÚCFG_DYNAMIC_TUNINGÚCFG_DEF_DYNAMIC_TUNINGÚ_instance_init_dynamicrk Ú_instance_apply_dynamicrh rf rP rI r r r Úinstance_apply_tuning s"
ÿ
ÿ
z Plugin.instance_apply_tuningc C s” |j s
dS t|jƒdkr.t dd |j¡ ¡ |j ¡ }|jrŒ| ||j
d|¡dkrXdS | |||¡dkrndS | ||j d|¡dkrˆdS dS dS dS )z<
Verify static tuning if the plugin instance is active.
Nr z)BUG: Some devices have not been tuned: %sr` ZverifyFT)
rb ra re r- r^ rd rh r, r‹ rŠ rD Ú_instance_verify_staticrE )r rF Úignore_missingrZ r r r Úinstance_verify_tuning s
ÿ
z Plugin.instance_verify_tuningc C s< |j s
dS |jr8| j tjtj¡r8| || j|j
¡ ¡ dS )z<
Apply dynamic tuning if the plugin instance is active.
N) rb r r rŽ rs r r rk Ú_instance_update_dynamicrh r, rI r r r Úinstance_update_tuning2 s z Plugin.instance_update_tuningc C s– |t jkrdS |jr8| j t jt j¡r8| || j|j ¡ |j
r’| j ||j d|j |d |
|d¡ | ||¡ | |d¡ | j ||jd|j |d dS )z8
Remove all tunings applied by the plugin instance.
NZunapply)rƒ F)rs Z
ROLLBACK_NONEr r rŽ r r rk Ú_instance_unapply_dynamicrh r‹ rŠ rE rm Ú_instance_unapply_staticrn rD ©r rF rƒ r r r Úinstance_unapply_tuning; s
þ z Plugin.instance_unapply_tuningc C s | |¡ | ||j¡ d S r )Ú _execute_all_non_device_commandsÚ _execute_all_device_commandsre rI r r r rŒ M s
z Plugin._instance_apply_staticc C s2 d}| ||¡dkrd}| |||¡dkr.d}|S ro )Ú _verify_all_non_device_commandsÚ_verify_all_device_commands)r rF r• rZ r„ r r r r” Q s z Plugin._instance_verify_staticc C s | ||j¡ | |¡ d S r )Ú _cleanup_all_device_commandsrh Ú _cleanup_all_non_device_commandsr› r r r rš Y s ÿz Plugin._instance_unapply_staticc C s d S r r rI r r r r‘ ^ s z Plugin._instance_init_dynamicc sB ‡ ‡‡fdd„ˆj D ƒD ]}ˆ ˆˆj| ˆ ¡ qˆ ˆˆ ¡ d S )Nc s( g | ] }ˆ ˆˆj| ˆ ¡d u r|‘qS r )Ú _storage_getÚ _commands)r\ Úopt©rj rF r r r r] b r= z2Plugin._instance_apply_dynamic..)r Ú_check_and_save_valuer¤ r— )r rF rj Úoptionr r¦ r r’ a s z Plugin._instance_apply_dynamicc C s
t ƒ ‚d S r rS ©r rF rj r r r r™ g s z Plugin._instance_unapply_dynamicc C s
t ƒ ‚d S r rS r© r r r r— j s z Plugin._instance_update_dynamicc C s t ¡ | _| ¡ | ¡ dS )z
Initialize commands.
N)r
r r¤ Ú_autoregister_commandsÚ_check_commandsr r r r r q s
zPlugin._init_commandsc C sö | j jD ]Æ}| d¡rqt| |ƒ}t|dƒs.q|jd }| j |d|i¡}d|jv r‚d|d< ||d< |jd |d< |jd |d< nBd |jv r–||d < n.d|jv rÄ||d< |jd |d< |jd |d< || j|< qt t
t | j ¡ ƒd
d „ d ¡| _dS )
zd
Register all commands marked using @command_set, @command_get, and @command_custom decorators.
Ú__Ú_commandr( rW NÚcustomÚ
per_devicer: rŽ c S s | d d S )Nr% r: r )Z name_infor r r r< – r= z/Plugin._autoregister_commands..r> )
r Ú__dict__rt ÚgetattrÚhasattrr r¤ rŽ r
r r@ ÚiterrA )r Ú member_nameÚmemberÚ command_namerc r r r rª y s*
z Plugin._autoregister_commandsc C sF t | j ¡ ƒD ]2\}}| dd¡r$qd|vs4d|vrtd| ƒ‚qdS )z2
Check if all commands are defined correctly.
r® FrŽ rW z,Plugin command '%s' is not defined correctlyN)rN r¤ rA rŽ Ú TypeError)r r¶ Úcommandr r r r« ˜ s
zPlugin._check_commandsNc C sJ t | ƒj}|d u rdn|}|d u r&dn|}|d u r6dn|}d||||f S )NÚ z %s/%s/%s/%s)r4 r )r Z
instance_namer¶ Ú device_nameÚ
class_namer r r Ú _storage_key¨ s
ÿzPlugin._storage_keyc C s& | |j|d |¡}| j ||¡ d S ©Nr( )r¼ r( r rW )r rF r¸ r8 rº r0 r r r Ú _storage_set± s zPlugin._storage_setc C s | |j|d |¡}| j |¡S r½ )r¼ r( r rŽ ©r rF r¸ rº r0 r r r r£ µ s zPlugin._storage_getc C s | |j|d |¡}| j |¡S r½ )r¼ r( r Zunsetr¿ r r r Ú_storage_unset¹ s zPlugin._storage_unsetc C sR dd„ t | j ¡ ƒD ƒD ]4}| j |j |d d ¡¡}|d ur| |||¡ qd S )Nc S s g | ]}|d s|‘qS ©r¯ r ©r\ r¸ r r r r]  r= z;Plugin._execute_all_non_device_commands..r( )rN r¤ rO r Úexpandr/ rŽ Ú_execute_non_device_command©r rF r¸ Ú new_valuer r r r Á s z'Plugin._execute_all_non_device_commandsc C s` dd„ t | j ¡ ƒD ƒD ]B}| j |j |d d ¡¡}|d u r@q|D ]}| ||||¡ qDqd S )Nc S s g | ]}|d r|‘qS rÁ r r r r r r] È r= z7Plugin._execute_all_device_commands..r( )rN r¤ rO r rà r/ rŽ Ú_execute_device_command)r rF rZ r¸ rÆ rj r r r rž Ç s z#Plugin._execute_all_device_commandsc C s` d}dd„ t | j ¡ ƒD ƒD ]>}| j |j |d d ¡¡}|d ur | ||||¡dkr d}q |S )NTc S s g | ]}|d s|‘qS rÁ r r r r r r] Ñ r= z:Plugin._verify_all_non_device_commands..r( F)rN r¤ rO r rà r/ rŽ Ú_verify_non_device_command)r rF r• r„ r¸ rÆ r r r rŸ Ï s z&Plugin._verify_all_non_device_commandsc C sn d}dd„ t | j ¡ ƒD ƒD ]L}| j |j |d d ¡¡}|d u rDq |D ] }| |||||¡dkrHd}qHq |S )NTc S s g | ]}|d r|‘qS rÁ r r r r r r] Ú r= z6Plugin._verify_all_device_commands..r( F)rN r¤ rO r rà r/ rŽ Ú_verify_device_command)r rF rZ r• r„ r¸ rÆ rj r r r r Ø s z"Plugin._verify_all_device_commandsc
C sÌ |d urÈt |ƒ}t|ƒdkr |S |d d… }|dd … }|d u rP|dv rL|S |S zN|dkrxt|ƒt|ƒkrp|W S W d S n$|dkrœt|ƒt|ƒk r–|W S W d S W n( tyÆ t d||||f ¡ Y n0 |S )Nr% )ú<ú>rË rÊ zhcannot compare new value '%s' with current value '%s' by operator '%s', using '%s' directly as new value)r6 ra ÚintÚ
ValueErrorr- r. )r rÆ Ú
current_valueZnwsr‚ Úvalr r r Ú _process_assignment_modifiersã s(
z$Plugin._process_assignment_modifiersFc C s* |d ur|d |||dS |d |ƒS d S )NrŽ ©r• r )r rF r¸ rj r• r r r Ú_get_current_valueû s zPlugin._get_current_valuec C s> | |||¡}| ||¡}|d ur:|d ur:| ||||¡ |S r )rÒ rÐ r¾ )r rF r¸ rj rÆ rÎ r r r r§ s
z Plugin._check_and_save_valuec C sV |d d ur$|d d||dd|ƒ n.| ||||¡}|d urR|d |||ddd d S ©Nr® TFrW ©ZsimÚremove©r§ )r rF r¸ rj rÆ r r r rÇ s
z Plugin._execute_device_commandc C sR |d d ur"|d d|dd|ƒ n,| ||d |¡}|d urN|d ||ddd d S rÓ rÖ rÅ r r r rÄ s
z"Plugin._execute_non_device_commandc C s. | j t|ƒ¡}t d|¡r*t dd|¡S |S )Nz \s*(0+,?)+([\da-fA-F]*,?)*\s*$z ^\s*(0+,?)+r¹ )r Úunquoter6 ÚreÚmatchÚsub)r r8 Úvr r r Ú _norm_value s zPlugin._norm_valuec C s |d u r d S d}|d u rN|rN|d u r6t tj| ¡ nt tj||f ¡ dS |d ur| |¡}| |¡}zt|ƒt|ƒk}W n„ ty zt|dƒt|dƒk}W nV tyþ t|ƒt|ƒk}|sút|ƒ d¡}|D ] }|
¡ }||k}|rÜ qúqÜY n0 Y n0 | j |||||d |S )NFTé ú|)rj ) r- rc rs Z STR_VERIFY_PROFILE_VALUE_MISSINGZ'STR_VERIFY_PROFILE_DEVICE_VALUE_MISSINGrÜ rÌ rÍ r6 r' ÚstripÚ_log_verification_result) r r( rÆ rÎ r• rj r„ ZvalsrÏ r r r Ú
_verify_value s:
ÿzPlugin._verify_valuec C s¬ |rL|d u r*t tj|t|ƒ ¡ f ¡ n t tj||t|ƒ ¡ f ¡ dS |d u r|t tj|t|ƒ ¡ t|ƒ ¡ f ¡ n(t tj ||t|ƒ ¡ t|ƒ ¡ f ¡ dS d S ro )
r- rc rs ZSTR_VERIFY_PROFILE_VALUE_OKr6 rß Z"STR_VERIFY_PROFILE_DEVICE_VALUE_OKr^ Z STR_VERIFY_PROFILE_VALUE_FAILZ$STR_VERIFY_PROFILE_DEVICE_VALUE_FAIL)r r( ÚsuccessrÆ rÎ rj r r r rà > s ((z Plugin._log_verification_resultc C sv |d d ur"|d d||d||ƒS | j ||||d}| ||¡}|d u rLd S |d |||ddƒ}| |d ||||¡S )Nr® TrÑ rW Fr( ©rÒ rÐ rá )r rF r¸ rj rÆ r• rÎ r r r rÉ M s z Plugin._verify_device_commandc C sj |d d ur |d d|d||ƒS | ||¡}| ||¡}|d u rDd S |d ||ddƒ}| |d |||¡S )Nr® TrW Fr( rã )r rF r¸ rÆ r• rÎ r r r rÈ W s z!Plugin._verify_non_device_commandc C sV t dd„ t| j ¡ ƒD ƒƒD ]4}|j |d d ¡d usD|d | jv r | ||¡ q d S )Nc S s g | ]}|d s|‘qS rÁ r r r r r r] b r= z;Plugin._cleanup_all_non_device_commands..r( )ÚreversedrN r¤ rO r/ rŽ r Ú_cleanup_non_device_command)r rF r¸ r r r r¢ a s $z'Plugin._cleanup_all_non_device_commandsc C sd t dd„ t| j ¡ ƒD ƒƒD ]B}|j |d d ¡d usD|d | jv r |D ]}| ||||¡ qHq d S )Nc S s g | ]}|d r|‘qS rÁ r r r r r r] g r= z7Plugin._cleanup_all_device_commands..r( )rä rN r¤ rO r/ rŽ r Ú_cleanup_device_command)r rF rZ rÕ r¸ rj r r r r¡ f s $z#Plugin._cleanup_all_device_commandsc C sb |d d ur$|d dd |dd|ƒ n:| |||¡}|d urP|d |||d|d | |||¡ d S ©Nr® FrW rÔ ©r£ rÀ )r rF r¸ rj rÕ Ú old_valuer r r ræ l s z Plugin._cleanup_device_commandc C sZ |d d ur"|d dd dd|ƒ n4| ||¡}|d urJ|d ||ddd | ||¡ d S rç rè )r rF r¸ ré r r r rå u s z"Plugin._cleanup_non_device_command)NNN)N)N)N)NF)NN)N)N)F)F)Fr r& Ú __qualname__Ú__doc__r r r! Úpropertyr( Ú classmethodr) r+ r r1 r9 rG rJ rM r rH rL rR r r[ r_ rg rQ rk rm rn rv rs 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 r sŒ
' ÿ
! ÿ
r )rØ Z tuned.constsrs Ztuned.profiles.variablesZtunedZ
tuned.logsr
Ztuned.utils.commandsr rp Ú
subprocessr r ZlogsrŽ r- Úobjectr r r r r Ú s