Main driver for working out if a class (normally goto_programt) has any natural loops. More...
#include <natural_loops.h>
Inheritance diagram for natural_loops_templatet< P, T >: Collaboration diagram for natural_loops_templatet< P, T >:Public Types | |
| typedef parentt::loopt | natural_loopt |
| Public Types inherited from loop_analysist< T > | |
| typedef loop_templatet< T > | loopt |
| typedef std::map< T, loopt > | loop_mapt |
Public Member Functions | |
| void | operator() (P &program) |
| const cfg_dominators_templatet< P, T, false > & | get_dominator_info () const |
| natural_loops_templatet () | |
| natural_loops_templatet (P &program) | |
| Public Member Functions inherited from loop_analysist< T > | |
| virtual void | output (std::ostream &) const |
| Print all natural loops that were found. More... | |
| bool | is_loop_header (const T instruction) const |
Returns true if instruction is the header of any loop. More... | |
| loop_analysist ()=default | |
Protected Types | |
| typedef cfg_dominators_templatet< P, T, false >::cfgt::nodet | nodet |
Protected Member Functions | |
| void | compute (P &program) |
| Finds all back-edges and computes the natural loops. More... | |
| void | compute_natural_loop (T, T) |
| Computes the natural loop for a given back-edge (see Muchnick section 7.4) More... | |
Protected Attributes | |
| cfg_dominators_templatet< P, T, false > | cfg_dominators |
Private Types | |
| typedef loop_analysist< T > | parentt |
Additional Inherited Members | |
| Public Attributes inherited from loop_analysist< T > | |
| loop_mapt | loop_map |
Detailed Description
template<class P, class T>
class natural_loops_templatet< P, T >
Main driver for working out if a class (normally goto_programt) has any natural loops.
compute takes an entire goto_programt, iterates over the instructions and for any backwards jumps attempts to find out if it's a natural loop.
All instructions in a natural loop are stored into loop_map, keyed by their head - the target of the backwards goto jump.
- Template Parameters
-
P the program representation and needs: - [field] instruction which is an iterable of type T.
T iterator of the particular node type, e.g. std::list<...>::iterator. The object this iterator holds needs: - [function] is_backwards_goto() returning a bool.
- [function] get_target() which returns an object that needs:
- [field] location_number which is an unsigned int.
Definition at line 47 of file natural_loops.h.
Member Typedef Documentation
◆ natural_loopt
| typedef parentt::loopt natural_loops_templatet< P, T >::natural_loopt |
Definition at line 52 of file natural_loops.h.
◆ nodet
|
protected |
Definition at line 75 of file natural_loops.h.
◆ parentt
|
private |
Definition at line 49 of file natural_loops.h.
Constructor & Destructor Documentation
◆ natural_loops_templatet() [1/2]
|
inline |
Definition at line 64 of file natural_loops.h.
◆ natural_loops_templatet() [2/2]
|
inlineexplicit |
Definition at line 68 of file natural_loops.h.
Member Function Documentation
◆ compute()
|
protected |
Finds all back-edges and computes the natural loops.
Definition at line 103 of file natural_loops.h.
◆ compute_natural_loop()
|
protected |
Computes the natural loop for a given back-edge (see Muchnick section 7.4)
Definition at line 137 of file natural_loops.h.
◆ get_dominator_info()
|
inline |
Definition at line 59 of file natural_loops.h.
◆ operator()()
|
inline |
Definition at line 54 of file natural_loops.h.
Member Data Documentation
◆ cfg_dominators
|
protected |
Definition at line 74 of file natural_loops.h.
The documentation for this class was generated from the following file:
- /home/runner/work/cbmc-documentation/cbmc-documentation/src/analyses/natural_loops.h
