/*
 * Copyright (C) 2021 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 INCLUDE_PERFETTO_EXT_BASE_ANDROID_UTILS_H_
#define INCLUDE_PERFETTO_EXT_BASE_ANDROID_UTILS_H_

#include <cstdint>
#include <optional>
#include <string>

#include "perfetto/base/build_config.h"

namespace perfetto {
namespace base {

#if PERFETTO_BUILDFLAG(PERFETTO_OS_ANDROID)

// Returns the value of the Android system property named `name`. If the
// property does not exist, returns an empty string (a non-existing property is
// the same as a property with an empty value for this API).
std::string GetAndroidProp(const char* name);

#endif  // PERFETTO_BUILDFLAG(PERFETTO_OS_ANDROID)

struct Utsname {
  std::string sysname;
  std::string version;
  std::string machine;
  std::string release;
};

struct SystemInfo {
  std::optional<int32_t> timezone_off_mins;
  std::optional<Utsname> utsname_info;
  std::optional<uint32_t> page_size;
  std::optional<uint32_t> num_cpus;
  std::optional<uint64_t> system_ram_bytes;
  std::string android_build_fingerprint;
  std::string android_device_manufacturer;
  std::optional<uint64_t> android_sdk_version;
  std::string android_soc_model;
  std::string android_guest_soc_model;
  std::string android_hardware_revision;
  std::string android_storage_model;
  std::string android_ram_model;
  std::string android_serial_console;
};

// Returns the device's utsname information.
Utsname GetUtsname();

// Returns the device's system information.
SystemInfo GetSystemInfo();

// Returns the perfetto machine name. The PERFETTO_MACHINE_NAME env variable
// has the highest precedence in setting the machine name. In Android systems,
// if the env variable isn't set then the traced.machine_name system property
// is used. If no value is externally set, then the OS system name
// (see `uname -s`) is used as the default machine name.
std::string GetPerfettoMachineName();

}  // namespace base
}  // namespace perfetto

#endif  // INCLUDE_PERFETTO_EXT_BASE_ANDROID_UTILS_H_
