mirror of
https://github.com/KhronosGroup/SPIRV-Tools
synced 2025-01-03 21:51:05 +00:00
c90d7305e7
These flags are expanded to a series of spirv-opt flags with the
following semantics:
-O: expands to passes that attempt to improve the performance of the
generated code.
-Os: expands to passes that attempt to reduce the size of the generated
code.
-Oconfig=<file> expands to the sequence of passes determined by the
flags specified in the user-provided file.
107 lines
3.9 KiB
C++
107 lines
3.9 KiB
C++
// Copyright (c) 2016 Google Inc.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#ifndef LIBSPIRV_OPT_PASS_H_
|
|
#define LIBSPIRV_OPT_PASS_H_
|
|
|
|
#include <algorithm>
|
|
#include <map>
|
|
#include <queue>
|
|
#include <unordered_map>
|
|
#include <unordered_set>
|
|
|
|
#include <utility>
|
|
|
|
#include "module.h"
|
|
#include "spirv-tools/libspirv.hpp"
|
|
|
|
namespace spvtools {
|
|
namespace opt {
|
|
|
|
// Abstract class of a pass. All passes should implement this abstract class
|
|
// and all analysis and transformation is done via the Process() method.
|
|
class Pass {
|
|
public:
|
|
// The status of processing a module using a pass.
|
|
//
|
|
// The numbers for the cases are assigned to make sure that Failure & anything
|
|
// is Failure, SuccessWithChange & any success is SuccessWithChange.
|
|
enum class Status {
|
|
Failure = 0x00,
|
|
SuccessWithChange = 0x10,
|
|
SuccessWithoutChange = 0x11,
|
|
};
|
|
|
|
using ProcessFunction = std::function<bool(ir::Function*)>;
|
|
|
|
// Constructs a new pass.
|
|
//
|
|
// The constructed instance will have an empty message consumer, which just
|
|
// ignores all messages from the library. Use SetMessageConsumer() to supply
|
|
// one if messages are of concern.
|
|
Pass() : consumer_(nullptr) {}
|
|
|
|
// Destructs the pass.
|
|
virtual ~Pass() = default;
|
|
|
|
// Returns a descriptive name for this pass.
|
|
//
|
|
// NOTE: When deriving a new pass class, make sure you make the name
|
|
// compatible with the corresponding spirv-opt command-line flag. For example,
|
|
// if you add the flag --my-pass to spirv-opt, make this function return
|
|
// "my-pass" (no leading hyphens).
|
|
virtual const char* name() const = 0;
|
|
|
|
// Sets the message consumer to the given |consumer|. |consumer| which will be
|
|
// invoked every time there is a message to be communicated to the outside.
|
|
void SetMessageConsumer(MessageConsumer c) { consumer_ = std::move(c); }
|
|
// Returns the reference to the message consumer for this pass.
|
|
const MessageConsumer& consumer() const { return consumer_; }
|
|
|
|
// Add to |todo| all ids of functions called in |func|.
|
|
void AddCalls(ir::Function* func, std::queue<uint32_t>* todo);
|
|
|
|
// Applies |pfn| to every function in the call trees that are rooted at the
|
|
// entry points. Returns true if any call |pfn| returns true. By convention
|
|
// |pfn| should return true if it modified the module.
|
|
bool ProcessEntryPointCallTree(ProcessFunction& pfn, ir::Module* module);
|
|
|
|
// Applies |pfn| to every function in the call trees rooted at the entry
|
|
// points and exported functions. Returns true if any call |pfn| returns
|
|
// true. By convention |pfn| should return true if it modified the module.
|
|
bool ProcessReachableCallTree(ProcessFunction& pfn, ir::Module* module);
|
|
|
|
// Applies |pfn| to every function in the call trees rooted at the elements of
|
|
// |roots|. Returns true if any call to |pfn| returns true. By convention
|
|
// |pfn| should return true if it modified the module. After returning
|
|
// |roots| will be empty.
|
|
bool ProcessCallTreeFromRoots(
|
|
ProcessFunction& pfn,
|
|
const std::unordered_map<uint32_t, ir::Function*>& id2function,
|
|
std::queue<uint32_t>* roots);
|
|
|
|
// Processes the given |module|. Returns Status::Failure if errors occur when
|
|
// processing. Returns the corresponding Status::Success if processing is
|
|
// succesful to indicate whether changes are made to the module.
|
|
virtual Status Process(ir::Module* module) = 0;
|
|
|
|
private:
|
|
MessageConsumer consumer_; // Message consumer.
|
|
};
|
|
|
|
} // namespace opt
|
|
} // namespace spvtools
|
|
|
|
#endif // LIBSPIRV_OPT_PASS_H_
|