compiler/profile_assistant.h

/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * 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 ART_COMPILER_PROFILE_ASSISTANT_H_
#define ART_COMPILER_PROFILE_ASSISTANT_H_

#include <string>
#include <vector>

#include "jit/offline_profiling_info.cc"

namespace art {

class ProfileAssistant {
 public:
  // Process the profile information present in the given files. Returns true
  // if the analysis ended up successfully (i.e. no errors during reading,
  // merging or writing of profile files).
  //
  // If the returned value is true and there is a significant difference between
  // profile_files and reference_profile_files:
  //   - profile_compilation_info is set to a not null object that
  //     can be used to drive compilation. It will be the merge of all the data
  //     found in profile_files and reference_profile_files.
  //   - the data from profile_files[i] is merged into
  //     reference_profile_files[i] and the corresponding backing file is
  //     updated.
  //
  // If the returned value is false or the difference is insignificant,
  // profile_compilation_info will be set to null.
  //
  // Additional notes:
  //   - as mentioned above, this function may update the content of the files
  //     passed with the reference_profile_files.
  //   - if reference_profile_files is not empty it must be the same size as
  //     profile_files.
  static bool ProcessProfiles(
      const std::vector<std::string>& profile_files,
      const std::vector<std::string>& reference_profile_files,
      /*out*/ ProfileCompilationInfo** profile_compilation_info);

 private:
  DISALLOW_COPY_AND_ASSIGN(ProfileAssistant);
};

}  // namespace art

#endif  // ART_COMPILER_PROFILE_ASSISTANT_H_