blob: aac67c18c38ceabce2634c0fe0c765f7f7abaea8 [file] [log] [blame]
/* IPA reference lists.
Copyright (C) 2010-2022 Free Software Foundation, Inc.
Contributed by Jan Hubicka
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_IPA_REF_H
#define GCC_IPA_REF_H
struct cgraph_node;
struct varpool_node;
struct symtab_node;
/* How the reference is done. */
enum ipa_ref_use
{
IPA_REF_LOAD,
IPA_REF_STORE,
IPA_REF_ADDR,
IPA_REF_ALIAS
};
/* Record of reference in callgraph or varpool. */
struct ipa_ref
{
public:
/* Remove reference. */
void remove_reference ();
/* Return true when execution of reference can lead to return from
function. */
bool cannot_lead_to_return ();
/* Return true if reference may be used in address compare. */
bool address_matters_p ();
/* Return reference list this reference is in. */
struct ipa_ref_list * referring_ref_list (void);
/* Return reference list this reference is in. */
struct ipa_ref_list * referred_ref_list (void);
symtab_node *referring;
symtab_node *referred;
gimple *stmt;
unsigned int lto_stmt_uid;
unsigned int referred_index;
/* speculative id is used to link direct calls with their corresponding
IPA_REF_ADDR references when representing speculative calls. */
unsigned int speculative_id : 16;
ENUM_BITFIELD (ipa_ref_use) use:3;
unsigned int speculative:1;
};
typedef struct ipa_ref ipa_ref_t;
/* List of references. This is stored in both callgraph and varpool nodes. */
struct ipa_ref_list
{
public:
/* Return first reference in list or NULL if empty. */
struct ipa_ref *first_reference (void)
{
if (!references.length ())
return NULL;
return &references[0];
}
/* Return first referring ref in list or NULL if empty. */
struct ipa_ref *first_referring (void)
{
if (!referring.length ())
return NULL;
return referring[0];
}
/* Return first referring alias. */
struct ipa_ref *first_alias (void)
{
struct ipa_ref *r = first_referring ();
return r && r->use == IPA_REF_ALIAS ? r : NULL;
}
/* Return last referring alias. */
struct ipa_ref *last_alias (void)
{
unsigned int i = 0;
for(i = 0; i < referring.length (); i++)
if (referring[i]->use != IPA_REF_ALIAS)
break;
return i == 0 ? NULL : referring[i - 1];
}
/* Return true if the symbol has an alias. */
bool inline has_aliases_p (void)
{
return first_alias ();
}
/* Clear reference list. */
void clear (void)
{
referring.create (0);
references.create (0);
}
/* Return number of references. */
unsigned int nreferences (void)
{
return references.length ();
}
/* Store actual references in references vector. */
vec<ipa_ref_t, va_heap, vl_ptr> references;
/* Referring is vector of pointers to references. It must not live in GGC space
or GGC will try to mark middle of references vectors. */
vec<ipa_ref_t *, va_heap, vl_ptr> referring;
};
#endif /* GCC_IPA_REF_H */