src/lib/fsl/handles/object_info_unittest.cc

// Copyright 2016 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "src/lib/fsl/handles/object_info.h"

#include <lib/zx/channel.h>
#include <lib/zx/event.h>
#include <lib/zx/vmo.h>
#include <zircon/process.h>
#include <zircon/syscalls/object.h>
#include <zircon/threads.h>

#include <thread>

#include <gtest/gtest.h>

namespace fsl {
namespace {

TEST(ObjectInfo, GetKoidOfInvalidHandle) { EXPECT_EQ(ZX_KOID_INVALID, GetKoid(ZX_HANDLE_INVALID)); }

TEST(ObjectInfo, GetKoidOfDistinctObjects) {
  zx::event event1, event2;
  ASSERT_EQ(ZX_OK, zx::event::create(0u, &event1));
  ASSERT_EQ(ZX_OK, zx::event::create(0u, &event2));

  EXPECT_NE(ZX_KOID_INVALID, GetKoid(event1.get()));
  EXPECT_NE(ZX_KOID_INVALID, GetKoid(event2.get()));
  EXPECT_NE(GetKoid(event1.get()), GetKoid(event2.get()));
}

TEST(ObjectInfo, GetKoidOfDuplicates) {
  zx::event event1, event2;
  ASSERT_EQ(ZX_OK, zx::event::create(0u, &event1));
  ASSERT_EQ(ZX_OK, event1.duplicate(ZX_RIGHT_SAME_RIGHTS, &event2));

  EXPECT_NE(ZX_KOID_INVALID, GetKoid(event1.get()));
  EXPECT_EQ(GetKoid(event1.get()), GetKoid(event2.get()));
}

TEST(ObjectInfo, GetRelatedKoidOfChannel) {
  zx::channel channel1, channel2;
  ASSERT_EQ(ZX_OK, zx::channel::create(0u, &channel1, &channel2));
  EXPECT_NE(ZX_KOID_INVALID, GetKoid(channel1.get()));
  EXPECT_NE(ZX_KOID_INVALID, GetKoid(channel2.get()));

  EXPECT_EQ(GetKoid(channel2.get()), GetRelatedKoid(channel1.get()));
  EXPECT_EQ(GetKoid(channel1.get()), GetRelatedKoid(channel2.get()));
}

TEST(ObjectInfo, GetType) {
  zx::event event;
  ASSERT_EQ(ZX_OK, zx::event::create(0u, &event));
  EXPECT_EQ(ZX_OBJ_TYPE_EVENT, GetType(event.get()));

  zx::channel channel1, channel2;
  ASSERT_EQ(ZX_OK, zx::channel::create(0u, &channel1, &channel2));
  EXPECT_EQ(ZX_OBJ_TYPE_CHANNEL, GetType(channel1.get()));
  EXPECT_EQ(ZX_OBJ_TYPE_CHANNEL, GetType(channel2.get()));
}

TEST(ObjectInfo, GetRelatedKoidOfChannelWithClosedEndpoint) {
  zx::channel channel1;
  zx_handle_t invalid_channel2_handle;
  {
    zx::channel channel2;
    ASSERT_EQ(ZX_OK, zx::channel::create(0u, &channel1, &channel2));
    invalid_channel2_handle = channel2.get();
  }

  EXPECT_NE(ZX_KOID_INVALID, GetKoid(channel1.get()));
  EXPECT_NE(ZX_KOID_INVALID, GetRelatedKoid(channel1.get()));
  EXPECT_EQ(ZX_KOID_INVALID, GetKoid(invalid_channel2_handle));
  EXPECT_EQ(ZX_KOID_INVALID, GetRelatedKoid(invalid_channel2_handle));
}

TEST(ObjectInfo, GetRelatedKoidOfEvent) {
  zx::event event1;
  ASSERT_EQ(ZX_OK, zx::event::create(0u, &event1));
  EXPECT_NE(ZX_KOID_INVALID, GetKoid(event1.get()));
  EXPECT_EQ(ZX_KOID_INVALID, GetRelatedKoid(event1.get()));
}

TEST(ObjectInfo, GetKoidsOfInvalidHandle) {
  constexpr std::pair<zx_koid_t, zx_koid_t> invalid_koids(ZX_KOID_INVALID, ZX_KOID_INVALID);

  EXPECT_EQ(invalid_koids, GetKoids(ZX_HANDLE_INVALID));
}

TEST(ObjectInfo, GetKoidsOfChannel) {
  zx::channel channel1, channel2;
  ASSERT_EQ(ZX_OK, zx::channel::create(0u, &channel1, &channel2));

  const std::pair<zx_koid_t, zx_koid_t> channel1_koids = GetKoids(channel1.get());
  const std::pair<zx_koid_t, zx_koid_t> channel2_koids = GetKoids(channel2.get());
  EXPECT_NE(ZX_KOID_INVALID, channel1_koids.first);
  EXPECT_NE(ZX_KOID_INVALID, channel2_koids.first);
  EXPECT_EQ(channel1_koids.first, channel2_koids.second);
  EXPECT_EQ(channel1_koids.second, channel2_koids.first);
}

TEST(ObjectInfo, GetKoidsOfChannelWithClosedEndpoint) {
  zx::channel channel1;
  zx_handle_t invalid_channel2_handle;
  {
    zx::channel channel2;
    ASSERT_EQ(ZX_OK, zx::channel::create(0u, &channel1, &channel2));
    invalid_channel2_handle = channel2.get();
  }

  const std::pair<zx_koid_t, zx_koid_t> channel1_koids = GetKoids(channel1.get());
  const std::pair<zx_koid_t, zx_koid_t> channel2_koids = GetKoids(invalid_channel2_handle);
  EXPECT_NE(ZX_KOID_INVALID, channel1_koids.first);
  EXPECT_NE(ZX_KOID_INVALID, channel1_koids.second);
  EXPECT_EQ(ZX_KOID_INVALID, channel2_koids.first);
  EXPECT_EQ(ZX_KOID_INVALID, channel2_koids.second);
}

TEST(ObjectInfo, GetKoidsOfEvent) {
  zx::event event;
  ASSERT_EQ(ZX_OK, zx::event::create(0u, &event));

  const std::pair<zx_koid_t, zx_koid_t> event_koids = GetKoids(event.get());
  EXPECT_NE(ZX_KOID_INVALID, event_koids.first);
  EXPECT_EQ(ZX_KOID_INVALID, event_koids.second);
}

TEST(ObjectInfo, GetNameOfInvalidHandle) {
  EXPECT_EQ(std::string(), GetObjectName(ZX_HANDLE_INVALID));
}

TEST(ObjectInfo, SetNameOfInvalidHandle) {
  EXPECT_EQ(ZX_ERR_BAD_HANDLE, SetObjectName(ZX_HANDLE_INVALID, "foo"));
}

TEST(ObjectInfo, GetCurrentProcessKoid) { EXPECT_NE(ZX_KOID_INVALID, GetCurrentProcessKoid()); }

TEST(ObjectInfo, GetAndSetNameOfCurrentProcess) {
  zx_handle_t process_handle = zx_process_self();
  std::string old_name = GetObjectName(process_handle);
  std::string new_name = "set-process-name-test";

  EXPECT_EQ(ZX_OK, SetObjectName(process_handle, new_name));
  EXPECT_EQ(new_name, GetObjectName(process_handle));
  EXPECT_EQ(new_name, GetCurrentProcessName());

  SetObjectName(process_handle, old_name);
}

TEST(ObjectInfo, GetCurrentThreadKoid) {
  zx_koid_t self_koid = GetCurrentThreadKoid();
  EXPECT_NE(ZX_KOID_INVALID, self_koid);

  zx_koid_t thread_koid = ZX_KOID_INVALID;
  std::thread thread([&thread_koid] { thread_koid = GetCurrentThreadKoid(); });
  thread.join();

  EXPECT_NE(ZX_KOID_INVALID, thread_koid);
  EXPECT_NE(self_koid, thread_koid);
}

TEST(ObjectInfo, GetAndSetNameOfCurrentThread) {
  std::string old_name = GetCurrentThreadName();
  std::string new_name = "set-thread-name-test";

  EXPECT_EQ(ZX_OK, SetCurrentThreadName(new_name));
  EXPECT_EQ(new_name, GetCurrentThreadName());

  SetCurrentThreadName(old_name);
}

TEST(ObjectInfo, GetCurrentThreadTotalRuntime) {
  zx::duration result = GetCurrentThreadTotalRuntime();
  EXPECT_NE(0u, result.get());
}

TEST(ObjectInfo, GetCurrentProcessMemoryMappedBytes) {
  size_t result = GetCurrentProcessMemoryMappedBytes();
  EXPECT_NE(0u, result);
}

TEST(ObjectInfo, GetCurrentProcessMemoryPrivateBytes) {
  size_t result = GetCurrentProcessMemoryPrivateBytes();
  EXPECT_NE(0u, result);
}

TEST(ObjectInfo, GetCurrentProcessMemorySharedBytes) {
  // Expect this not to blow up.
  GetCurrentProcessMemorySharedBytes();
}

TEST(ObjectInfo, GetCurrentProcessMemoryScaledSharedBytes) {
  // Expect this not to blow up.
  GetCurrentProcessMemoryScaledSharedBytes();
}

TEST(ObjectInfo, MaybeSetVmoName) {
  zx::vmo vmo;
  ASSERT_EQ(zx::vmo::create(1, 0, &vmo), ZX_OK);
  auto name = GetObjectName(vmo.get());
  EXPECT_TRUE(name.empty());
  constexpr auto kName1 = "Foo";
  constexpr auto kName2 = "Bar";
  EXPECT_TRUE(MaybeSetObjectName(vmo.get(), kName1));
  EXPECT_EQ(GetObjectName(vmo.get()), kName1);
  EXPECT_FALSE(MaybeSetObjectName(vmo.get(), kName2));
  EXPECT_EQ(GetObjectName(vmo.get()), kName1);
  EXPECT_FALSE(MaybeSetObjectName(vmo.get(), kName2, [=](std::string current_name) {
    EXPECT_EQ(current_name, kName1);
    return false;
  }));
  EXPECT_EQ(GetObjectName(vmo.get()), kName1);
  EXPECT_TRUE(MaybeSetObjectName(vmo.get(), kName2, [=](std::string current_name) {
    EXPECT_EQ(current_name, kName1);
    return true;
  }));
  EXPECT_EQ(GetObjectName(vmo.get()), kName2);
}

}  // namespace
}  // namespace fsl