micropython

TO_DO.txt

499:aecd140f6642
2012-05-10 Paul Boddie Changed the builtins module loading to use the module search path. This makes it easier to run the test program from another location. Added a note about relative imports.
     1 Name usage types: as parameters, as base classes, as callables. This potentially restricts
     2 attribute usage effects because names mentioned as base classes are not propagated and
     3 made freely available for use in attribute accesses.
     4 
     5 Low-Level Instructions and Macro Instructions
     6 =============================================
     7 
     8 Have contexts and values stored separately in memory. This involves eliminating DataValue
     9 and storing attributes using two words.
    10 
    11 Migrate macro instructions such as the *Index instructions to library code implemented
    12 using low-level instructions.
    13 
    14 Consider introducing classic machine level instructions (word addition, subtraction, and
    15 so on) in order to implement all current RSVP instructions.
    16 
    17 Move common code sequences to a library routine, such as the context checking that occurs
    18 in functions and methods.
    19 
    20 Dataflow Optimisations
    21 ======================
    22 
    23 Assignments, particularly now that no result register exists, may cause StoreTemp/LoadTemp
    24 instruction pairs to be produced and these could be eliminated.
    25 
    26 Class and Module Attribute Assignment
    27 =====================================
    28 
    29 Verify that the context information is correctly set, particularly for the unoptimised
    30 cases.
    31 
    32   Update docs/assignment.txt.
    33 
    34 Prevent assignments within classes, such as method aliasing, from causing the source of an
    35 assignment from being automatically generated. Instead, only external references should be
    36 registered.
    37 
    38 Prevent "from <module> import ..." statements from registering references to such local
    39 aliases such that they cause the source of each alias to be automatically generated.
    40 
    41 Consider attribute assignment observations, along with the possibility of class and module
    42 attribute assignment.
    43 
    44   (Note direct assignments as usual, indirect assignments via the attribute usage
    45   mechanism. During attribute collection and inference, add assigned values to all
    46   inferred targets.)
    47 
    48   (Since class attributes can be assigned, StoreAttrIndex would no longer need to reject
    49   static attributes, although this might still be necessary where attribute usage analysis
    50   has not been performed.)
    51 
    52   Potentially consider changing static attribute details to use object-relative offsets in
    53   order to simplify the instruction implementations. This might allow us to eliminate the
    54   static attribute flag for attributes in the object table, at least at run-time.
    55 
    56 Dynamic Attribute Access
    57 ========================
    58 
    59 Consider explicit accessor initialisation:
    60 
    61   attr = accessor("attr")
    62   getattr(C, attr)
    63 
    64 Attribute Usage
    65 ===============
    66 
    67 To consider: is it useful to distinguish between attribute name sets when the same names
    68 are mentioned, but where one path through the code sets different values on attributes
    69 than another? The _attrtypes collapses observations in order to make a list of object
    70 types for a name, and the final set of names leading to such type deductions might be a
    71 useful annotation to be added alongside _attrcombined.
    72 
    73 Interface/Type Generalisation
    74 -----------------------------
    75 
    76 Consolidate interface observations by taking all cached table accesses and determining
    77 which usage patterns lead to the same types. For example, if full usage of {a, b} and
    78 {a, b, c} leads to A and B in both cases, either {a, b} can be considered as partial usage
    79 of the complete interface {a, b, c}, or the latter can be considered as an
    80 overspecification of the former.
    81 
    82 Consider type deduction and its consequences where types belong to the same hierarchy
    83 and where a guard could be generated for the most general type.
    84 
    85 Consider permitting multiple class alternatives where the attributes are all identical.
    86 
    87 Support class attribute positioning similar to instance attribute positioning, potentially
    88 (for both) based on usage observations. For example, if __iter__ is used on two classes,
    89 the class attribute could be exposed at a similar relative position to the class (and
    90 potentially accessible using a LoadAttr-style instruction).
    91 
    92 **** Constant attribute users need not maintain usage since they are already resolved. ****
    93 
    94 Self-related Usage
    95 ------------------
    96 
    97 Usage of self to restrict attribute usage observations and coverage.
    98 
    99 Perform attribute usage on attributes of self as names, potentially combining observations
   100 across methods.
   101 
   102 Additional Guards
   103 -----------------
   104 
   105 Consider handling branches of values within namespaces in order to support more precise value usage.
   106 
   107 Loop entry points and other places where usage becomes more specific might be used as
   108 places to impose guards. See tests/attribute_access_type_restriction_loop_list.py for an
   109 example. (Such information is already shown in the reports.)
   110 
   111 Strict Interfaces/Types
   112 -----------------------
   113 
   114 Make the gathering of usage parameterisable according to the optimisation level so that a
   115 choice can be made between control-flow-dependent observations and the simple collection
   116 of all attributes used with a name (producing a more static interface observation).
   117 
   118 AttributeError
   119 --------------
   120 
   121 Consider attribute usage observations being suspended inside blocks where AttributeError
   122 may be caught (although this doesn't anticipate such exceptions being caught outside a
   123 function altogether).
   124 
   125 Instantiation Deduction
   126 -----------------------
   127 
   128 Consider handling CallFunc in micropython.inspect in order to produce instances of specific classes.
   129 Then, consider adding support for guard removal/verification where known instances are involved.
   130 
   131 Frame Optimisations
   132 ===================
   133 
   134 Stack frame replacement where a local frame is unused after a call, such as in a tail call
   135 situation.
   136 
   137 Local assignment detection plus frame re-use. Example: slice.__init__ calls
   138 xrange.__init__ with the same arguments which are unchanged in xrange.__init__. There is
   139 therefore no need to build a new frame for this call, although in some cases the locals
   140 frame might need expanding.
   141 
   142 Reference tracking where objects associated with names are assigned to attributes of other
   143 objects may assist in allocation optimisations. Recording whether an object referenced by
   144 a name is assigned to an attribute, propagated to another name and assigned to an
   145 attribute, or passed to another function or method might, if such observations were
   146 combined, allow frame-based or temporary allocation to occur.
   147 
   148 Instantiation
   149 =============
   150 
   151 Specific instances could be produced, providing type information and acting somewhat like
   152 classes during inspection.
   153 
   154 Inlining
   155 ========
   156 
   157 Where a function or method call can always be determined, the body of the target could be
   158 inlined - copied into place - within the caller. If the target is only ever called by a
   159 single caller it could be moved into place. This could enhance deductions based on
   160 attribute usage since observations from the inlined function would be merged into the
   161 caller.
   162 
   163 Function Specialisation
   164 =======================
   165 
   166 Specialisation of certain functions, such as isinstance(x, cls) where cls is a known
   167 constant.
   168 
   169 Structure and Object Table Optimisations
   170 ========================================
   171 
   172 Fix object table entries for attributes not provided by any known object, or provide an
   173 error, potentially overridden by options. For example, the augmented assignment methods
   174 are not supported by the built-in objects and thus the operator module functions cause
   175 the compilation to fail. Alternatively, just supply the methods since something has to do
   176 so in the builtins.
   177 
   178 Consider attribute merging where many attributes are just aliases for the same underlying
   179 definition.
   180 
   181 Consider references to defaults as occurring only within the context of a particular
   182 function, thus eliminating default value classes if such functions are not themselves
   183 invoked.
   184 
   185 Scope Handling
   186 ==============
   187 
   188 Consider merging the InspectedModule.store tests with the scope conflict handling.
   189 
   190 Consider labelling _scope on assignments and dealing with the assignment of removed
   191 attributes, possibly removing the entire assignment, and distinguishing between such cases
   192 and unknown names.
   193 
   194 Check name origin where multiple branches could yield multiple scope interpretations:
   195 
   196 ----
   197 try:
   198     set # built-in name
   199 except NameError:
   200     from sets import Set as set # local definition of name
   201 
   202 set # could be confused by the local definition at run-time
   203 ----
   204 
   205 Object Coverage
   206 ===============
   207 
   208 Support __init__ traversal (and other implicit names) more effectively.
   209 
   210 Importing Modules
   211 =================
   212 
   213 Consider supporting relative imports, even though this is arguably a misfeature.
   214 
   215 Other
   216 =====
   217 
   218 Consider a separate annotation phase where deductions are added to the AST for the
   219 benefit of both the reporting and code generation phases.
   220 
   221 Support self attribute visualisation in the reports and/or provide a function or
   222 annotations which can provide the eventual optimisation directly to such components.
   223 
   224 Check context_value initialisation (avoiding or handling None effectively).
   225 
   226 Consider better "macro" support where new expressions need to be generated and processed.
   227 
   228 Detect TestIdentity results involving constants, potentially optimising status-affected
   229 instructions:
   230 
   231   TestIdentity(x, y) # where x is always y
   232   JumpIfFalse(...)   # would be removed (never false)
   233   JumpIfTrue(...)    # changed to Jump(...)
   234 
   235 Status-affected blocks could be optimised away for such constant-related results.