07aae20777
To make this possible, add HloParser interface which only allows VerifiedHloModule to instantiate a parser and make the private HloParser class a HloParserImpl child class. Also use std::string instead of string in hlo_parser.cc. Finally add the verification at the end of the parsing instead of calling Verify() at various call sites. PiperOrigin-RevId: 276055152 Change-Id: I647e7a14e1ff9ae0aa1ba764af8718c753226e6b
102 lines
4.0 KiB
C++
102 lines
4.0 KiB
C++
/* Copyright 2017 The TensorFlow Authors. All Rights Reserved.
|
|
|
|
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 TENSORFLOW_COMPILER_XLA_SERVICE_HLO_PARSER_H_
|
|
#define TENSORFLOW_COMPILER_XLA_SERVICE_HLO_PARSER_H_
|
|
|
|
#include <memory>
|
|
#include <vector>
|
|
|
|
#include "absl/memory/memory.h"
|
|
#include "absl/strings/string_view.h"
|
|
#include "tensorflow/compiler/xla/service/hlo_computation.h"
|
|
#include "tensorflow/compiler/xla/service/hlo_instruction.h"
|
|
#include "tensorflow/compiler/xla/service/hlo_lexer.h"
|
|
#include "tensorflow/compiler/xla/service/hlo_module.h"
|
|
#include "tensorflow/compiler/xla/statusor.h"
|
|
#include "tensorflow/compiler/xla/xla_data.pb.h"
|
|
|
|
namespace xla {
|
|
|
|
// For details about the syntax accepted by this parser, see
|
|
// g3doc/hlo_parser.md.
|
|
|
|
// Given a string in the HloModule::ToString() format, parses the string and
|
|
// creates a HloModule with the given config.
|
|
// Note: Tests derived from HloTestBase should use
|
|
// ParseAndReturnVerifiedModule() instead!
|
|
StatusOr<std::unique_ptr<HloModule>> ParseAndReturnUnverifiedModule(
|
|
absl::string_view str, const HloModuleConfig& config);
|
|
|
|
// Given a string in the HloModule::ToString() format, parses the string and
|
|
// creates a HloModule with default config.
|
|
// Note: Tests derived from HloTestBase should use
|
|
// ParseAndReturnVerifiedModule() instead!
|
|
StatusOr<std::unique_ptr<HloModule>> ParseAndReturnUnverifiedModule(
|
|
absl::string_view str);
|
|
|
|
// Parses sharding from str. str is supposed to contain the body of the
|
|
// sharding, i.e. just the rhs of the "sharding={...}" attribute string, e.g.,
|
|
// "{replicated}".
|
|
StatusOr<HloSharding> ParseSharding(absl::string_view str);
|
|
|
|
// Parses frontend attributes from str. str is supposed to contain the body of
|
|
// the frontend attributes , i.e. just the rhs of the
|
|
// "frontend_attributes={...}" attribute string, e.g.,
|
|
// "{attr_a=a,attr_b=b}".
|
|
StatusOr<FrontendAttributes> ParseFrontendAttributes(absl::string_view str);
|
|
|
|
// Parses parameter replication from str. str is supposed to contain the body of
|
|
// the parameter replication, i.e. just the rhs of the
|
|
// "parameter_replication={...}" attribute string, e.g., "{true, false}".
|
|
StatusOr<std::vector<bool>> ParseParameterReplication(absl::string_view str);
|
|
|
|
// Parses the result of window_util::ToString(const Window&).
|
|
StatusOr<Window> ParseWindow(absl::string_view str);
|
|
|
|
// Parses the result of ConvolutionDimensionNumbersToString(), e.g.
|
|
// "b0f_0io->b0f".
|
|
StatusOr<ConvolutionDimensionNumbers> ParseConvolutionDimensionNumbers(
|
|
absl::string_view str);
|
|
|
|
// Parses the result of PaddingConfigToString(), e.g. "0_0x1_1".
|
|
StatusOr<PaddingConfig> ParsePaddingConfig(absl::string_view str);
|
|
|
|
// Parses and returns a Shape::ToString-format string.
|
|
StatusOr<Shape> ParseShape(absl::string_view str);
|
|
|
|
// Parses and returns a std::vector<ReplicaGroup> from str. str is supposed to
|
|
// contain a list of the replica groups, i.e. just the rhs of the
|
|
// "replica_groups={...}" attribute string, e.g., "{{0,1}, {2,3}}".
|
|
StatusOr<std::vector<ReplicaGroup>> ParseReplicaGroupsOnly(
|
|
absl::string_view str);
|
|
|
|
class HloParser {
|
|
public:
|
|
// Runs the parser and constructs the resulting HLO in the given (empty)
|
|
// HloModule. Returns the error status in case an error occurred.
|
|
virtual Status Run(HloModule* module) = 0;
|
|
virtual ~HloParser() {}
|
|
|
|
private:
|
|
static std::unique_ptr<HloParser> CreateHloParserForTests(
|
|
absl::string_view str);
|
|
friend class VerifiedHloModule;
|
|
};
|
|
|
|
} // namespace xla
|
|
|
|
#endif // TENSORFLOW_COMPILER_XLA_SERVICE_HLO_PARSER_H_
|