comments added
[libfirm] / Changes
1   19.10.2001 Boris
2   renamed get_type_nameid to get_type_ident
3
4   10.9.2001 Goetz
5   Bugfix: dead node elimination did not replace the hash table
6   for cse.
7
8   29.8.2001 Goetz
9   Added routine remove_irp_irg.
10   Changed comment to free_ir_graph.
11
12   29.8.2001 Goetz
13   Added routine to free irgraphs.
14
15   17.7.2001 Goetz
16   Improved add routines to sub, supertype in type.c
17
18   12.7.2001 Goetz
19   Added implementation of overwrites stuff.
20
21   11.7.2001 Goetz
22   Implemented stuff to change the type graph.  See
23   typegmod.h and tpop.h for basic documentation of the change.
24   There now exists a type of kind type_id.  If this appears
25   externally this is a bug.
26
27   9.7.2001 Goetz
28   Added some new access routines to types.
29   List of overwritten fields for entities.
30   Removed a bug in irnode.
31
32   4.7.2001 Goetz
33   Added a routine to set the mangled entity name.
34   Added two routines to copy entites.
35
36   3.7.2001 Goetz
37   Entities now have two more flags, for visibility and allocation mode.
38   Types that have a layout have a flag indicating whether the layout is
39   fixed.
40
41   25.6.2001 Goetz
42   We distinguish three kinds of Cond nodes.  These can be distinguished
43   by the mode of the selector operand and an internal flag of type cond_kind.
44   First we distinguish binary Conds and switch Conds.
45   A binary Cond has as selector a boolean value.  Proj(0) projects the control
46   flow for case "False", Proj(1) the control flow for "True".  A binary Cond
47   is recognized by the boolean selector.
48   The switch Cond has as selector an unsigned integer.  It produces as result
49   an n+1 Tuple (cf0, ... , cfn) of control flows.
50   We differ two flavours of this Cond.  The first, the dense Cond, passes
51   control along output i if the selector value is i, 0 <= i <= n.  If the
52   selector value is >n it passes control along output n.
53   The second Cond flavor differes in the treatment of cases not specified in
54   the source program.  It magically knows about the existence of Proj nodes.
55   It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
56   exists.  Else it passes control along output n (even if this Proj does not
57   exist.)  This Cond we call "fragmentary".  There is a special constructor
58   new_defaultProj that automatically sets the flavor.
59   The two switch flavors are distinguished by a flag of type cond_kind.
60   Default flavor is "dense"
61
62   20.6.2001 Goetz
63   Extended iropt, tv.
64   tv now implements Minus, Abs.
65   iropt now optimizes these and Div, Mod, Quot, DivMod.
66   Still missing: Shrs, Rot.
67   tarval_shr somtimes performs shrs, depending on the compiler/system!!
68   If the ArmRoq implementation is faulty there might appear errors.
69
70   20.6.2001 Goetz
71   Changed ircons: If undefined values are used the Phi construction
72   inserts a constant with value tarval_bad.
73
74   19.6.2001 Goetz
75   Changed array bounds in type.h to ir_node*.  This allows to
76   construct array bounds that are complex constant expressions
77   simpler.  Further dynamic array bounds can be displayed.
78   Comment in ircons.c extended: undefined values in start_block.
79
80   7.6.2001 Goetz
81   ifdef'ed all uses of gmp in tv.c away.  Optimizations for
82   mode_Z no more supported, as well as constants of that mode.
83
84   7.6.2001 Goetz
85   Dokumentation in ir_dump
86   Habe Routinen fuer einzelne Knoten/Kanten aus header entfernt:
87   Benutzen globale Variable die nicht oeffentlich zugaenglich ist.
88
89   28.5.2001 Goetz
90   We need an entity for the array elements for the Sel nodes.  This
91   entity should be stored in the array type.  Changed constructor
92   parameters: include array element type.  Entity for elements is built
93   automatically now.
94
95   28.5.2001 Goetz
96   Removed bug in tv.c.
97   Faulty use of va_arg, became visible with new, stricter gcc 2.96.
98
99   23.5.2001 Goetz
100   Added list of member entites to union.  unioned_types and delimiters
101   are superfluous now -- removed.
102   Rationale: we want to express selection of a union member as a Sel
103   node. for this we need to have entities.  The entities contain the
104   unioned type and have as name the delimiters...
105
106   17.4.2001 Boris
107   Changed Makefile/MakeTargets to install headers and libraries
108   seperately.
109
110   28.3.2001 Boris
111   Changed Makefile and Configure scripts to produce a proper tar file
112   for distribution (libfirm-VERSION.tar)
113   Use 'make distrib' instead of 'make dist'
114
115   14.3.2001 Goetz
116   Changed implementation of tr module.  With this I also changed the
117   interface!!  Type casts are unnecessary now, but some access funcions
118   differ.
119
120
121 ======================================================================
122 ==================== New version: 0.3.0 ==============================
123 ======================================================================
124
125   14.3.2001 Boris
126   added file TODO
127
128   14.3.2001 Boris
129   added creation of a tar archive for distribution
130   replaced ir/.dummy.in by ir/Makefile.in
131
132   13.3.2001 Goetz
133   Changed equivalent_node() and copy_preds() so that the end block
134   is not optimized away if it has no real predecessors.  This fixes
135   the problem with the while examples.
136   Added while_example in Makefile
137
138   12.3.2001 Goetz
139   Fooled around with if_while_example: Why does cse make it abort?
140   Cse removes path to End node, Bad remains as pred of Endblock.
141   The block walker can't deal with this.
142   Made new example with only loop:  while_example.
143
144   12.3.2001 Boris
145   added auto documentation in Makefiles, configure, etc
146   example in ir/ir/ircons.c - much must be added
147   creation of documentation by 'make autodoc' in architecture directory
148
149   5.3.2001 Boris
150   added lots of #ifdef HAVE_CONFIG_G #include "config.h" #endif
151   replaced some C++ style comments (//) by standard C comments /**/
152   added autoconf stuff
153   worked this night:
154         - configure (with some features, see --help for more)
155         - make [depend | tags | install]
156         - make [run] in testprograms
157   did not work:
158         - compilation on SunOS
159         - make dist
160         - automatic call of autoconf if required
161
162   5.3.2001 Goetz
163   More colours in vcg output.
164   Fixed bug:  cse found that start block equals it's
165   first successor as both have the Start block as predecessor.
166   This only happens for local_optimize_graph() as during construction
167   the Start block is not entered in the value table.
168   Changed implementation:  irgmod:  local_optimize_graph() did not
169   empty the hash table with the irnodes for cse.  This might cause that
170   cse turns up with a node that seems better but was removed from the
171   graph in an earlier optimization phase.
172   Removed old #if 1 from ircons.c
173   Commented in call of optimization for Block nodes in irgopt.c, copy_preds():
174   Optimizes blocks that had bad predecessors.
175   Same for Phi nodes.
176
177
178   27.2.2001 Goetz
179   Moved struct from irprog.h to irprog_t.h, same for irmode.h.
180   Added a module deb_info in debug.h.  Adapted makefile.  Added example
181   use in iropt.h.
182   Removed use of debug.h in ident.c. Now debug.c|h can be moved to
183   /adt/.
184   Removed inabled code for dead node elimination in irgopt.h.
185   Renamed some missnamed access routines (_of_).  Macros with old names
186   are in old_fctnames.h.
187   Edited makefiles to remove #* and *.flc.
188
189   ??.2.2001 Goetz
190   Some minor bugfixes...
191
192   25.1.2001 Goetz
193   After compacting of in arrays in dead_node_elimination
194   merge blocks and remove Phis with one pred.
195
196   24.1.2001 Goetz
197   Freeing of obstack in dead_node_elimination commented in.
198   Compacting in arrays of Block and Phi nodes in dead_node_
199   elimination.
200   Some more changes...
201
202   15.01.2001 Goetz
203   added set/get_SymConst_type_or_id in irnode.h
204   added field offset to entity in entity.h
205   added field size to type_class in type.h
206   include "gmp.h" in tv.h with "" instead <>
207
208   12.01.2001 Goetz
209   Some changes to make the lib better portable
210
211   29.12.2000 Goetz
212   Initialize max_node_nr in irprog.
213
214   27.12.2000 Goetz
215   Now outputs warning if faulty type in irdump, dump_type_info.
216   Explicit string termination in irdump, vcg_open.
217
218   20.12.2000 Goetz
219   Added external to declaration of irp.
220   Added typedef before pns and pnc_number.
221   irmode.c, init_mode(): We need to memset all new modes as
222   tarval_vrfy reads fields before they are initialized: It
223   compares to min/max when tarvals for min/max are allocated!
224
225   18.12.2000 Goetz
226   Changed parameter of Methods in type.h and type.c from
227   class to clss.  Class is a C++ keyword.
228
229   10.12.2000 Goetz
230   Changed some testprograms to accomodate Uebprakt.
231
232   7.9.2000 Goetz
233   Finished implementation of dump_all_types.
234   Added new testprogram inheritance_example.
235
236   6.9.2000 Chris
237   Added seven access routines in type.[hc]:
238   get_class_n_member, get_class_n_subtype, get_class_n_supertype,
239   get_strct_n_member, add_strct_member, get_strct_member and set_strct_member.
240   Fixed the type_walk_2 for those seven routines.
241
242   6.9.2000 Goetz
243   Added irdump routine dump_all_types.
244   Did changes to irprog, type, typewalk to achieve this.
245   typewalk needs to walk along members, sub and supertypes, this
246   is still missing!  irdump then needs to output these edges.
247
248 ======================================================================
249 ==================== New version: 0.2.5 ==============================
250 ======================================================================
251
252   3.9.2000 Goetz
253   Made new Version: 0.2.5
254
255   15.8.2000 Goetz until 3.9.00
256   Separated irnode.h and many others into two files: one public
257   one private.
258   Added funcionality to extract headers for lib.
259
260   23.8.2000 Goetz
261   type_dump also dumps irg->ent
262   if_example: corrected nr of locals
263
264   16.8.2000 Goetz
265   irgopt: Correct copy of self pointer in start block.
266   irgopt: Correct treatment of loops: pre function in walker
267     breaks all possible loops in Phi and Block nodes.
268   irr_loop_example: wrong Return statement
269   Now I fixed all but one error: in memory_example.
270   This error showed a conceptual problem, so I wrote
271   a slightly different algorithm.  This now runs for
272   all testprograms.
273   dead_node_example: cse is buggy!! merges start and the
274   following block!
275
276   15.8.2000 Goetz
277   looking at bug in dead_node_elimination.
278   Following fixes:
279   irnode:  all get_..._arr functions changed
280   ircons:  new_r_Block: set matured flag.
281   ircons:  new_r_SymConst: needs mode_p for linkage_ptr_info.
282   adapted call_str_example to new concepts.
283
284   2.8.2000 Goetz
285   Implemented simpler Phi construction algorithm that constructs
286   correct code for three_cfpred_example in ircons.  This algorithm
287   generates more Id nodes than the original algorithm and therefore
288   is less effective.
289   Also made some changes to optimizations of Not.
290
291   31.7.2000 Chris
292   Fixed a bug, caused by the recursive use in type.h and entity.h.
293   Deleted the _TYPE_TYPEDEF_ and inserted the _ENTITY_TYPEDEF_ instead.
294   Fixed a problem in if_while testprogram, so it now works.
295
296   20.7.2000 Goetz
297   Fixed bug in optimize(). Returned Null instead n if
298   get_optimize() == false.
299
300   19.7.2000 Christian
301   Added some access routines in type.[hc]. Solved a recursive definition
302   of type_class struct, entity struct and type union.
303
304   18.7.2000 Goetz
305   Separated entity header into pure functional header and header
306   with data types.
307
308   Goetz
309   ... a bunch small changes not documented
310
311   12.7.2000 Goetz
312   Changed output of oo_prog_example: now uses the internal list
313   of all irgs.  Had to implement some of the access routines for
314   that.  Also fixed a bug in irdump.  Main routines did not use
315   current_ir_graph properly.
316
317   12.7.2000 Goetz
318   Implemented some missing parts in irgopt.
319   Added field irg to entity. Only valid if entity is a method.
320   Had to resove a cyclic de[endency between irgraph.h and entity.h
321   for this.
322   Added fields sub and super to type_class for inheritance.
323   Added field main_irg to irprog.
324
325   7.7.2000 Chris
326   Fixed some bugs in irgopt.c
327   Added some missing 'get_new_node' methods, so the new obstack contains
328   the correct nodes.
329
330   6.7.2000 Chris
331   Renamed ir_vrfy to irn_vrfy and vrfy_graphg to irg_vrfy.
332   Solved some copy'n'paste problems. Deleted most debug-code!
333   Added comments to several files.
334
335   6.7.2000 Goetz
336   Fixed bug in _r_ constructors for all four Div operations.
337   Fixed bug in turn_into_tuple: didn't remember the block.
338   Tested transform_node.
339
340   5.7.2000 Goetz
341   Fixed some testprograms to new semantics of firm.
342   Added testprogram global_var_example.
343   Fixed a bug in irop:  Size of Sel node was (entity *) instead of
344   sel_attr.  Therefor array_heap_example aborted.
345   Also found a missing break in typewalk, case iro_Alloc.
346   Added a construct that unifies all things constructed by the lib
347   and needed to represent a program:  irprog.ch
348   This contains a list of all types as well as a list of all ir graphs.
349   I added calls to initialization and constructors so that this is constructed
350   automatically.  I changed firm.c, type.c, irgraph.c and ev. more.
351   Removed strange block struct and constructor from ircons.c.
352   Moved routines for automatic Phi construction from irgmod to ircons.
353   Sorted functions in ircons to reflect the different interfaces.
354   Renamed dataseg to globals to be conformant with documentation.
355   Added conservation of current_ir_graph to irgopt.c.
356   Corrected bug in Makefiles: wrong path to directory ./inlude.
357
358   4.7.2000 Goetz
359   Commented a whole bunch of stuff, e.g. in ircons.h  (Procedure to construct)
360   We should change the naming of the Block constructor.
361   Removed acces routines to attr. "closed" of Block.
362   Removed second implementation of new_ir_node from ircons and some comments
363   concerned with the now resolved cyclic dependency.
364   Fixed some bugs in irgopt so that the compilation goes through.
365
366   29.6.2000 Chris
367   Changed the irnode attribut 'visit' into 'visited'.
368   Added some access functions, like get/set_irn_visit etc.
369
370   28.6.2000 Chris
371   Renamed some access funtion in irgraph.*.
372   Deleted two global flags (ir_visited and block_visited) from irgraph.*.
373   Added two attributes to the irgraph struct. The visited flags belongs
374   to a ir graph, not to a whole program.
375
376   26.6.2000 Chris
377   A new optimization has been finished. The dead-node-elimination copies
378   the existing ir graph from one opstack to another. While walking the
379   graph, only the reachable nodes will be copied, so the "dead-nodes"
380   (unreachable in the controlflow) are removed.
381
382   19.6.2000 Chris
383   Solved some problems in the 'copy_node' function. The in array was not
384   as easy as it seamed.
385
386   16.6.2000 Chris
387   Wrote a new 'post' funtion, for future use in 'dead-node-elimination'
388   optimization, which is needed in the paramter list of 'irg_walk'.
389
390   14.6.2000 Chris
391   Moved 'optimze_in_place_wrapper' from iropt.* tothe new files irgopt.*.
392   New functions 'local_optimze_graph' and 'dead_node_elimination' are added,
393   but not finished.
394
395   31.5.2000 Chris
396   Removed some files from the archive, after dependencies and usage are
397   checked:
398   - 'ir/common/strerror.c'
399   was nowhere used;
400   - 'ir/ident/xx_ident.h'
401   an empty file, only included by 'ident.c', but never used;
402   - 'ir/tv/label.c' and
403   - 'ir/tv/label.h'
404   contained a numeric counter;
405   The files were included in 'tv.h' and implemented in 'tarval.c'. The two
406   functions 'tarval_label' and 'tarval_forall_labeled' were also never used.
407   In the old fiasco compiler, the label thing is used in the backend.
408   Search for 'babil' to see the usage.
409   Also removed the two attributes 'lab' and 'used' in the tarval struct.
410
411   26.5.2000 Chris
412   Moved the 'new_ir_node' constructor from ircons.* to irnode.* and fixed
413   afterwards some recursive includes, so libfirm works again.
414
415   2+3.2000 Goetz
416   Did a lot of changes, which I never commented until now (4.7.00).
417
418   * Added new result to Start node: Pointer to global data segment.
419   * Extended Semantics of SymConst node to represent information for the
420     linker.
421   * Added arithmeitc nodes (Shrs, Minus ...)
422
423   Rearranged the directory structure and adjusted the makefiles.
424   The directories contain:
425   ir:       everything for the intermediate representation (better: src?)
426     /ir:    the ir itself, and standard optimizations.
427     /tv:    the target value module
428     /tr:    the type and entity representation
429     /adt:   abstract data types
430     /common:  stuff needed by all other dirs
431     /debug: debugging Unterstuetzung
432     /ident:
433   include:  external files needen as includes
434   testprograms: examples to test the lib.
435
436   The makefiles generate files with extension .d that contain the dependencies
437   between the files.
438
439   15.2.2000 Goetz
440   Added access routine to attribute link of irnode in irnode.ch.
441   Added get_negated_pnc to irnode.ch.
442
443   14.2.2000 Goetz
444   Added an iterator in iropt that calls the optimization for all nodes.
445   Copied optimize's code to optimize_in_place and removed deallocations.
446   Made set_irn_n in irnode.c public.
447   Added Bad as possible cfg predecessor in is_cfg_node in irnode.  Bads
448   are allowded as cfgpredecessors to represent dead "incoming" control
449   flow.
450   Added call to optimize_in_place in mature_block. Is this useful?
451
452   10.2.2000 Goetz
453   Changed tests from comparing enums to comparing pointers. This is more
454   efficient (is it?) and reads better.  e.g., instead get_irn_opcode == irm_And
455   now get_irn_op == op_And
456
457   10.2.2000 Goetz
458   Compared equivalent_value to the one in the original fiasco.
459   Added a test in case iro_And.
460   Changed implementation of iro_Div. Added routines turn_into_tuple
461     and set_irn_op() in irgmod/irnode.
462   Changed implementation of irn_Minus (although commented out).
463   Now all features are ported or documented for this function.
464
465   10.2.2000 Goetz
466   Compared computed_value to the one in the original fiasco.
467   Added one further optimization in case iro_Proj.
468   Now all features are ported for this function.
469
470   9.2.2000 Goetz
471   Updated comments in ircons.h.
472
473   9.2.2000 Goetz
474   Changed possible attribute of SymConst from type_class to type.
475   SymConst size could be the size of a union, array, ...
476
477   9.2.2000 Goetz
478   Implemented two dumpers that dump type information and a graph with
479   type information.
480
481   9.2.2000 Goetz
482   Implemented a walker that walks over the type informatin that can
483   be reached from an ir node.
484   Added routine get_kind(firm_thing) in common.h, Added file common.c.
485   Added files typewalk.ch and routines to irdump.
486   Added visited flags and initialization to entity and all types.
487   Implemented some of the missing access routines in type.c, entity.c
488
489   9.2.2000 Goetz
490   Implemented constructor for ShrA.
491   Added type struct.
492   Added routine that iterates the graph and verifies all nodes.
493   Added Phi_in stack to irgraph.  This allows to build several
494     graphs at once with respect to the Phi building algorithm.
495
496   9.2.2000 Goetz
497   Implemented dumper for control flow graphs.  Changed irr_* and dead_*
498   examples to dump cfg.
499
500   8.2.2000 Goetz
501   Implemeted explicit stack for the Phi node generation.  See ircons.c.
502
503   8.2.2000 Goetz
504   added include string.h in xoprintf.c to get rid of warning:
505   implicit declaration of function `bcopy'
506
507   7.2.2000 Goetz
508   Worked on iropt.c:
509   Added more cases to equivalent_node.
510   Portet gigo, identify, identify_remember.
511   The set/pset library can not handle several hash tables.  At least,
512   compiling several procedures causes a segmentation fault during access
513   to the tables (oo_program_example).  Need to work on this.
514   transform_node still needs to be ported.
515   some cases in equivalent_node are still missing.
516
517   To get it running I had to remove the call to optimize in the
518   new_Block constructor. It can only be called when the Block is
519   mature.
520
521   7.2.2000 Goetz
522   Introduced a walker that walks only over blocks.  The asserts
523   might be too strict for general graphs, but so far it works.
524   For the walker I introduced an additional flag in the attribute
525   of Blocks, an a global block_visited variable (in irgraph.h).
526   Furhter I modularized dump_ir_node, implemented dump_ir_graph
527   with the existing walker, and added new routines to output a
528   basic block graph.
529   Changed the examples to call the new dump routine.
530
531   7.2.2000 Goetz
532   Added auxiliary routines to ir_node:
533   skip_Proj, skip_Nop, is_Bad ...
534   Changed access routines to use get_irn_n instead of explicit array
535   accesses. Changed get_irn_n to call skip_Id, so that the access routines
536   never will return Id nodes.
537
538   3.2.2000 Goetz
539   Repaired Phi computation, changed new_r_Phi_in.  Added test program to
540   test irregular controlflow.
541
542   2.2.2000 Goetz
543   Updated optimizations computed_value and equivalent_node to new
544   Syntax of FIRM nodes and to use access routines.
545   Added routine skip_Proj in irnode.
546
547   2.2.2000 Boris Boesler
548   Added files irgwalk.c and irgwalk.h. They include a simple function to
549   traverse an ir graph and execute pre and post functions to current node.
550
551   1.2.2000 Goetz
552   Added arrays with parameters and result types to the type informtion
553   of a procedure.  This is needed for the code generation.  Also added
554   the corresponding access routines.
555   Adapted the testprograms.
556
557   1.2.2000 Goetz
558   Found a bug / complication:  the call order
559     get_value   (makes Phi0, put's it into graph_arr)
560     set_value   (overwrites Phi0 in graph_arr)
561     mature_block (upgrades Phi0, puts it again into graph_arr, overwriting
562                   the proper value.)
563   fails.  Added test wether graph_arr is already set in phi_merge.
564
565   Added tons of comments to explain Phi generation -- the stack hack.
566
567
568   27.1.2000 Goetz
569   irdump now outputs the pnc_number for projs of Cmp nodes.
570   Added routine to access the pnc_string.
571
572   27.1.2000 Goetz
573   Added result "dataseg" to Start node, with all it's consequences.
574   We need this for the compiler lab to translate global variables.
575   Now they can be selected from the data segment, and the start
576   node supplies the pointer to this segment.
577   These changes are guarded by preprocessor variable UEBPRAKT in
578   common.h
579   Changed files: common.h, irgraph.ch, irnode.h
580
581   26.1.2000 Goetz
582   Testprograms:
583   removed array_example, added array-heap_example and
584   array-stack_example and adapted makefile.
585   ir_lib:
586   Entity now also allows type_method as owner. This is to model
587   the stack, Sel nodes that select a variable (array) from the
588   stack need an entity that describes what they select.  This
589   entity gets the type of the enclosing procedure as owner.
590
591   24.1.2000 Chris
592   Added future access routines in `irmode.[ch]' as comments,
593     that all attributes in the ir_mode struct can be user-defined.
594   Added access routines in `irgraph.[ch]', for all attributes.
595
596   22.1.2000 Chris
597   Moved verify routines from `irgraph.[ch]' to own files `irvrfy.[ch]'.
598   Added `irvrfy.[ch]' to MAKEFILE
599   Added "inline" before access routines in `irnode.h', that no warnings
600     will appear furthermore.
601   Added three more access routines in `irmode.[ch]':
602         struct tarval *get_min_of_mode (ir_mode *mode);
603         struct tarval *get_max_of_mode (ir_mode *mode);
604         struct tarval *get_null_of_mode (ir_mode *mode);
605
606   21.1.2000 Goetz
607   Adaption of Alloc, Sel and Entity to new types:
608     Changed array_example to use type instead of type_class.
609     Changed entity to allow all types as owner instead of
610       only type_class.  Added routine "assert_legal_owner_of_ent(type* type)".
611     Changed alloc to allow allocating variables of any type instead of
612       only type_class.
613     Adapted all testprograms to avoid warnings.
614
615   removed dtest ... from Makefile, replaced by test.
616
617   20.1.2000 Goetz
618   Added "run" to makefile, added array_example to makefile of testprograms.
619   Corrected testprogram array
620   Changed assert in irvrfy -- Conv.
621   Started Change log.
622   Started TODO log.