error-util.h

Go to the documentation of this file.

// Copyright 2012 Cloudera 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 IMPALA_UTIL_ERROR_UTIL_H
#define IMPALA_UTIL_ERROR_UTIL_H


#include <string>
#include <vector>
#include <boost/cstdint.hpp>
#include <boost/lexical_cast.hpp>

#include "gen-cpp/CatalogObjects_types.h"
#include "gen-cpp/ErrorCodes_types.h"
#include "gen-cpp/ErrorCodes_constants.h"
#include "gen-cpp/ImpalaInternalService_types.h"
#include "gutil/strings/substitute.h"

namespace impala {

std::string GetStrErrMsg();

std::string GetTablesMissingStatsWarning(
    const std::vector<TTableName>& tables_missing_stats);


class ErrorMsg {
 public:
  typedef strings::internal::SubstituteArg ArgType;

  ErrorMsg() : error_(TErrorCode::OK) {}

  ErrorMsg(TErrorCode::type error);
  ErrorMsg(TErrorCode::type error, const ArgType& arg0);
  ErrorMsg(TErrorCode::type error, const ArgType& arg0, const ArgType& arg1);
  ErrorMsg(TErrorCode::type error, const ArgType& arg0, const ArgType& arg1,
      const ArgType& arg2);
  ErrorMsg(TErrorCode::type error, const ArgType& arg0, const ArgType& arg1,
      const ArgType& arg2, const ArgType& arg3);
  ErrorMsg(TErrorCode::type error, const ArgType& arg0, const ArgType& arg1,
      const ArgType& arg2, const ArgType& arg3, const ArgType& arg4);
  ErrorMsg(TErrorCode::type error, const ArgType& arg0, const ArgType& arg1,
      const ArgType& arg2, const ArgType& arg3, const ArgType& arg4,
      const ArgType& arg5);
  ErrorMsg(TErrorCode::type error, const ArgType& arg0, const ArgType& arg1,
      const ArgType& arg2, const ArgType& arg3, const ArgType& arg4,
      const ArgType& arg5, const ArgType& arg6);
  ErrorMsg(TErrorCode::type error, const ArgType& arg0, const ArgType& arg1,
      const ArgType& arg2, const ArgType& arg3, const ArgType& arg4,
      const ArgType& arg5, const ArgType& arg6, const ArgType& arg7);
  ErrorMsg(TErrorCode::type error, const ArgType& arg0, const ArgType& arg1,
      const ArgType& arg2, const ArgType& arg3, const ArgType& arg4,
      const ArgType& arg5, const ArgType& arg6, const ArgType& arg7,
      const ArgType& arg8);
  ErrorMsg(TErrorCode::type error, const ArgType& arg0, const ArgType& arg1,
      const ArgType& arg2, const ArgType& arg3, const ArgType& arg4,
      const ArgType& arg5, const ArgType& arg6, const ArgType& arg7,
      const ArgType& arg8, const ArgType& arg9);

  ErrorMsg(TErrorCode::type error, const std::vector<string>& detail)
      : error_(error), details_(detail) {}

  static ErrorMsg Init(TErrorCode::type error, const ArgType& arg0 = ArgType::NoArg,
      const ArgType& arg1 = ArgType::NoArg,
      const ArgType& arg2 = ArgType::NoArg,
      const ArgType& arg3 = ArgType::NoArg,
      const ArgType& arg4 = ArgType::NoArg,
      const ArgType& arg5 = ArgType::NoArg,
      const ArgType& arg6 = ArgType::NoArg,
      const ArgType& arg7 = ArgType::NoArg,
      const ArgType& arg8 = ArgType::NoArg,
      const ArgType& arg9 = ArgType::NoArg);

  TErrorCode::type error() const { return error_; }

  void AddDetail(const std::string& d) {
    details_.push_back(d);
  }

  void SetError(TErrorCode::type e) {
    error_ = e;
  }

  const std::string& msg() const {
    return message_;
  }

  const std::vector<std::string>& details() const {
    return details_;
  }

  std::string GetFullMessageDetails() const {
    std::stringstream ss;
    ss << message_ << "\n";
    for(size_t i=0, end=details_.size(); i < end; ++i) {
      ss << details_[i] << "\n";
    }
    return ss.str();
  }

private:
  TErrorCode::type error_;
  std::string message_;
  std::vector<std::string> details_;
};

typedef std::map<TErrorCode::type, TErrorLogEntry> ErrorLogMap;

void MergeErrorMaps(ErrorLogMap* left, const ErrorLogMap& right);

void AppendError(ErrorLogMap* map, const ErrorMsg& e);

void PrintErrorMap(std::ostream* stream, const ErrorLogMap& errors);

size_t ErrorCount(const ErrorLogMap& errors);

std::string PrintErrorMapToString(const ErrorLogMap& errors);

}

#endif