// Copyright 2021 The TCMalloc Authors
//
// 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
//
//     https://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.

#include "tcmalloc/internal/numa.h"

#include <errno.h>
#include <fcntl.h>
#include <sched.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <unistd.h>

#include <cstring>
#include <optional>

#include "absl/base/attributes.h"
#include "absl/functional/function_ref.h"
#include "tcmalloc/internal/config.h"
#include "tcmalloc/internal/cpu_utils.h"
#include "tcmalloc/internal/environment.h"
#include "tcmalloc/internal/logging.h"
#include "tcmalloc/internal/percpu.h"
#include "tcmalloc/internal/sysinfo.h"
#include "tcmalloc/internal/util.h"

GOOGLE_MALLOC_SECTION_BEGIN
namespace tcmalloc {
namespace tcmalloc_internal {

// Returns true iff NUMA awareness should be enabled by default (i.e. in the
// absence of the TCMALLOC_NUMA_AWARE environment variable). This weak
// implementation may be overridden by the one in want_numa_aware.cc.
ABSL_ATTRIBUTE_WEAK bool default_want_numa_aware() { return false; }

int OpenSysfsCpulist(size_t node) {
  char path[PATH_MAX];
  snprintf(path, sizeof(path), "/sys/devices/system/node/node%zu/cpulist",
           node);
  return signal_safe_open(path, O_RDONLY | O_CLOEXEC);
}

bool InitNumaTopology(size_t cpu_to_scaled_partition[kMaxCpus],
                      uint64_t* const partition_to_nodes,
                      NumaBindMode* const bind_mode,
                      const size_t num_partitions, const size_t scale_by,
                      absl::FunctionRef<int(size_t)> open_node_cpulist,
                      size_t* num_nodes) {
  // Node 0 will always map to partition 0; record it here in case the system
  // doesn't support NUMA or the user opts out of our awareness of it - in
  // either case we'll record nothing in the loop below.

  const char* e =
      tcmalloc::tcmalloc_internal::thread_safe_getenv("TCMALLOC_NUMA_AWARE");

  partition_to_nodes[NodeToPartition(0, num_partitions)] |= 1 << 0;
  *num_nodes = 1;

  // We rely on rseq to quickly obtain a CPU ID & lookup the appropriate
  // partition in NumaTopology::GetCurrentPartition(). If rseq is unavailable,
  // disable NUMA awareness.
  if (!subtle::percpu::IsFast()) return false;

  // Honor default_want_numa_aware() to allow compile time configuration of
  // whether to enable NUMA awareness by default, and allow the user to
  // override that either way by setting TCMALLOC_NUMA_AWARE in the
  // environment.
  bool enabled = true;
  if (e == nullptr) {
    // Enable NUMA awareness iff default_want_numa_aware().
    if (!default_want_numa_aware()) {
      enabled = false;
    }
  } else if (!strcmp(e, "no-binding")) {
    // Enable NUMA awareness with no memory binding behavior.
    *bind_mode = NumaBindMode::kNone;
  } else if (!strcmp(e, "advisory-binding") || !strcmp(e, "1")) {
    // Enable NUMA awareness with advisory memory binding behavior.
    *bind_mode = NumaBindMode::kAdvisory;
  } else if (!strcmp(e, "strict-binding")) {
    // Enable NUMA awareness with strict memory binding behavior.
    *bind_mode = NumaBindMode::kStrict;
  } else if (!strcmp(e, "0")) {
    // Disable NUMA awareness.
    enabled = false;
  } else {
    TC_BUG("bad TCMALLOC_NUMA_AWARE env var '%s'", e);
  }

  // The cpu_to_scaled_partition array has a fixed size so that we can
  // statically allocate it & avoid the need to check whether it has been
  // allocated prior to lookups. It has kMaxCpus entries which ought to be
  // sufficient, but sanity check that indexing it by CPU number shouldn't
  // exceed its bounds.
  int num_cpus = NumCPUs();
  TC_CHECK_LE(num_cpus, kMaxCpus);

  // We could just always report that we're NUMA aware, but if a NUMA-aware
  // binary runs on a system that doesn't include multiple NUMA nodes then our
  // NUMA awareness will offer no benefit whilst incurring the cost of
  // redundant work & stats. As such we only report that we're NUMA aware if
  // there's actually NUMA to be aware of, which we track here.
  bool numa_aware = false;

  for (size_t node = 0;; node++) {
    // Detect NUMA nodes by opening their cpulist files from sysfs.
    const int fd = open_node_cpulist(node);
    if (fd == -1) {
      // We expect to encounter ENOENT once node surpasses the actual number of
      // nodes present in the system. Any other error is a problem.
      TC_CHECK_EQ(errno, ENOENT);
      *num_nodes = node;
      break;
    }

    // Record this node in partition_to_nodes.
    const size_t partition = NodeToPartition(node, num_partitions);
    partition_to_nodes[partition] |= 1 << node;

    // cpu_to_scaled_partition_ entries are default initialized to zero, so
    // skip redundantly parsing CPU lists for nodes that map to partition 0.
    if (partition == 0) {
      signal_safe_close(fd);
      continue;
    }

    // Parse the cpulist file to determine which CPUs are local to this node.
    const std::optional<CpuSet> node_cpus =
        ParseCpulist([&](char* const buf, const size_t count) {
          return signal_safe_read(fd, buf, count, /*bytes_read=*/nullptr);
        });
    // We are on the same side of an airtight hatchway as the kernel, but we
    // want to know if we can no longer parse the values the kernel is
    // providing.
    TC_CHECK(node_cpus.has_value());

    // Assign local CPUs to the appropriate partition.
    for (size_t cpu = 0; cpu < kMaxCpus; cpu++) {
      if (node_cpus->IsSet(cpu)) {
        cpu_to_scaled_partition[cpu + kNumaCpuFudge] = partition * scale_by;
      }
    }

    // If we observed any CPUs for this node then we've now got CPUs assigned
    // to a non-zero partition; report that we're NUMA aware.
    if (node_cpus->Count() != 0) {
      numa_aware = true;
    }

    signal_safe_close(fd);
  }

  return enabled && numa_aware;
}

}  // namespace tcmalloc_internal
}  // namespace tcmalloc
GOOGLE_MALLOC_SECTION_END
