/usr/lib/gcc/x86_64-linux-gnu/5/plugin/include/symbol-summary.h is in gcc-5-plugin-dev 5.5.0-12ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 | /* Callgraph summary data structure.
Copyright (C) 2014-2015 Free Software Foundation, Inc.
Contributed by Martin Liska
This file is part of GCC.
GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.
GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3. If not see
<http://www.gnu.org/licenses/>. */
#ifndef GCC_SYMBOL_SUMMARY_H
#define GCC_SYMBOL_SUMMARY_H
/* We want to pass just pointer types as argument for function_summary
template class. */
template <class T>
class function_summary
{
private:
function_summary();
};
template <class T>
class GTY((user)) function_summary <T *>
{
public:
/* Default construction takes SYMTAB as an argument. */
function_summary (symbol_table *symtab, bool ggc = false): m_ggc (ggc),
m_map (13, ggc), m_insertion_enabled (true), m_symtab (symtab)
{
#ifdef ENABLE_CHECKING
cgraph_node *node;
FOR_EACH_FUNCTION (node)
{
gcc_checking_assert (node->summary_uid > 0);
}
#endif
m_symtab_insertion_hook =
symtab->add_cgraph_insertion_hook
(function_summary::symtab_insertion, this);
m_symtab_removal_hook =
symtab->add_cgraph_removal_hook
(function_summary::symtab_removal, this);
m_symtab_duplication_hook =
symtab->add_cgraph_duplication_hook
(function_summary::symtab_duplication, this);
}
/* Destructor. */
virtual ~function_summary ()
{
release ();
}
/* Destruction method that can be called for GGT purpose. */
void release ()
{
if (m_symtab_insertion_hook)
m_symtab->remove_cgraph_insertion_hook (m_symtab_insertion_hook);
if (m_symtab_removal_hook)
m_symtab->remove_cgraph_removal_hook (m_symtab_removal_hook);
if (m_symtab_duplication_hook)
m_symtab->remove_cgraph_duplication_hook (m_symtab_duplication_hook);
m_symtab_insertion_hook = NULL;
m_symtab_removal_hook = NULL;
m_symtab_duplication_hook = NULL;
/* Release all summaries. */
typedef typename hash_map <int, T *, summary_hashmap_traits>::iterator map_iterator;
for (map_iterator it = m_map.begin (); it != m_map.end (); ++it)
release ((*it).second);
}
/* Traverses all summarys with a function F called with
ARG as argument. */
template<typename Arg, bool (*f)(const T &, Arg)>
void traverse (Arg a) const
{
m_map.traverse <f> (a);
}
/* Basic implementation of insert operation. */
virtual void insert (cgraph_node *, T *) {}
/* Basic implementation of removal operation. */
virtual void remove (cgraph_node *, T *) {}
/* Basic implementation of duplication operation. */
virtual void duplicate (cgraph_node *, cgraph_node *, T *, T *) {}
/* Allocates new data that are stored within map. */
T* allocate_new ()
{
return m_ggc ? new (ggc_alloc <T> ()) T() : new T () ;
}
/* Release an item that is stored within map. */
void release (T *item)
{
if (m_ggc)
{
item->~T ();
ggc_free (item);
}
else
delete item;
}
/* Getter for summary callgraph node pointer. */
T* get (cgraph_node *node)
{
return get (node->summary_uid);
}
/* Return number of elements handled by data structure. */
size_t elements ()
{
return m_map.elements ();
}
/* Enable insertion hook invocation. */
void enable_insertion_hook ()
{
m_insertion_enabled = true;
}
/* Enable insertion hook invocation. */
void disable_insertion_hook ()
{
m_insertion_enabled = false;
}
/* Symbol insertion hook that is registered to symbol table. */
static void symtab_insertion (cgraph_node *node, void *data)
{
function_summary *summary = (function_summary <T *> *) (data);
if (summary->m_insertion_enabled)
summary->insert (node, summary->get (node));
}
/* Symbol removal hook that is registered to symbol table. */
static void symtab_removal (cgraph_node *node, void *data)
{
gcc_checking_assert (node->summary_uid);
function_summary *summary = (function_summary <T *> *) (data);
int summary_uid = node->summary_uid;
T **v = summary->m_map.get (summary_uid);
if (v)
{
summary->remove (node, *v);
if (!summary->m_ggc)
delete (*v);
summary->m_map.remove (summary_uid);
}
}
/* Symbol duplication hook that is registered to symbol table. */
static void symtab_duplication (cgraph_node *node, cgraph_node *node2,
void *data)
{
function_summary *summary = (function_summary <T *> *) (data);
T **v = summary->m_map.get (node->summary_uid);
gcc_checking_assert (node2->summary_uid > 0);
if (v)
{
/* This load is necessary, because we insert a new value! */
T *data = *v;
T *duplicate = summary->allocate_new ();
summary->m_map.put (node2->summary_uid, duplicate);
summary->duplicate (node, node2, data, duplicate);
}
}
protected:
/* Indication if we use ggc summary. */
bool m_ggc;
private:
struct summary_hashmap_traits: default_hashmap_traits
{
static const int deleted_value = -1;
static const int empty_value = 0;
static hashval_t
hash (const int v)
{
return (hashval_t)v;
}
template<typename Type>
static bool
is_deleted (Type &e)
{
return e.m_key == deleted_value;
}
template<typename Type>
static bool
is_empty (Type &e)
{
return e.m_key == empty_value;
}
template<typename Type>
static void
mark_deleted (Type &e)
{
e.m_key = deleted_value;
}
template<typename Type>
static void
mark_empty (Type &e)
{
e.m_key = empty_value;
}
};
/* Getter for summary callgraph ID. */
T* get (int uid)
{
bool existed;
T **v = &m_map.get_or_insert (uid, &existed);
if (!existed)
*v = allocate_new ();
return *v;
}
/* Main summary store, where summary ID is used as key. */
hash_map <int, T *, summary_hashmap_traits> m_map;
/* Internal summary insertion hook pointer. */
cgraph_node_hook_list *m_symtab_insertion_hook;
/* Internal summary removal hook pointer. */
cgraph_node_hook_list *m_symtab_removal_hook;
/* Internal summary duplication hook pointer. */
cgraph_2node_hook_list *m_symtab_duplication_hook;
/* Indicates if insertion hook is enabled. */
bool m_insertion_enabled;
/* Symbol table the summary is registered to. */
symbol_table *m_symtab;
template <typename U> friend void gt_ggc_mx (function_summary <U *> * const &);
template <typename U> friend void gt_pch_nx (function_summary <U *> * const &);
template <typename U> friend void gt_pch_nx (function_summary <U *> * const &,
gt_pointer_operator, void *);
};
template <typename T>
void
gt_ggc_mx(function_summary<T *>* const &summary)
{
gcc_checking_assert (summary->m_ggc);
gt_ggc_mx (&summary->m_map);
}
template <typename T>
void
gt_pch_nx(function_summary<T *>* const &summary)
{
gcc_checking_assert (summary->m_ggc);
gt_pch_nx (&summary->m_map);
}
template <typename T>
void
gt_pch_nx(function_summary<T *>* const& summary, gt_pointer_operator op,
void *cookie)
{
gcc_checking_assert (summary->m_ggc);
gt_pch_nx (&summary->m_map, op, cookie);
}
#endif /* GCC_SYMBOL_SUMMARY_H */
|