Infrastructure for SW CallTrees and group operations
[dyninst.git] / stackwalk / src / x86-swk.h
1 /*
2  * Copyright (c) 1996-2011 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31
32 #ifndef x86_swk_h_
33 #define x86_swk_h_
34
35 #include "stackwalk/h/steppergroup.h"
36 #include "stackwalk/h/framestepper.h"
37 #include "dynutil/h/dyntypes.h"
38
39 #include "common/h/lru_cache.h"
40
41 namespace Dyninst {
42 namespace Stackwalker {
43
44 #define MAX_WANDERER_DEPTH 256
45
46 class StepperWandererImpl : public FrameStepper {
47  private:
48    WandererHelper *whelper;
49    FrameFuncHelper *fhelper;
50    StepperWanderer *parent;
51    bool getWord(Address &words, Address start);
52  public:
53    StepperWandererImpl(Walker *walker_, StepperWanderer *parent_, WandererHelper *whelper_,
54                        FrameFuncHelper *fhelper_);
55    virtual gcframe_ret_t getCallerFrame(const Frame &in, Frame &out);
56    virtual unsigned getPriority() const;
57    void registerStepperGroup(StepperGroup *group);
58    virtual const char *getName() const;
59    virtual ~StepperWandererImpl();
60 };
61
62 class LookupFuncStart : public FrameFuncHelper
63 {
64 private:
65    static std::map<Dyninst::PID, LookupFuncStart*> all_func_starts;
66    LookupFuncStart(ProcessState *proc_);
67    int ref_count;
68
69    void updateCache(Address addr, alloc_frame_t result);
70    bool checkCache(Address addr, alloc_frame_t &result);
71    //We need some kind of re-entrant safe synhronization before we can
72    // globally turn this caching on, but it would sure help things.
73    static const unsigned int cache_size = 64;
74    LRUCache<Address, alloc_frame_t> cache;
75 public:
76    static LookupFuncStart *getLookupFuncStart(ProcessState *p);
77    void releaseMe();
78    virtual alloc_frame_t allocatesFrame(Address addr);
79    ~LookupFuncStart();
80    static void clear_func_mapping(Dyninst::PID);
81 };
82
83 }
84 }
85
86
87 #endif