← Back to branch summary

~ubuntu-branches/debian/sid/clamav/sid

« back to all changes in this revision

Viewing changes to libclamav/c++/llvm/include/llvm/Analysis/CallGraph.h

  • Committer: Package Import Robot
  • Author(s): Scott Kitterman, Sebastian Andrzej Siewior, Andreas Cadhalpun, Scott Kitterman, Javier Fernández-Sanguino
  • Date: 2015-01-28 00:25:13 UTC
  • mfrom: (1.3.15)
  • Revision ID: package-import@ubuntu.com-20150128002513-4apvvjyr1213db8x
Tags: 0.98.6+dfsg-1
http://bugs.debian.org/774686
http://bugs.debian.org/767350
http://bugs.debian.org/775400
http://bugs.debian.org/767353
http://bugs.debian.org/773563
[ Sebastian Andrzej Siewior ]
* update "fix-ssize_t-size_t-off_t-printf-modifier", include of misc.h was
  missing but was pulled in via the systemd patch.
* Don't leak return codes from libmspack to clamav API. (Closes: #774686).

[ Andreas Cadhalpun ]
* Add patch to avoid emitting incremental progress messages when not
  outputting to a terminal. (Closes: #767350)
* Update lintian-overrides for unused-file-paragraph-in-dep5-copyright.
* clamav-base.postinst: always chown /var/log/clamav and /var/lib/clamav
  to clamav:clamav, not only on fresh installations. (Closes: #775400)
* Adapt the clamav-daemon and clamav-freshclam logrotate scripts,
  so that they correctly work under systemd.
* Move the PidFile variable from the clamd/freshclam configuration files
  to the init scripts. This makes the init scripts more robust against
  misconfiguration and avoids error messages with systemd. (Closes: #767353)
* debian/copyright: drop files from Files-Excluded only present in github
  tarballs
* Drop Workaround-a-bug-in-libc-on-Hurd.patch, because hurd got fixed.
  (see #752237)
* debian/rules: Remove useless --with-system-tommath --without-included-ltdl
  configure options.

[ Scott Kitterman ]
* Stop stripping llvm when repacking the tarball as the system llvm on some
  releases is too old to use
* New upstream bugfix release
  - Library shared object revisions.
  - Includes a patch from Sebastian Andrzej Siewior making ClamAV pid files
    compatible with systemd.
  - Fix a heap out of bounds condition with crafted Yoda's crypter files.
    This issue was discovered by Felix Groebert of the Google Security Team.
  - Fix a heap out of bounds condition with crafted mew packer files. This
    issue was discovered by Felix Groebert of the Google Security Team.
  - Fix a heap out of bounds condition with crafted upx packer files. This
    issue was discovered by Kevin Szkudlapski of Quarkslab.
  - Fix a heap out of bounds condition with crafted upack packer files. This
    issue was discovered by Sebastian Andrzej Siewior. CVE-2014-9328.
  - Compensate a crash due to incorrect compiler optimization when handling
    crafted petite packer files. This issue was discovered by Sebastian
    Andrzej Siewior.
* Update lintian override for embedded zlib to match new so version

[ Javier Fernández-Sanguino ]
* Updated Spanish Debconf template translation (Closes: #773563)

Show diffs side-by-side

added added

removed removed

Lines of Context:
libclamav/c++/llvm/include/llvm/Analysis/CallGraph.h
 
1
//===- CallGraph.h - Build a Module's call graph ----------------*- C++ -*-===//
 
2
//
 
3
//                     The LLVM Compiler Infrastructure
 
4
//
 
5
// This file is distributed under the University of Illinois Open Source
 
6
// License. See LICENSE.TXT for details.
 
7
//
 
8
//===----------------------------------------------------------------------===//
 
9
//
 
10
// This interface is used to build and manipulate a call graph, which is a very
 
11
// useful tool for interprocedural optimization.
 
12
//
 
13
// Every function in a module is represented as a node in the call graph.  The
 
14
// callgraph node keeps track of which functions the are called by the function
 
15
// corresponding to the node.
 
16
//
 
17
// A call graph may contain nodes where the function that they correspond to is
 
18
// null.  These 'external' nodes are used to represent control flow that is not
 
19
// represented (or analyzable) in the module.  In particular, this analysis
 
20
// builds one external node such that:
 
21
//   1. All functions in the module without internal linkage will have edges
 
22
//      from this external node, indicating that they could be called by
 
23
//      functions outside of the module.
 
24
//   2. All functions whose address is used for something more than a direct
 
25
//      call, for example being stored into a memory location will also have an
 
26
//      edge from this external node.  Since they may be called by an unknown
 
27
//      caller later, they must be tracked as such.
 
28
//
 
29
// There is a second external node added for calls that leave this module.
 
30
// Functions have a call edge to the external node iff:
 
31
//   1. The function is external, reflecting the fact that they could call
 
32
//      anything without internal linkage or that has its address taken.
 
33
//   2. The function contains an indirect function call.
 
34
//
 
35
// As an extension in the future, there may be multiple nodes with a null
 
36
// function.  These will be used when we can prove (through pointer analysis)
 
37
// that an indirect call site can call only a specific set of functions.
 
38
//
 
39
// Because of these properties, the CallGraph captures a conservative superset
 
40
// of all of the caller-callee relationships, which is useful for
 
41
// transformations.
 
42
//
 
43
// The CallGraph class also attempts to figure out what the root of the
 
44
// CallGraph is, which it currently does by looking for a function named 'main'.
 
45
// If no function named 'main' is found, the external node is used as the entry
 
46
// node, reflecting the fact that any function without internal linkage could
 
47
// be called into (which is common for libraries).
 
48
//
 
49
//===----------------------------------------------------------------------===//
 
50
 
 
51
#ifndef LLVM_ANALYSIS_CALLGRAPH_H
 
52
#define LLVM_ANALYSIS_CALLGRAPH_H
 
53
 
 
54
#include "llvm/Function.h"
 
55
#include "llvm/Pass.h"
 
56
#include "llvm/ADT/GraphTraits.h"
 
57
#include "llvm/ADT/STLExtras.h"
 
58
#include "llvm/Support/CallSite.h"
 
59
#include "llvm/Support/ValueHandle.h"
 
60
#include "llvm/System/IncludeFile.h"
 
61
#include <map>
 
62
 
 
63
namespace llvm {
 
64
 
 
65
class Function;
 
66
class Module;
 
67
class CallGraphNode;
 
68
 
 
69
//===----------------------------------------------------------------------===//
 
70
// CallGraph class definition
 
71
//
 
72
class CallGraph {
 
73
protected:
 
74
  Module *Mod;              // The module this call graph represents
 
75
 
 
76
  typedef std::map<const Function *, CallGraphNode *> FunctionMapTy;
 
77
  FunctionMapTy FunctionMap;    // Map from a function to its node
 
78
 
 
79
public:
 
80
  static char ID; // Class identification, replacement for typeinfo
 
81
  //===---------------------------------------------------------------------
 
82
  // Accessors.
 
83
  //
 
84
  typedef FunctionMapTy::iterator iterator;
 
85
  typedef FunctionMapTy::const_iterator const_iterator;
 
86
 
 
87
  /// getModule - Return the module the call graph corresponds to.
 
88
  ///
 
89
  Module &getModule() const { return *Mod; }
 
90
 
 
91
  inline       iterator begin()       { return FunctionMap.begin(); }
 
92
  inline       iterator end()         { return FunctionMap.end();   }
 
93
  inline const_iterator begin() const { return FunctionMap.begin(); }
 
94
  inline const_iterator end()   const { return FunctionMap.end();   }
 
95
 
 
96
  // Subscripting operators, return the call graph node for the provided
 
97
  // function
 
98
  inline const CallGraphNode *operator[](const Function *F) const {
 
99
    const_iterator I = FunctionMap.find(F);
 
100
    assert(I != FunctionMap.end() && "Function not in callgraph!");
 
101
    return I->second;
 
102
  }
 
103
  inline CallGraphNode *operator[](const Function *F) {
 
104
    const_iterator I = FunctionMap.find(F);
 
105
    assert(I != FunctionMap.end() && "Function not in callgraph!");
 
106
    return I->second;
 
107
  }
 
108
 
 
109
  /// Returns the CallGraphNode which is used to represent undetermined calls
 
110
  /// into the callgraph.  Override this if you want behavioral inheritance.
 
111
  virtual CallGraphNode* getExternalCallingNode() const { return 0; }
 
112
  virtual CallGraphNode* getCallsExternalNode()   const { return 0; }
 
113
 
 
114
  /// Return the root/main method in the module, or some other root node, such
 
115
  /// as the externalcallingnode.  Overload these if you behavioral
 
116
  /// inheritance.
 
117
  virtual CallGraphNode* getRoot() { return 0; }
 
118
  virtual const CallGraphNode* getRoot() const { return 0; }
 
119
 
 
120
  //===---------------------------------------------------------------------
 
121
  // Functions to keep a call graph up to date with a function that has been
 
122
  // modified.
 
123
  //
 
124
 
 
125
  /// removeFunctionFromModule - Unlink the function from this module, returning
 
126
  /// it.  Because this removes the function from the module, the call graph
 
127
  /// node is destroyed.  This is only valid if the function does not call any
 
128
  /// other functions (ie, there are no edges in it's CGN).  The easiest way to
 
129
  /// do this is to dropAllReferences before calling this.
 
130
  ///
 
131
  Function *removeFunctionFromModule(CallGraphNode *CGN);
 
132
  Function *removeFunctionFromModule(Function *F) {
 
133
    return removeFunctionFromModule((*this)[F]);
 
134
  }
 
135
 
 
136
  /// getOrInsertFunction - This method is identical to calling operator[], but
 
137
  /// it will insert a new CallGraphNode for the specified function if one does
 
138
  /// not already exist.
 
139
  CallGraphNode *getOrInsertFunction(const Function *F);
 
140
 
 
141
  //===---------------------------------------------------------------------
 
142
  // Pass infrastructure interface glue code.
 
143
  //
 
144
protected:
 
145
  CallGraph() {}
 
146
 
 
147
public:
 
148
  virtual ~CallGraph() { destroy(); }
 
149
 
 
150
  /// initialize - Call this method before calling other methods,
 
151
  /// re/initializes the state of the CallGraph.
 
152
  ///
 
153
  void initialize(Module &M);
 
154
 
 
155
  void print(raw_ostream &o, Module *) const;
 
156
  void dump() const;
 
157
protected:
 
158
  // destroy - Release memory for the call graph
 
159
  virtual void destroy();
 
160
};
 
161
 
 
162
//===----------------------------------------------------------------------===//
 
163
// CallGraphNode class definition.
 
164
//
 
165
class CallGraphNode {
 
166
  AssertingVH<Function> F;
 
167
  
 
168
  // CallRecord - This is a pair of the calling instruction (a call or invoke)
 
169
  // and the callgraph node being called.
 
170
public:
 
171
  typedef std::pair<WeakVH, CallGraphNode*> CallRecord;
 
172
private:
 
173
  std::vector<CallRecord> CalledFunctions;
 
174
  
 
175
  /// NumReferences - This is the number of times that this CallGraphNode occurs
 
176
  /// in the CalledFunctions array of this or other CallGraphNodes.
 
177
  unsigned NumReferences;
 
178
 
 
179
  CallGraphNode(const CallGraphNode &);            // DO NOT IMPLEMENT
 
180
  void operator=(const CallGraphNode &);           // DO NOT IMPLEMENT
 
181
  
 
182
  void DropRef() { --NumReferences; }
 
183
  void AddRef() { ++NumReferences; }
 
184
public:
 
185
  typedef std::vector<CallRecord> CalledFunctionsVector;
 
186
 
 
187
  
 
188
  // CallGraphNode ctor - Create a node for the specified function.
 
189
  inline CallGraphNode(Function *f) : F(f), NumReferences(0) {}
 
190
  ~CallGraphNode() {
 
191
    assert(NumReferences == 0 && "Node deleted while references remain");
 
192
  }
 
193
  
 
194
  //===---------------------------------------------------------------------
 
195
  // Accessor methods.
 
196
  //
 
197
 
 
198
  typedef std::vector<CallRecord>::iterator iterator;
 
199
  typedef std::vector<CallRecord>::const_iterator const_iterator;
 
200
 
 
201
  // getFunction - Return the function that this call graph node represents.
 
202
  Function *getFunction() const { return F; }
 
203
 
 
204
  inline iterator begin() { return CalledFunctions.begin(); }
 
205
  inline iterator end()   { return CalledFunctions.end();   }
 
206
  inline const_iterator begin() const { return CalledFunctions.begin(); }
 
207
  inline const_iterator end()   const { return CalledFunctions.end();   }
 
208
  inline bool empty() const { return CalledFunctions.empty(); }
 
209
  inline unsigned size() const { return (unsigned)CalledFunctions.size(); }
 
210
 
 
211
  /// getNumReferences - Return the number of other CallGraphNodes in this
 
212
  /// CallGraph that reference this node in their callee list.
 
213
  unsigned getNumReferences() const { return NumReferences; }
 
214
  
 
215
  // Subscripting operator - Return the i'th called function.
 
216
  //
 
217
  CallGraphNode *operator[](unsigned i) const {
 
218
    assert(i < CalledFunctions.size() && "Invalid index");
 
219
    return CalledFunctions[i].second;
 
220
  }
 
221
 
 
222
  /// dump - Print out this call graph node.
 
223
  ///
 
224
  void dump() const;
 
225
  void print(raw_ostream &OS) const;
 
226
 
 
227
  //===---------------------------------------------------------------------
 
228
  // Methods to keep a call graph up to date with a function that has been
 
229
  // modified
 
230
  //
 
231
 
 
232
  /// removeAllCalledFunctions - As the name implies, this removes all edges
 
233
  /// from this CallGraphNode to any functions it calls.
 
234
  void removeAllCalledFunctions() {
 
235
    while (!CalledFunctions.empty()) {
 
236
      CalledFunctions.back().second->DropRef();
 
237
      CalledFunctions.pop_back();
 
238
    }
 
239
  }
 
240
  
 
241
  /// stealCalledFunctionsFrom - Move all the callee information from N to this
 
242
  /// node.
 
243
  void stealCalledFunctionsFrom(CallGraphNode *N) {
 
244
    assert(CalledFunctions.empty() &&
 
245
           "Cannot steal callsite information if I already have some");
 
246
    std::swap(CalledFunctions, N->CalledFunctions);
 
247
  }
 
248
  
 
249
 
 
250
  /// addCalledFunction - Add a function to the list of functions called by this
 
251
  /// one.
 
252
  void addCalledFunction(CallSite CS, CallGraphNode *M) {
 
253
    CalledFunctions.push_back(std::make_pair(CS.getInstruction(), M));
 
254
    M->AddRef();
 
255
  }
 
256
 
 
257
  void removeCallEdge(iterator I) {
 
258
    I->second->DropRef();
 
259
    *I = CalledFunctions.back();
 
260
    CalledFunctions.pop_back();
 
261
  }
 
262
  
 
263
  
 
264
  /// removeCallEdgeFor - This method removes the edge in the node for the
 
265
  /// specified call site.  Note that this method takes linear time, so it
 
266
  /// should be used sparingly.
 
267
  void removeCallEdgeFor(CallSite CS);
 
268
 
 
269
  /// removeAnyCallEdgeTo - This method removes all call edges from this node
 
270
  /// to the specified callee function.  This takes more time to execute than
 
271
  /// removeCallEdgeTo, so it should not be used unless necessary.
 
272
  void removeAnyCallEdgeTo(CallGraphNode *Callee);
 
273
 
 
274
  /// removeOneAbstractEdgeTo - Remove one edge associated with a null callsite
 
275
  /// from this node to the specified callee function.
 
276
  void removeOneAbstractEdgeTo(CallGraphNode *Callee);
 
277
  
 
278
  /// replaceCallEdge - This method replaces the edge in the node for the
 
279
  /// specified call site with a new one.  Note that this method takes linear
 
280
  /// time, so it should be used sparingly.
 
281
  void replaceCallEdge(CallSite CS, CallSite NewCS, CallGraphNode *NewNode);
 
282
  
 
283
  /// allReferencesDropped - This is a special function that should only be
 
284
  /// used by the CallGraph class.
 
285
  void allReferencesDropped() {
 
286
    NumReferences = 0;
 
287
  }
 
288
};
 
289
 
 
290
//===----------------------------------------------------------------------===//
 
291
// GraphTraits specializations for call graphs so that they can be treated as
 
292
// graphs by the generic graph algorithms.
 
293
//
 
294
 
 
295
// Provide graph traits for tranversing call graphs using standard graph
 
296
// traversals.
 
297
template <> struct GraphTraits<CallGraphNode*> {
 
298
  typedef CallGraphNode NodeType;
 
299
 
 
300
  typedef CallGraphNode::CallRecord CGNPairTy;
 
301
  typedef std::pointer_to_unary_function<CGNPairTy, CallGraphNode*> CGNDerefFun;
 
302
 
 
303
  static NodeType *getEntryNode(CallGraphNode *CGN) { return CGN; }
 
304
 
 
305
  typedef mapped_iterator<NodeType::iterator, CGNDerefFun> ChildIteratorType;
 
306
 
 
307
  static inline ChildIteratorType child_begin(NodeType *N) {
 
308
    return map_iterator(N->begin(), CGNDerefFun(CGNDeref));
 
309
  }
 
310
  static inline ChildIteratorType child_end  (NodeType *N) {
 
311
    return map_iterator(N->end(), CGNDerefFun(CGNDeref));
 
312
  }
 
313
 
 
314
  static CallGraphNode *CGNDeref(CGNPairTy P) {
 
315
    return P.second;
 
316
  }
 
317
 
 
318
};
 
319
 
 
320
template <> struct GraphTraits<const CallGraphNode*> {
 
321
  typedef const CallGraphNode NodeType;
 
322
  typedef NodeType::const_iterator ChildIteratorType;
 
323
 
 
324
  static NodeType *getEntryNode(const CallGraphNode *CGN) { return CGN; }
 
325
  static inline ChildIteratorType child_begin(NodeType *N) { return N->begin();}
 
326
  static inline ChildIteratorType child_end  (NodeType *N) { return N->end(); }
 
327
};
 
328
 
 
329
template<> struct GraphTraits<CallGraph*> : public GraphTraits<CallGraphNode*> {
 
330
  static NodeType *getEntryNode(CallGraph *CGN) {
 
331
    return CGN->getExternalCallingNode();  // Start at the external node!
 
332
  }
 
333
  typedef std::pair<const Function*, CallGraphNode*> PairTy;
 
334
  typedef std::pointer_to_unary_function<PairTy, CallGraphNode&> DerefFun;
 
335
 
 
336
  // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
 
337
  typedef mapped_iterator<CallGraph::iterator, DerefFun> nodes_iterator;
 
338
  static nodes_iterator nodes_begin(CallGraph *CG) {
 
339
    return map_iterator(CG->begin(), DerefFun(CGdereference));
 
340
  }
 
341
  static nodes_iterator nodes_end  (CallGraph *CG) {
 
342
    return map_iterator(CG->end(), DerefFun(CGdereference));
 
343
  }
 
344
 
 
345
  static CallGraphNode &CGdereference(PairTy P) {
 
346
    return *P.second;
 
347
  }
 
348
};
 
349
 
 
350
template<> struct GraphTraits<const CallGraph*> :
 
351
  public GraphTraits<const CallGraphNode*> {
 
352
  static NodeType *getEntryNode(const CallGraph *CGN) {
 
353
    return CGN->getExternalCallingNode();
 
354
  }
 
355
  // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
 
356
  typedef CallGraph::const_iterator nodes_iterator;
 
357
  static nodes_iterator nodes_begin(const CallGraph *CG) { return CG->begin(); }
 
358
  static nodes_iterator nodes_end  (const CallGraph *CG) { return CG->end(); }
 
359
};
 
360
 
 
361
} // End llvm namespace
 
362
 
 
363
// Make sure that any clients of this file link in CallGraph.cpp
 
364
FORCE_DEFINING_FILE_TO_BE_LINKED(CallGraph)
 
365
 
 
366
#endif