o
    Zh                     @   sR  d dl Z d dlZd dlZd dlZd dlZd dlmZ d dlmZ d dl	m
Z
mZmZ d dlZddlmZmZmZ ddlmZmZmZmZ ddlmZ dd	lmZmZ dd
lmZmZm Z m!Z! ddlm"Z"m#Z#m$Z$ ddl%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z, ddl-m.Z. erd dl/m0Z0 dd Z1dd Z2G dd dZ3ej4dddZ5ej4dddZ6dS )    N)MutableMapping)CellType)AnyOptionalTYPE_CHECKING   )graph_break_hintsutils	variables)bytecode_from_templatecreate_call_functioncreate_call_methodcreate_instruction)	PyCodegen)SideEffectsErrorunimplemented_v2)GlobalSourceLocalCellSourceLocalSourceSource)is_frozen_dataclassnn_module_new
object_new)AttributeMutationAttributeMutationExistingAttributeMutationNewis_side_effect_safeValueMutationExistingValueMutationNewVariableTracker)FrozenDataClassVariable)InstructionTranslatorc                 C   s<   t |j| }|| |  D ]\}}|||| qd S N)type__mro__clearitems__setitem__)	dict_fromdict_to	mro_index
dict_classkv r.   I/var/www/auris/lib/python3.10/site-packages/torch/_dynamo/side_effects.py_manual_dict_setitem)   s
   
r0   c                 C   s   t | t ||  d S r"   )listr%   extend)	list_fromlist_tor.   r.   r/   _manual_list_update4   s   
r5   c                       sH  e Zd ZU dZeeef ed< eeeeef f ed< e	e
 ed< 					dk fdd	Zded	efd
dZdd d	ee fddZdd Zdd Zdd Zdd Zdd Zdd ZdededefddZdld d!Zd"d# Zd$d% Zd&edefd'd(Zd&ededefd)d*Zed+d, Zd-d. Zd/d0 Z d1d2 Z!d3d4 Z"e#fde
d5efd6d7Z$e$Z%de
d5efd8d9Z&d:e'd;e
d<e
fd=d>Z(d?d@ Z)dAdB Z*dCdD Z+dEdF Z,dGee' dHe-dIefdJdKZ.dGe'de
fdLdMZ/dNdO Z0dPdQ Z1dRdS Z2dTdU Z3dVdW Z4dXdY Z5dZe6fd[d\Z7d]d^ Z8d_d` Z9dadb Z:dcdd Z;dZe6fdedfZ<dgdh Z=didj Z>  Z?S )mSideEffectsah  
    Maintain records of mutations and provide methods to apply them during code generation.

    Handles tracking and applying side effects during PyTorch Dynamo compilation,
    maintaining Python semantics by managing mutations, attribute modifications,
    and other side effects that occur during program execution.

    Key responsibilities:
    - Tracks mutations to Python objects, lists, and dictionaries that need to be
    applied after an FX graph is run.
    - Manages attribute modifications and deletions
    - Handles tensor hooks and backward pass state
    - Tracks cell variable mutations and global variable changes
    - Ensures correct ordering and application of side effects after graph execution

    This ensures that optimized code behaves identically to the original Python code with
    respect to object mutations and other side effects.
    id_to_variablestore_attr_mutations	keepaliveNc                    sX   t    t|| _|pi | _|pi | _|pg | _|pg | _|p"i | _	d| _
d | _d S )NF)super__init__weakrefrefoutput_graph_weakrefr7   r8   r9   save_for_backwardtensor_hooks_has_existing_dict_mutationca_final_callbacks_var)selfoutput_graphr7   r8   r9   r?   r@   	__class__r.   r/   r;   Q   s   
	





zSideEffects.__init__otherreturnc                 C   s>   t |tsJ | j|jko| j|jko| j|jko| j|jkS r"   )
isinstancer6   r7   r8   r?   r@   )rC   rG   r.   r.   r/   __eq__h   s   


zSideEffects.__eq__c                 C   s   | j |j kr| j  }|j  }||krd| d| S dS | j|jkr<| j }|j }||kr:d| d| S dS | j|jkrDdS | j|jkrLdS d S )Nzid_to_variable keys: z != zid_to_variable: unknown diffzstore_attr_mutations keys: z"store_attr_mutations: unknown diffr?   r@   )r7   keysr8   r?   r@   )rC   rG   Zsk_itvZok_itvZsk_samZok_samr.   r.   r/   diffr   s"   



zSideEffects.diffc                 C   s:   | j |  t| jdd | j D t| j| j| j	dS )zCreate a shallow copyc                 S   s   i | ]	\}}|t |qS r.   )dict.0r,   r-   r.   r.   r/   
<dictcomp>   s    z%SideEffects.clone.<locals>.<dictcomp>)rD   r7   r8   r9   r?   r@   )
rF   r>   rM   r7   r8   r&   r1   r9   r?   r@   rC   r.   r.   r/   clone   s   zSideEffects.clonec                 C   s   t || jv S r"   )idr7   rC   itemr.   r.   r/   __contains__      zSideEffects.__contains__c                 C   s   | j t| S r"   )r7   rS   rT   r.   r.   r/   __getitem__   rW   zSideEffects.__getitem__c                 C   s$   |   }|o|jjjjo|jjjjS r"   )r>   
current_txoutputcurrent_tracerunder_activation_checkpoint#allow_side_effects_under_checkpointrC   rD   r.   r.   r/   *should_allow_side_effects_under_checkpoint   s   

z6SideEffects.should_allow_side_effects_under_checkpointc                 C   s   |   }|o|jjjjS r"   )r>   rY   rZ   r[   is_reconstructing_generatorr^   r.   r.   r/   r`      s   
z'SideEffects.is_reconstructing_generatorc                 C   sX   ddl m} t||rdS |  rdS |  rtdt|js*tdddg d d S d S )	Nr   )AutogradFunctionContextVariableTzCannot reconstruct a generator with variable mutations. Dynamo needs to fully exhaust the generator, which may cause unintended variable modifications.zOHigherOrderOperator: Mutating a variable not in the current scope (SideEffects) This is not supported.Zgb_typecontextZexplanationhints)	Ztorch._dynamo.variables.miscra   rI   r_   r`   r   r   mutation_typer   )rC   rU   ra   r.   r.   r/   check_allowed_side_effect   s"   


z%SideEffects.check_allowed_side_effectrU   namevaluec                 C   s>   |  |sJ | | || jvri | j|< || j| |< d S r"   )is_attribute_mutationrh   r8   )rC   rU   ri   rj   r.   r.   r/   
store_attr   s
   


zSideEffects.store_attrFc                 C   sV   |r	|  |s	J | j| | }|s)t|tjr)tdd| d| dg tjd |S )Nz$Attempted to read a deleted variablezitem: z, name: rb   rd   )rk   r8   rI   r
   DeletedVariabler   r   
USER_ERROR)rC   rU   ri   Z
deleted_okcheckresultr.   r.   r/   	load_attr   s   zSideEffects.load_attrc                 C   s\   |  rtdd| d| dg tjd t|tjsJ t|tjs%J | |d| d S )NzWrite to immutable cellz	cellvar: z	, value: zFDynamo doesn't support writing to immutable/sourceless cell variables.rd   cell_contents)	is_immutabler   r   Z	DIFFICULTrI   r
   CellVariabler   rl   )rC   cellvarrj   r.   r.   r/   
store_cell   s   zSideEffects.store_cellc                 C   sV   t |tjsJ | |dr| j|dddS |jr|jS tdt|dg tj	d d S )Nrr   F)ro   zRead uninitialized cellzBAttempted to read a cell variable that has not been populated yet.rd   )
rI   r
   rt   has_pending_mutation_of_attrrq   pre_existing_contentsr   strr   rn   )rC   ru   r.   r.   r/   	load_cell   s   
zSideEffects.load_cellgvarc                 C   s   t |tjsJ | ||S r"   )rI   r
   r   rq   )rC   r{   ri   r.   r.   r/   load_global   s   zSideEffects.load_globalc                 C   s2   t |tjsJ t |tjsJ | ||| d S r"   )rI   r
   r   rl   )rC   r{   ri   rj   r.   r.   r/   store_global   s   zSideEffects.store_globalc                 C   s*   t | dd tjtjtjtjtjtjfv S )N__getattribute__)	inspectgetattr_staticobjectr~   rM   intry   r1   BaseException)clsr.   r.   r/   "cls_supports_mutation_side_effects   s   z.SideEffects.cls_supports_mutation_side_effectsc                 C   s   t |jtS r"   )rI   rg   r   rT   r.   r.   r/   rk        z!SideEffects.is_attribute_mutationc                 C   s   |  |ot| j|S r"   )rk   boolr8   getrT   r.   r.   r/   has_pending_mutation	  s   
z SideEffects.has_pending_mutationc                 C   s   |  |o|| j|dv S )Nr.   )rk   r8   r   )rC   rU   ri   r.   r.   r/   rw     s
   z(SideEffects.has_pending_mutation_of_attrc                 C   s\   |  rdS t|jttfrdS t|tjr || jv p|| S | 	|r*|| jv S |jj
S )NFT)rs   rI   rg   r   r   r
   UserDefinedObjectVariabler8   Zis_underlying_vt_modifiedrk   is_modifiedrT   r.   r.   r/   r     s   

zSideEffects.is_modifiedvariablec                 C   sj   |j dusJ t|| jv r"t| d|j  d| jt| j  d| |_|| jt|< | j| |S )z*Start tracking a new variable for mutationNz is already tracked for mutation. This could be because you are not using VariableBuilder to construct the variable tracker. Source of new object: z'. Source of previously tracked object: .)sourcerS   r7   AssertionErrorrg   r9   append)rC   rU   r   mutation_type_clsr.   r.   r/   
_track_obj$  s   zSideEffects._track_objc                 C   s   | j ||tdS )N)r   )r   r   )rC   rU   r   r.   r.   r/   track_object_existing=  s
   z!SideEffects.track_object_existing
cls_sourceuser_clsvariable_clsc                 C   s   |t jjju r#tjdd t j }W d    n1 sw   Y  nt|}||fdt|i|}|| j	t
|< | j| |S )NT)recordrg   )torchZautogradfunctionZFunctionCtxwarningscatch_warningsFunctionr   r   r7   rS   r9   r   )rC   r   r   r   optionsobjr   r.   r.   r/   track_object_newH  s    zSideEffects.track_object_newc                 C   s  ddl m} ddlm} ddlm} ddlm} tj	}t
||r(||r(|}nRt|dr9t|dr9||s9|}nAt
|tjjrDtj}n6t
|ttjfrPtj}n*t
|trYtj}n!t
|trbtj}nt
|trktj}nt|rrt}nt
|trztj}t
|tj	sJ |S )	Nr   )TorchFunctionModer   )GenericContextWrappingVariable)TorchFunctionModeVariable)is_forbidden_context_manager	__enter____exit__)Ztorch.overridesr   Zvariables.ctx_managerr   Zvariables.torch_functionr   variables.user_definedr   r
   r   
issubclassZ is_supported_torch_function_modehasattrr   nnModuleZUnspecializedNNModuleVariablerM   collectionsOrderedDictUserDefinedDictVariabletupleZUserDefinedTupleVariabler1   UserDefinedListVariabler   ZMutableMappingVariabler   r    r   Z"UserDefinedExceptionObjectVariable)rC   r   r   r   r   r   r   r.   r.   r/   get_variable_cls]  sF   



zSideEffects.get_variable_clsc                 C   sv   |j }t|tjjrt|}|S t|tjr|j	}nt|tj
r$|j }ntd| tj
|js4J ||}|S )NzUnexpected base_cls_vt )rj   r   r   r   r   r   rI   r
   ZBuiltinVariablefnZUserDefinedClassVariableRuntimeErrorZis_supported_new_method__new__)rC   base_cls_vtcls_vt	init_argsr   r   Zbase_clsr.   r.   r/   get_example_value  s   

zSideEffects.get_example_valuec           	      C   sZ   |j }|j}| |}| |||}|||j ||t|d}|| jt|< | j| |S )aM  
        Creates a UserDefinedObjectVariable (or its subclass) variable tracker
        and mark it for attribute mutation tracking.

        Also records the variable trackers to call __new__ method on
        reconstruction. Roughly, the reconstruction looks like this
            base_cls_vt.__new__(user_cls, *init_args)
        )r   r   r   rg   )	r   rj   r   r   r   r7   rS   r9   r   )	rC   r   r   r   r   r   r   r   r   r.   r.   r/   track_new_user_defined_object  s   
z)SideEffects.track_new_user_defined_objectc                 C   s2   t  }tjt d}|| jt|< | j| |S )Nrg   )r   r
   rt   r   r7   rS   r9   r   )rC   r   r   r.   r.   r/   track_cell_new  s   zSideEffects.track_cell_newr   cellcontentsc                 C   s<   t j|d u rd nt ||d}|| jt|< | j| |S )N)rg   rx   r   )r
   rt   r   r7   rS   r9   r   )rC   r   r   r   r   r.   r.   r/   track_cell_existing  s   zSideEffects.track_cell_existingc                 C   s.   t jt |d}|| jt|< | j| |S )N)rg   r   )r
   NewGlobalVariabler   r7   rS   r9   r   )rC   r   rU   r   r.   r.   r/   track_global_existing  s   z!SideEffects.track_global_existingc                 C   s$   t |tjsJ | j||f d S r"   )rI   r
   ra   r?   r   )rC   ctxargsr.   r.   r/   track_save_for_backward  s   z#SideEffects.track_save_for_backwardc                 C   sD   |j D ]}t|}|j| }|| jvrt|tjr| || qd S r"   )r9   rS   r7   rI   r
   TensorVariabler   )rC   rG   Z
other_itemZother_idZother_variabler.   r.   r/   1track_tensor_variables_from_runahead_side_effects  s   

z=SideEffects.track_tensor_variables_from_runahead_side_effectsc                    s   t  t  dtffdddtffdd dd j D }t|j|j||jjj	f  fdd	j
 D _ fd
d	j
 D _d S )Nvarc                    sP   | v rd S  |  t| jtr  |  | jv r&tj|   d S d S r"   )addrI   rg   r   r8   r   visitr   )live_new_objectsrC   r   visitedr.   r/   r     s   


z0SideEffects.prune_dead_object_new.<locals>.visitc                    s   t | jtr
|  v S dS NTrI   rg   r   r   )r   r.   r/   is_live  s   z2SideEffects.prune_dead_object_new.<locals>.is_livec                 S   s   g | ]
}t |jts|qS r.   r   rO   r   r.   r.   r/   
<listcomp>  s    
z5SideEffects.prune_dead_object_new.<locals>.<listcomp>c                    s   i | ]\}} |r||qS r.   r.   rN   r   r.   r/   rP   *  
    z5SideEffects.prune_dead_object_new.<locals>.<dictcomp>c                    s   i | ]\}} |r||qS r.   r.   rN   r   r.   r/   rP   -  r   )setr   r7   valuesr   stackZsymbolic_localsrZ   Zbackward_stater@   r&   r8   )rC   txZpre_existing_varsr.   )r   r   rC   r   r   r/   prune_dead_object_new  s.   	

z!SideEffects.prune_dead_object_newc                 C   sR   |  | t|jtrd|j_|jr#t|tjr%t|tjs'd| _	d S d S d S d S r   )
rh   rI   rg   r   r   r   r
   ConstDictVariableZSetVariablerA   )rC   r   r.   r.   r/   mutation1  s   



zSideEffects.mutationc                 C   s   | j S r"   )rA   rQ   r.   r.   r/   has_existing_dict_mutation<  s   z&SideEffects.has_existing_dict_mutationc                    s    fdd j  D S )Nc                    s   g | ]	}  |r|qS r.   )r   r   rQ   r.   r/   r   @  s    z2SideEffects._get_modified_vars.<locals>.<listcomp>)r7   r   rQ   r.   rQ   r/   _get_modified_vars?  s   zSideEffects._get_modified_varscgc                    s  |   D ]tjtrBttjrBjd u r6  fdd  t	dd  
 t j _qjd u rAtj_qtjtrttjrVtdddg d ttjri fd	d
} | n	  fdd  jj jD ]} | q{ t	dtj d  
 t j _qjd usJ q| jD ]&\}} |j  d |D ]} | q g tt|td qd S )Nc                           tjdS )NZ	make_cellload_import_fromr	   __name__r.   r   r.   r/   <lambda>O      z3SideEffects.codegen_save_tempvars.<locals>.<lambda>r   Fz<AutogradFunctionContextVariable escaped Dynamo-traced regionrb   zAWe cannot reconstruct a torch.autograd.Function's context object.rd   c                      s.   j d usJ  j    dg d S )Nr   )r   extend_outputcreate_load_attrr.   r   r   r.   r/   load_new_methodd  s   
z:SideEffects.codegen_save_tempvars.<locals>.load_new_methodc                      r   )Nr   r   r.   r   r.   r/   r   l  r   r   r?   POP_TOP)r   rI   rg   r   r
   rt   
local_nameadd_push_nullr   r   	add_cacher   Ztempvarsr   r   ra   r   r   r   r   lenr?   load_methodr   r   )rC   r   r   argr   r   r.   r   r/   codegen_save_tempvarsB  s`   












z!SideEffects.codegen_save_tempvarsc                 C   s   t |tjsJ t |tjsJ t |tjr| sJ ttj|s$J t	| j
 }|| j
v r9|d7 }|| j
v s0||||f| j
|< |jrGJ ||_d S )Nr   )rI   r
   r   r   ZRemovableHandleVariableZ
is_mutabler   r   ZTensorr   r@   rK   idx)rC   tensorhookhandleri   r   r.   r.   r/   register_hook  s   




zSideEffects.register_hookc                 C   s   | j |= d S r"   )r@   )rC   r   r.   r.   r/   remove_hook  r   zSideEffects.remove_hookc                    sf   | j  D ]+\}}jsJ d fdd} |  |  tdd  | qd S )Nz4Hooks on non input tensors NYI - should not get herec                      s        g d S r"   )r   r   r.   r   ri   r   r.   r/   gen_fn  s   z)SideEffects.codegen_hooks.<locals>.gen_fnr   F)r@   r   r   r   r   r   r   )rC   r   r   r   r   r.   r   r/   codegen_hooks  s   #
zSideEffects.codegen_hooksc                 C   s.   ddl m} | jd u rtjg | d| _| jS )Nr   )r   r   )variables.baser   rB   r
   ListVariable)rC   r   r.   r.   r/   get_ca_final_callbacks_var  s   
z&SideEffects.get_ca_final_callbacks_varc              	      s  g }|   D ]9ttjr5 dd  j   d  d tdddg |tdg qttj	j
rtjtjrIjjd u sRtddd	d
gd  j  d  dd |g tdtd  j  d |g tdtd qttjr̈ rˈ j  d  dd jr j  d |g tdtd jr|g tdtd qttjjr$  fdd  dd tj } jd  |f7  <  td|d   fdd  j  tdtjd  dd  td qttjrKjd urK| j v rJ| !} | | "jg q| #rttj$r| %j&ri }t'j(j)D ]} j*j+, ||< qezt-jj./t0j1}W n t2y   t-jj./t3}Y nw  td|dtd|d dg  j  td|d dg  j&dd  td|d dg t4t'|d}|g |td nUttj5r-| %j6r-i }t7j(j)D ]} j*j+, ||< q j  td|d dg  j6dd  td|d dg t4t7|d}|g |td t8| j 9i : D ]\}}	ttj;rc j*j+<|  |	 tjt=sWJ |td |dg q8t|	tj>rtj?t@rtAtBd!d |r j*j+<|  j |td"|dg q8ttjCrɈD rɈ Ed#d$  d%  j  t|  |	 |g td&td q8 j*j+<|  |	  j |td'|dg q8qttjFrtGj/D ]}
  fd(d  j  dd  H  qqttjIr; fd)d*} |  JjKL  |g tMddtd qtNt-t8|D ]} | qEd S )+NF)Zallow_cacheBUILD_SLICE   )r   STORE_SUBSCRz1Side effect on existing deque with limited maxlenrb   rc   z*Don't use a deque with `maxlen` specified.rd   r2   r   r   r%   r   updatec                      r   )NZget_torch_function_mode_stackr   r.   r   r.   r/   r   8      z4SideEffects.codegen_update_mutated.<locals>.<lambda>co_varnames
STORE_FAST)argvalc                      r   )NZset_torch_function_mode_stackr   r.   r   r.   r/   r   A  r   
BUILD_LIST
LOAD_CONSTr*   r)   r(   )varname_mapr4   r3   STORE_GLOBALrj   DELETE_ATTRbuiltinsr   __setattr__   
STORE_ATTRc                      r   )NZ	iter_nextr   r.   r   r.   r/   r     r   c                      s    j   d d S )Nsetstate)r   rq   r.   r   r.   r/   r        
z2SideEffects.codegen_update_mutated.<locals>.gen_fn)Or   rI   r
   r   r   r   Zcreate_load_constr   r   listsZDequeVariablemaxlenZConstantVariablerj   r   r   r   r   Zhas_new_itemsZshould_reconstruct_allZtorch_functionZTorchFunctionModeStackVariabler   Zcall_functionZget_prev_stack_var_nameZcode_optionsZappend_outputZforeachZsymbolic_stackr   rt   r   r8   rz   Zcreate_store_derefrk   r   r   Z_dict_vtr0   __code__r   r   rZ   Znew_varr#   r$   indexr   r   
ValueErrorrM   r   r   Z_list_vtr5   reversedr   r&   r   Zupdate_co_namesr   rm   rg   r   r   getattrr   Zneeds_slow_setattrr   ZListIteratorVariablerangeZpop_topZRandomVariableZ
wrap_staterandomgetstater   r   )rC   r   suffixesri   Zcontents_varr  r*   Zdict_update_instsZlist_update_instsrj   _r   suffixr.   r   r/   codegen_update_mutated  s  






	










	






%


z"SideEffects.codegen_update_mutatedc                 C   s*   t t| j| j p| jp| jp| j S r"   )anymapr   r7   r   r@   r?   rQ   r.   r.   r/   is_empty  s   zSideEffects.is_emptyc                 C   s   | j   | j  d S r"   )r9   r%   r7   rQ   r.   r.   r/   r%     r  zSideEffects.clear)NNNNN)FF)@r   
__module____qualname____doc__rM   r   r   __annotations__ry   r1   r   r;   r   r   rJ   r   rL   rR   rV   rX   r_   r`   rh   rl   rq   rv   rz   r|   r}   staticmethodr   rk   r   rw   r   r   r   Ztrack_mutabler   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r  r  r%   __classcell__r.   r.   rE   r/   r6   9   s   
 






%
	@H6	  *r6   r   r!   c                 c   sH    | j jjsJ | j jj}zd| j j_d V  W || j j_d S || j j_w r   )rZ   r[   r\   r]   r   Zorig_valr.   r.   r/   r]     s   

r]   c                 c   s:    | j jj}zd| j j_d V  W || j j_d S || j j_w r   )rZ   r[   r`   r%  r.   r.   r/   "disallow_side_effects_in_generator  s   

r&  )r   r!   )7r   
contextlibr   r   r<   collections.abcr   typesr   typingr   r   r   Ztorch.nnr   rb   r   r	   r
   Zbytecode_transformationr   r   r   r   Zcodegenr   excr   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r    Ztorch._dynamo.symbolic_convertr!   r0   r5   r6   contextmanagerr]   r&  r.   r.   r.   r/   <module>   sB   $	       _
