1 /*
2  * Copyright (c) 2015-2017, Intel Corporation
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *  * Redistributions of source code must retain the above copyright notice,
8  *    this list of conditions and the following disclaimer.
9  *  * Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *  * Neither the name of Intel Corporation nor the names of its contributors
13  *    may be used to endorse or promote products derived from this software
14  *    without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /** \file
30  * \brief Utility functions for working with Report ID sets.
31  */
32 
33 #ifndef NG_REPORTS_H
34 #define NG_REPORTS_H
35 
36 #include "ue2common.h"
37 
38 #include <set>
39 
40 namespace ue2 {
41 
42 class NGHolder;
43 class ReportManager;
44 
45 /** Returns the set of all reports in the graph. */
46 std::set<ReportID> all_reports(const NGHolder &g);
47 
48 /** True if *all* reports in the graph are exhaustible. */
49 bool can_exhaust(const NGHolder &g, const ReportManager &rm);
50 
51 /** Replaces all existing reports on the holder with the provided internal
52  *  report id. */
53 void set_report(NGHolder &g, ReportID internal_report);
54 
55 /** Derive a maximum offset for the graph from the max_offset values of its
56  * reports. Returns MAX_OFFSET for inf. */
57 u64a findMaxOffset(const NGHolder &g, const ReportManager &rm);
58 
59 } // namespace ue2
60 
61 #endif // NG_REPORTS_H
62