Head

GCC Code Coverage Report

Directory:	.		Exec	Total	Coverage
File:	src/expr/skolem_manager.cpp	Lines:	155	158	98.1 %
Date:	2021-05-24	Branches:	309	746	41.4 %


/******************************************************************************
 * Top contributors (to current version):
 *   Andrew Reynolds, Aina Niemetz
 *
 * This file is part of the cvc5 project.
 *
 * Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
 * in the top-level source directory and their institutional affiliations.
 * All rights reserved.  See the file COPYING in the top-level source
 * directory for licensing information.
 * ****************************************************************************
 *
 * Implementation of skolem manager class.
 */

#include "expr/skolem_manager.h"

#include <sstream>

#include "expr/attribute.h"
#include "expr/bound_var_manager.h"
#include "expr/node_algorithm.h"

using namespace cvc5::kind;

namespace cvc5 {

// Attributes are global maps from Nodes to data. Thus, note that these could
// be implemented as internal maps in SkolemManager.
struct WitnessFormAttributeId
{
};
typedef expr::Attribute<WitnessFormAttributeId, Node> WitnessFormAttribute;

struct SkolemFormAttributeId
{
};
typedef expr::Attribute<SkolemFormAttributeId, Node> SkolemFormAttribute;

struct OriginalFormAttributeId
{
};
typedef expr::Attribute<OriginalFormAttributeId, Node> OriginalFormAttribute;

const char* toString(SkolemFunId id)
{
  switch (id)
  {
    case SkolemFunId::DIV_BY_ZERO: return "DIV_BY_ZERO";
    case SkolemFunId::INT_DIV_BY_ZERO: return "INT_DIV_BY_ZERO";
    case SkolemFunId::MOD_BY_ZERO: return "MOD_BY_ZERO";
    case SkolemFunId::SQRT: return "SQRT";
    case SkolemFunId::SELECTOR_WRONG: return "SELECTOR_WRONG";
    case SkolemFunId::SHARED_SELECTOR: return "SHARED_SELECTOR";
    case SkolemFunId::SEQ_NTH_OOB: return "SEQ_NTH_OOB";
    default: return "?";
  }
}

std::ostream& operator<<(std::ostream& out, SkolemFunId id)
{
  out << toString(id);
  return out;
}

Node SkolemManager::mkSkolem(Node v,
                             Node pred,
                             const std::string& prefix,
                             const std::string& comment,
                             int flags,
                             ProofGenerator* pg)
{
  // We do not currently insist that pred does not contain witness terms
  Assert(v.getKind() == BOUND_VARIABLE);
  // make the witness term
  NodeManager* nm = NodeManager::currentNM();
  Node bvl = nm->mkNode(BOUND_VAR_LIST, v);
  // Make the witness term, where notice that pred may contain skolems. We do
  // not recursively convert pred to witness form, since witness terms should
  // be treated as opaque. Moreover, the use of witness forms leads to
  // variable shadowing issues in e.g. skolemization.
  Node w = nm->mkNode(WITNESS, bvl, pred);
  // store the mapping to proof generator if it exists
  if (pg != nullptr)
  {
    // We cache based on the existential of the original predicate
    Node q = nm->mkNode(EXISTS, bvl, pred);
    // Notice this may overwrite an existing proof generator. This does not
    // matter since either should be able to prove q.
    d_gens[q] = pg;
  }
  Node k = mkSkolemInternal(w, prefix, comment, flags);
  // set witness form attribute for k
  WitnessFormAttribute wfa;
  k.setAttribute(wfa, w);
  Trace("sk-manager-skolem")
      << "skolem: " << k << " witness " << w << std::endl;
  return k;
}

Node SkolemManager::mkSkolemize(Node q,
                                std::vector<Node>& skolems,
                                const std::string& prefix,
                                const std::string& comment,
                                int flags,
                                ProofGenerator* pg)
{
  Trace("sk-manager-debug") << "mkSkolemize " << q << std::endl;
  Assert(q.getKind() == EXISTS);
  Node currQ = q;
  for (const Node& av : q[0])
  {
    Assert(currQ.getKind() == EXISTS && av == currQ[0][0]);
    // currQ is updated to the result of skolemizing its first variable in
    // the method below.
    Node sk = skolemize(currQ, currQ, prefix, comment, flags);
    Trace("sk-manager-debug")
        << "made skolem " << sk << " for " << av << std::endl;
    skolems.push_back(sk);
  }
  if (pg != nullptr)
  {
    // Same as above, this may overwrite an existing proof generator
    d_gens[q] = pg;
  }
  Trace("sk-manager-debug") << "...mkSkolemize returns " << currQ << std::endl;
  return currQ;
}

Node SkolemManager::skolemize(Node q,
                              Node& qskolem,
                              const std::string& prefix,
                              const std::string& comment,
                              int flags)
{
  Assert(q.getKind() == EXISTS);
  Node v;
  std::vector<Node> ovars;
  Trace("sk-manager-debug") << "mkSkolemize..." << std::endl;
  NodeManager* nm = NodeManager::currentNM();
  for (const Node& av : q[0])
  {
    if (v.isNull())
    {
      v = av;
      continue;
    }
    ovars.push_back(av);
  }
  Assert(!v.isNull());
  // make the predicate with one variable stripped off
  Node pred = q[1];
  Trace("sk-manager-debug") << "make exists predicate" << std::endl;
  if (!ovars.empty())
  {
    // keeps the same variables
    Node bvl = nm->mkNode(BOUND_VAR_LIST, ovars);
    // update the predicate
    pred = nm->mkNode(EXISTS, bvl, pred);
  }
  Trace("sk-manager-debug") << "call sub mkSkolem" << std::endl;
  // don't use a proof generator, since this may be an intermediate, partially
  // skolemized formula.
  Node k = mkSkolem(v, pred, prefix, comment, flags, nullptr);
  Assert(k.getType() == v.getType());
  TNode tv = v;
  TNode tk = k;
  Trace("sk-manager-debug")
      << "qskolem apply " << tv << " -> " << tk << " to " << pred << std::endl;
  // the quantified formula with one step of skolemization
  qskolem = pred.substitute(tv, tk);
  Trace("sk-manager-debug") << "qskolem done substitution" << std::endl;
  return k;
}

Node SkolemManager::mkPurifySkolem(Node t,
                                   const std::string& prefix,
                                   const std::string& comment,
                                   int flags)
{
  Node to = getOriginalForm(t);
  // We do not currently insist that to does not contain witness terms

  Node k = mkSkolemInternal(to, prefix, comment, flags);
  // set original form attribute for k
  OriginalFormAttribute ofa;
  k.setAttribute(ofa, to);

  Trace("sk-manager-skolem")
      << "skolem: " << k << " purify " << to << std::endl;
  return k;
}

Node SkolemManager::mkSkolemFunction(SkolemFunId id,
                                     TypeNode tn,
                                     Node cacheVal,
                                     int flags)
{
  std::tuple<SkolemFunId, TypeNode, Node> key(id, tn, cacheVal);
  std::map<std::tuple<SkolemFunId, TypeNode, Node>, Node>::iterator it =
      d_skolemFuns.find(key);
  if (it == d_skolemFuns.end())
  {
    NodeManager* nm = NodeManager::currentNM();
    std::stringstream ss;
    ss << "SKOLEM_FUN_" << id;
    Node k = nm->mkSkolem(ss.str(), tn, "an internal skolem function", flags);
    d_skolemFuns[key] = k;
    return k;
  }
  return it->second;
}

Node SkolemManager::mkDummySkolem(const std::string& prefix,
                                  const TypeNode& type,
                                  const std::string& comment,
                                  int flags)
{
  return NodeManager::currentNM()->mkSkolem(prefix, type, comment, flags);
}

ProofGenerator* SkolemManager::getProofGenerator(Node t) const
{
  std::map<Node, ProofGenerator*>::const_iterator it = d_gens.find(t);
  if (it != d_gens.end())
  {
    return it->second;
  }
  return nullptr;
}

Node SkolemManager::getWitnessForm(Node k)
{
  Assert(k.getKind() == SKOLEM);
  // simply look up the witness form for k via an attribute
  WitnessFormAttribute wfa;
  return k.getAttribute(wfa);
}

Node SkolemManager::getOriginalForm(Node n)
{
  if (n.isNull())
  {
    return n;
  }
  Trace("sk-manager-debug")
      << "SkolemManager::getOriginalForm " << n << std::endl;
  OriginalFormAttribute ofa;
  NodeManager* nm = NodeManager::currentNM();
  std::unordered_map<TNode, Node> visited;
  std::unordered_map<TNode, Node>::iterator it;
  std::vector<TNode> visit;
  TNode cur;
  visit.push_back(n);
  do
  {
    cur = visit.back();
    visit.pop_back();
    it = visited.find(cur);

    if (it == visited.end())
    {
      if (cur.hasAttribute(ofa))
      {
        visited[cur] = cur.getAttribute(ofa);
      }
      else
      {
        visited[cur] = Node::null();
        visit.push_back(cur);
        if (cur.getMetaKind() == metakind::PARAMETERIZED)
        {
          visit.push_back(cur.getOperator());
        }
        for (const Node& cn : cur)
        {
          visit.push_back(cn);
        }
      }
    }
    else if (it->second.isNull())
    {
      Node ret = cur;
      bool childChanged = false;
      std::vector<Node> children;
      if (cur.getMetaKind() == metakind::PARAMETERIZED)
      {
        it = visited.find(cur.getOperator());
        Assert(it != visited.end());
        Assert(!it->second.isNull());
        childChanged = childChanged || cur.getOperator() != it->second;
        children.push_back(it->second);
      }
      for (const Node& cn : cur)
      {
        it = visited.find(cn);
        Assert(it != visited.end());
        Assert(!it->second.isNull());
        childChanged = childChanged || cn != it->second;
        children.push_back(it->second);
      }
      if (childChanged)
      {
        ret = nm->mkNode(cur.getKind(), children);
      }
      cur.setAttribute(ofa, ret);
      visited[cur] = ret;
    }
  } while (!visit.empty());
  Assert(visited.find(n) != visited.end());
  Assert(!visited.find(n)->second.isNull());
  Trace("sk-manager-debug") << "..return " << visited[n] << std::endl;
  return visited[n];
}

Node SkolemManager::mkSkolemInternal(Node w,
                                     const std::string& prefix,
                                     const std::string& comment,
                                     int flags)
{
  // note that witness, original forms are independent, but share skolems
  NodeManager* nm = NodeManager::currentNM();
  // w is not necessarily a witness term
  SkolemFormAttribute sfa;
  Node k;
  // could already have a skolem if we used w already
  if (w.hasAttribute(sfa))
  {
    return w.getAttribute(sfa);
  }
  // make the new skolem
  if (flags & NodeManager::SKOLEM_BOOL_TERM_VAR)
  {
    Assert (w.getType().isBoolean());
    k = nm->mkBooleanTermVariable();
  }
  else
  {
    k = nm->mkSkolem(prefix, w.getType(), comment, flags);
  }
  // set skolem form attribute for w
  w.setAttribute(sfa, k);
  Trace("sk-manager") << "SkolemManager::mkSkolem: " << k << " : " << w
                      << std::endl;
  return k;
}

}  // namespace cvc5


Generated by: GCOVR (Version 3.2)

Line	Exec	Source
1		/******************************************************************************
2		* Top contributors (to current version):
3		* Andrew Reynolds, Aina Niemetz
4		*
5		* This file is part of the cvc5 project.
6		*
7		* Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
8		* in the top-level source directory and their institutional affiliations.
9		* All rights reserved. See the file COPYING in the top-level source
10		* directory for licensing information.
11		* ****************************************************************************
12		*
13		* Implementation of skolem manager class.
14		*/
15
16		#include "expr/skolem_manager.h"
17
18		#include <sstream>
19
20		#include "expr/attribute.h"
21		#include "expr/bound_var_manager.h"
22		#include "expr/node_algorithm.h"
23
24		using namespace cvc5::kind;
25
26		namespace cvc5 {
27
28		// Attributes are global maps from Nodes to data. Thus, note that these could
29		// be implemented as internal maps in SkolemManager.
30		struct WitnessFormAttributeId
31		{
32		};
33		typedef expr::Attribute<WitnessFormAttributeId, Node> WitnessFormAttribute;
34
35		struct SkolemFormAttributeId
36		{
37		};
38		typedef expr::Attribute<SkolemFormAttributeId, Node> SkolemFormAttribute;
39
40		struct OriginalFormAttributeId
41		{
42		};
43		typedef expr::Attribute<OriginalFormAttributeId, Node> OriginalFormAttribute;
44
45	2653	const char* toString(SkolemFunId id)
46		{
47	2653	switch (id)
48		{
49	81	case SkolemFunId::DIV_BY_ZERO: return "DIV_BY_ZERO";
50	61	case SkolemFunId::INT_DIV_BY_ZERO: return "INT_DIV_BY_ZERO";
51	32	case SkolemFunId::MOD_BY_ZERO: return "MOD_BY_ZERO";
52	11	case SkolemFunId::SQRT: return "SQRT";
53	565	case SkolemFunId::SELECTOR_WRONG: return "SELECTOR_WRONG";
54	1885	case SkolemFunId::SHARED_SELECTOR: return "SHARED_SELECTOR";
55	18	case SkolemFunId::SEQ_NTH_OOB: return "SEQ_NTH_OOB";
56		default: return "?";
57		}
58		}
59
60	2653	std::ostream& operator<<(std::ostream& out, SkolemFunId id)
61		{
62	2653	out << toString(id);
63	2653	return out;
64		}
65
66	5091	Node SkolemManager::mkSkolem(Node v,
67		Node pred,
68		const std::string& prefix,
69		const std::string& comment,
70		int flags,
71		ProofGenerator* pg)
72		{
73		// We do not currently insist that pred does not contain witness terms
74	5091	Assert(v.getKind() == BOUND_VARIABLE);
75		// make the witness term
76	5091	NodeManager* nm = NodeManager::currentNM();
77	10182	Node bvl = nm->mkNode(BOUND_VAR_LIST, v);
78		// Make the witness term, where notice that pred may contain skolems. We do
79		// not recursively convert pred to witness form, since witness terms should
80		// be treated as opaque. Moreover, the use of witness forms leads to
81		// variable shadowing issues in e.g. skolemization.
82	10182	Node w = nm->mkNode(WITNESS, bvl, pred);
83		// store the mapping to proof generator if it exists
84	5091	if (pg != nullptr)
85		{
86		// We cache based on the existential of the original predicate
87	3458	Node q = nm->mkNode(EXISTS, bvl, pred);
88		// Notice this may overwrite an existing proof generator. This does not
89		// matter since either should be able to prove q.
90	1729	d_gens[q] = pg;
91		}
92	5091	Node k = mkSkolemInternal(w, prefix, comment, flags);
93		// set witness form attribute for k
94		WitnessFormAttribute wfa;
95	5091	k.setAttribute(wfa, w);
96	10182	Trace("sk-manager-skolem")
97	5091	<< "skolem: " << k << " witness " << w << std::endl;
98	10182	return k;
99		}
100
101	1165	Node SkolemManager::mkSkolemize(Node q,
102		std::vector<Node>& skolems,
103		const std::string& prefix,
104		const std::string& comment,
105		int flags,
106		ProofGenerator* pg)
107		{
108	1165	Trace("sk-manager-debug") << "mkSkolemize " << q << std::endl;
109	1165	Assert(q.getKind() == EXISTS);
110	1165	Node currQ = q;
111	3431	for (const Node& av : q[0])
112		{
113	2266	Assert(currQ.getKind() == EXISTS && av == currQ[0][0]);
114		// currQ is updated to the result of skolemizing its first variable in
115		// the method below.
116	4532	Node sk = skolemize(currQ, currQ, prefix, comment, flags);
117	4532	Trace("sk-manager-debug")
118	2266	<< "made skolem " << sk << " for " << av << std::endl;
119	2266	skolems.push_back(sk);
120		}
121	1165	if (pg != nullptr)
122		{
123		// Same as above, this may overwrite an existing proof generator
124		d_gens[q] = pg;
125		}
126	1165	Trace("sk-manager-debug") << "...mkSkolemize returns " << currQ << std::endl;
127	1165	return currQ;
128		}
129
130	2266	Node SkolemManager::skolemize(Node q,
131		Node& qskolem,
132		const std::string& prefix,
133		const std::string& comment,
134		int flags)
135		{
136	2266	Assert(q.getKind() == EXISTS);
137	4532	Node v;
138	4532	std::vector<Node> ovars;
139	2266	Trace("sk-manager-debug") << "mkSkolemize..." << std::endl;
140	2266	NodeManager* nm = NodeManager::currentNM();
141	7296	for (const Node& av : q[0])
142		{
143	9562	if (v.isNull())
144		{
145	2266	v = av;
146	2266	continue;
147		}
148	5030	ovars.push_back(av);
149		}
150	2266	Assert(!v.isNull());
151		// make the predicate with one variable stripped off
152	4532	Node pred = q[1];
153	2266	Trace("sk-manager-debug") << "make exists predicate" << std::endl;
154	2266	if (!ovars.empty())
155		{
156		// keeps the same variables
157	2202	Node bvl = nm->mkNode(BOUND_VAR_LIST, ovars);
158		// update the predicate
159	1101	pred = nm->mkNode(EXISTS, bvl, pred);
160		}
161	2266	Trace("sk-manager-debug") << "call sub mkSkolem" << std::endl;
162		// don't use a proof generator, since this may be an intermediate, partially
163		// skolemized formula.
164	2266	Node k = mkSkolem(v, pred, prefix, comment, flags, nullptr);
165	2266	Assert(k.getType() == v.getType());
166	4532	TNode tv = v;
167	4532	TNode tk = k;
168	4532	Trace("sk-manager-debug")
169	2266	<< "qskolem apply " << tv << " -> " << tk << " to " << pred << std::endl;
170		// the quantified formula with one step of skolemization
171	2266	qskolem = pred.substitute(tv, tk);
172	2266	Trace("sk-manager-debug") << "qskolem done substitution" << std::endl;
173	4532	return k;
174		}
175
176	47948	Node SkolemManager::mkPurifySkolem(Node t,
177		const std::string& prefix,
178		const std::string& comment,
179		int flags)
180		{
181	95896	Node to = getOriginalForm(t);
182		// We do not currently insist that to does not contain witness terms
183
184	47948	Node k = mkSkolemInternal(to, prefix, comment, flags);
185		// set original form attribute for k
186		OriginalFormAttribute ofa;
187	47948	k.setAttribute(ofa, to);
188
189	95896	Trace("sk-manager-skolem")
190	47948	<< "skolem: " << k << " purify " << to << std::endl;
191	95896	return k;
192		}
193
194	5685	Node SkolemManager::mkSkolemFunction(SkolemFunId id,
195		TypeNode tn,
196		Node cacheVal,
197		int flags)
198		{
199	11370	std::tuple<SkolemFunId, TypeNode, Node> key(id, tn, cacheVal);
200		std::map<std::tuple<SkolemFunId, TypeNode, Node>, Node>::iterator it =
201	5685	d_skolemFuns.find(key);
202	5685	if (it == d_skolemFuns.end())
203		{
204	2653	NodeManager* nm = NodeManager::currentNM();
205	5306	std::stringstream ss;
206	2653	ss << "SKOLEM_FUN_" << id;
207	5306	Node k = nm->mkSkolem(ss.str(), tn, "an internal skolem function", flags);
208	2653	d_skolemFuns[key] = k;
209	2653	return k;
210		}
211	3032	return it->second;
212		}
213
214	114040	Node SkolemManager::mkDummySkolem(const std::string& prefix,
215		const TypeNode& type,
216		const std::string& comment,
217		int flags)
218		{
219	114040	return NodeManager::currentNM()->mkSkolem(prefix, type, comment, flags);
220		}
221
222	75	ProofGenerator* SkolemManager::getProofGenerator(Node t) const
223		{
224	75	std::map<Node, ProofGenerator*>::const_iterator it = d_gens.find(t);
225	75	if (it != d_gens.end())
226		{
227		return it->second;
228		}
229	75	return nullptr;
230		}
231
232	1786	Node SkolemManager::getWitnessForm(Node k)
233		{
234	1786	Assert(k.getKind() == SKOLEM);
235		// simply look up the witness form for k via an attribute
236		WitnessFormAttribute wfa;
237	1786	return k.getAttribute(wfa);
238		}
239
240	209512	Node SkolemManager::getOriginalForm(Node n)
241		{
242	209512	if (n.isNull())
243		{
244	4	return n;
245		}
246	419016	Trace("sk-manager-debug")
247	209508	<< "SkolemManager::getOriginalForm " << n << std::endl;
248		OriginalFormAttribute ofa;
249	209508	NodeManager* nm = NodeManager::currentNM();
250	419016	std::unordered_map<TNode, Node> visited;
251	209508	std::unordered_map<TNode, Node>::iterator it;
252	419016	std::vector<TNode> visit;
253	419016	TNode cur;
254	209508	visit.push_back(n);
255	591587	do
256		{
257	801095	cur = visit.back();
258	801095	visit.pop_back();
259	801095	it = visited.find(cur);
260
261	801095	if (it == visited.end())
262		{
263	535462	if (cur.hasAttribute(ofa))
264		{
265	345648	visited[cur] = cur.getAttribute(ofa);
266		}
267		else
268		{
269	189814	visited[cur] = Node::null();
270	189814	visit.push_back(cur);
271	189814	if (cur.getMetaKind() == metakind::PARAMETERIZED)
272		{
273	27143	visit.push_back(cur.getOperator());
274		}
275	564444	for (const Node& cn : cur)
276		{
277	374630	visit.push_back(cn);
278		}
279		}
280		}
281	265633	else if (it->second.isNull())
282		{
283	379628	Node ret = cur;
284	189814	bool childChanged = false;
285	379628	std::vector<Node> children;
286	189814	if (cur.getMetaKind() == metakind::PARAMETERIZED)
287		{
288	27143	it = visited.find(cur.getOperator());
289	27143	Assert(it != visited.end());
290	27143	Assert(!it->second.isNull());
291	27143	childChanged = childChanged \|\| cur.getOperator() != it->second;
292	27143	children.push_back(it->second);
293		}
294	564444	for (const Node& cn : cur)
295		{
296	374630	it = visited.find(cn);
297	374630	Assert(it != visited.end());
298	374630	Assert(!it->second.isNull());
299	374630	childChanged = childChanged \|\| cn != it->second;
300	374630	children.push_back(it->second);
301		}
302	189814	if (childChanged)
303		{
304	46809	ret = nm->mkNode(cur.getKind(), children);
305		}
306	189814	cur.setAttribute(ofa, ret);
307	189814	visited[cur] = ret;
308		}
309	801095	} while (!visit.empty());
310	209508	Assert(visited.find(n) != visited.end());
311	209508	Assert(!visited.find(n)->second.isNull());
312	209508	Trace("sk-manager-debug") << "..return " << visited[n] << std::endl;
313	209508	return visited[n];
314		}
315
316	53039	Node SkolemManager::mkSkolemInternal(Node w,
317		const std::string& prefix,
318		const std::string& comment,
319		int flags)
320		{
321		// note that witness, original forms are independent, but share skolems
322	53039	NodeManager* nm = NodeManager::currentNM();
323		// w is not necessarily a witness term
324		SkolemFormAttribute sfa;
325	106078	Node k;
326		// could already have a skolem if we used w already
327	53039	if (w.hasAttribute(sfa))
328		{
329	9711	return w.getAttribute(sfa);
330		}
331		// make the new skolem
332	43328	if (flags & NodeManager::SKOLEM_BOOL_TERM_VAR)
333		{
334	775	Assert (w.getType().isBoolean());
335	775	k = nm->mkBooleanTermVariable();
336		}
337		else
338		{
339	42553	k = nm->mkSkolem(prefix, w.getType(), comment, flags);
340		}
341		// set skolem form attribute for w
342	43328	w.setAttribute(sfa, k);
343	86656	Trace("sk-manager") << "SkolemManager::mkSkolem: " << k << " : " << w
344	43328	<< std::endl;
345	43328	return k;
346		}
347
348	28191	} // namespace cvc5