Skip to content

Commit

Permalink
Drop support for deprecated command-line arguments and environment va…
Browse files Browse the repository at this point in the history 
…riables (kokkos#6744)

* Drop support for deprecated cmdline args and env vars

* Deprecate num_devices and skip_device in InitializationSettings

* Fixup rm now unused get_flag utility lambda
  • Loading branch information
@dalg24
dalg24 committed Jan 25, 2024
1 parent e1415f8 commit d560c47
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 208 deletions.
160 changes: 8 additions & 152 deletions core/src/impl/Kokkos_Core.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,6 @@ void combine(Kokkos::InitializationSettings& out,
KOKKOS_IMPL_COMBINE_SETTING(num_threads);
KOKKOS_IMPL_COMBINE_SETTING(map_device_id_by);
KOKKOS_IMPL_COMBINE_SETTING(device_id);
KOKKOS_IMPL_COMBINE_SETTING(num_devices);
KOKKOS_IMPL_COMBINE_SETTING(skip_device);
KOKKOS_IMPL_COMBINE_SETTING(disable_warnings);
KOKKOS_IMPL_COMBINE_SETTING(tune_internals);
KOKKOS_IMPL_COMBINE_SETTING(tools_help);
Expand Down Expand Up @@ -317,8 +315,7 @@ int Kokkos::Impl::get_ctest_gpu(int local_rank) {
return std::stoi(id.c_str());
}

std::vector<int> Kokkos::Impl::get_visible_devices(
Kokkos::InitializationSettings const& settings, int device_count) {
std::vector<int> Kokkos::Impl::get_visible_devices(int device_count) {
std::vector<int> visible_devices;
char* env_visible_devices = std::getenv("KOKKOS_VISIBLE_DEVICES");
if (env_visible_devices) {
Expand All @@ -345,30 +342,9 @@ std::vector<int> Kokkos::Impl::get_visible_devices(
}
}
} else {
int num_devices =
settings.has_num_devices() ? settings.get_num_devices() : device_count;
if (num_devices > device_count) {
std::stringstream ss;
ss << "Error: Specified number of devices '" << num_devices
<< "' exceeds the actual number of GPUs available for execution '"
<< device_count << "'."
<< " Raised by Kokkos::initialize().\n";
Kokkos::abort(ss.str().c_str());
}
for (int i = 0; i < num_devices; ++i) {
for (int i = 0; i < device_count; ++i) {
visible_devices.push_back(i);
}
if (settings.has_skip_device()) {
if (visible_devices.size() == 1 && settings.get_skip_device() == 0) {
Kokkos::abort(
"Error: skipping the only GPU available for execution.\n"
" Raised by Kokkos::initialize().\n");
}
visible_devices.erase(
std::remove(visible_devices.begin(), visible_devices.end(),
settings.get_skip_device()),
visible_devices.end());
}
}
if (visible_devices.empty()) {
Kokkos::abort(
Expand All @@ -379,9 +355,8 @@ std::vector<int> Kokkos::Impl::get_visible_devices(
}

int Kokkos::Impl::get_gpu(const InitializationSettings& settings) {
std::vector<int> visible_devices =
get_visible_devices(settings, get_device_count());
int const num_devices = visible_devices.size();
std::vector<int> visible_devices = get_visible_devices(get_device_count());
int const num_devices = visible_devices.size();
// device_id is provided
if (settings.has_device_id()) {
int const id = settings.get_device_id();
Expand Down Expand Up @@ -920,36 +895,18 @@ void Kokkos::Impl::parse_command_line_arguments(

int num_threads;
int device_id;
int num_devices; // deprecated
int skip_device; // deprecated
std::string map_device_id_by;
bool disable_warnings;
bool print_configuration;
bool tune_internals;

auto get_flag = [](std::string s) -> std::string {
return s.erase(s.find('='));
};

bool help_flag = false;

int iarg = 0;
while (iarg < argc) {
bool remove_flag = false;

if (check_arg(argv[iarg], "--kokkos-numa") ||
check_arg(argv[iarg], "--numa")) {
warn_deprecated_command_line_argument(get_flag(argv[iarg]));
// remove flag if prefixed with '--kokkos-'
remove_flag = std::string(argv[iarg]).find("--kokkos-") == 0;
} else if (check_arg_int(argv[iarg], "--kokkos-num-threads", num_threads) ||
check_arg_int(argv[iarg], "--num-threads", num_threads) ||
check_arg_int(argv[iarg], "--kokkos-threads", num_threads) ||
check_arg_int(argv[iarg], "--threads", num_threads)) {
if (get_flag(argv[iarg]) != "--kokkos-num-threads") {
warn_deprecated_command_line_argument(get_flag(argv[iarg]),
"--kokkos-num-threads");
}
if (check_arg_int(argv[iarg], "--kokkos-num-threads", num_threads)) {
if (!is_valid_num_threads(num_threads)) {
std::stringstream ss;
ss << "Error: command line argument '" << argv[iarg] << "' is invalid."
Expand All @@ -958,15 +915,8 @@ void Kokkos::Impl::parse_command_line_arguments(
Kokkos::abort(ss.str().c_str());
}
settings.set_num_threads(num_threads);
remove_flag = std::string(argv[iarg]).find("--kokkos-") == 0;
} else if (check_arg_int(argv[iarg], "--kokkos-device-id", device_id) ||
check_arg_int(argv[iarg], "--device-id", device_id) ||
check_arg_int(argv[iarg], "--kokkos-device", device_id) ||
check_arg_int(argv[iarg], "--device", device_id)) {
if (get_flag(argv[iarg]) != "--kokkos-device-id") {
warn_deprecated_command_line_argument(get_flag(argv[iarg]),
"--kokkos-device-id");
}
remove_flag = true;
} else if (check_arg_int(argv[iarg], "--kokkos-device-id", device_id)) {
if (!is_valid_device_id(device_id)) {
std::stringstream ss;
ss << "Error: command line argument '" << argv[iarg] << "' is invalid."
Expand All @@ -975,70 +925,7 @@ void Kokkos::Impl::parse_command_line_arguments(
Kokkos::abort(ss.str().c_str());
}
settings.set_device_id(device_id);
remove_flag = std::string(argv[iarg]).find("--kokkos-") == 0;
} else if (check_arg(argv[iarg], "--kokkos-num-devices") ||
check_arg(argv[iarg], "--num-devices") ||
check_arg(argv[iarg], "--kokkos-ndevices") ||
check_arg(argv[iarg], "--ndevices")) {
if (check_arg(argv[iarg], "--num-devices")) {
warn_deprecated_command_line_argument("--num-devices",
"--kokkos-num-devices");
}
if (check_arg(argv[iarg], "--ndevices")) {
warn_deprecated_command_line_argument("--ndevices",
"--kokkos-num-devices");
}
if (check_arg(argv[iarg], "--kokkos-ndevices")) {
warn_deprecated_command_line_argument("--kokkos-ndevices",
"--kokkos-num-devices");
}
warn_deprecated_command_line_argument(
"--kokkos-num-devices", "--kokkos-map-device-id-by=mpi_rank");
// Find the number of device (expecting --device=XX)
if (!((strncmp(argv[iarg], "--kokkos-num-devices=", 21) == 0) ||
(strncmp(argv[iarg], "--num-devices=", 14) == 0) ||
(strncmp(argv[iarg], "--kokkos-ndevices=", 18) == 0) ||
(strncmp(argv[iarg], "--ndevices=", 11) == 0)))
throw_runtime_exception(
"Error: expecting an '=INT[,INT]' after command line argument "
"'--kokkos-num-devices'."
" Raised by Kokkos::initialize().");

char* num1 = strchr(argv[iarg], '=') + 1;
char* num2 = strpbrk(num1, ",");
int num1_len = num2 == nullptr ? strlen(num1) : num2 - num1;
char* num1_only = new char[num1_len + 1];
strncpy(num1_only, num1, num1_len);
num1_only[num1_len] = '\0';

if (!is_unsigned_int(num1_only) || (strlen(num1_only) == 0)) {
throw_runtime_exception(
"Error: expecting an integer number after command line argument "
"'--kokkos-num-devices'."
" Raised by Kokkos::initialize().");
}
if (check_arg(argv[iarg], "--kokkos-num-devices") ||
check_arg(argv[iarg], "--kokkos-ndevices")) {
num_devices = std::stoi(num1_only);
settings.set_num_devices(num_devices);
settings.set_map_device_id_by("mpi_rank");
}
delete[] num1_only;

if (num2 != nullptr) {
if ((!is_unsigned_int(num2 + 1)) || (strlen(num2) == 1))
throw_runtime_exception(
"Error: expecting an integer number after command line argument "
"'--kokkos-num-devices=XX,'."
" Raised by Kokkos::initialize().");

if (check_arg(argv[iarg], "--kokkos-num-devices") ||
check_arg(argv[iarg], "--kokkos-ndevices")) {
skip_device = std::stoi(num2 + 1);
settings.set_skip_device(skip_device);
}
}
remove_flag = std::string(argv[iarg]).find("--kokkos-") == 0;
remove_flag = true;
} else if (check_arg_bool(argv[iarg], "--kokkos-disable-warnings",
disable_warnings)) {
settings.set_disable_warnings(disable_warnings);
Expand Down Expand Up @@ -1107,9 +994,6 @@ void Kokkos::Impl::parse_environment_variables(
}
combine(settings, tools_init_arguments);

if (std::getenv("KOKKOS_NUMA")) {
warn_deprecated_environment_variable("KOKKOS_NUMA");
}
int num_threads;
if (check_env_int("KOKKOS_NUM_THREADS", num_threads)) {
if (!is_valid_num_threads(num_threads)) {
Expand All @@ -1134,34 +1018,6 @@ void Kokkos::Impl::parse_environment_variables(
}
settings.set_device_id(device_id);
}
int num_devices;
int rand_devices;
bool has_num_devices = check_env_int("KOKKOS_NUM_DEVICES", num_devices);
bool has_rand_devices = check_env_int("KOKKOS_RAND_DEVICES", rand_devices);
if (has_rand_devices && has_num_devices) {
Impl::throw_runtime_exception(
"Error: cannot specify both KOKKOS_NUM_DEVICES and "
"KOKKOS_RAND_DEVICES."
" Raised by Kokkos::initialize().");
}
if (has_num_devices) {
warn_deprecated_environment_variable("KOKKOS_NUM_DEVICES",
"KOKKOS_MAP_DEVICE_ID_BY=mpi_rank");
settings.set_map_device_id_by("mpi_rank");
settings.set_num_devices(num_devices);
}
if (has_rand_devices) {
warn_deprecated_environment_variable("KOKKOS_RAND_DEVICES",
"KOKKOS_MAP_DEVICE_ID_BY=random");
settings.set_map_device_id_by("random");
settings.set_num_devices(rand_devices);
}
if (has_num_devices || has_rand_devices) {
int skip_device;
if (check_env_int("KOKKOS_SKIP_DEVICE", skip_device)) {
settings.set_skip_device(skip_device);
}
}
bool disable_warnings;
if (check_env_bool("KOKKOS_DISABLE_WARNINGS", disable_warnings)) {
settings.set_disable_warnings(disable_warnings);
Expand Down
3 changes: 1 addition & 2 deletions core/src/impl/Kokkos_DeviceManagement.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ int get_gpu(const Kokkos::InitializationSettings& settings);
// This declaration is provided for testing purposes only
int get_ctest_gpu(int local_rank);
// ditto
std::vector<int> get_visible_devices(
Kokkos::InitializationSettings const& settings, int device_count);
std::vector<int> get_visible_devices(int device_count);
} // namespace Impl
} // namespace Kokkos

Expand Down
24 changes: 22 additions & 2 deletions core/src/impl/Kokkos_InitializationSettings.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,32 @@ class InitializationSettings {
TYPE get_##NAME() const noexcept { return *m_##NAME; } \
static_assert(true, "no-op to require trailing semicolon")

#ifdef KOKKOS_ENABLE_DEPRECATED_CODE_4
#define KOKKOS_IMPL_DECLARE_DEPRECATED(TYPE, NAME) \
private: \
std::optional<TYPE> m_##NAME; \
\
public: \
KOKKOS_DEPRECATED InitializationSettings& set_##NAME(TYPE NAME) { \
m_##NAME = NAME; \
return *this; \
} \
KOKKOS_DEPRECATED bool has_##NAME() const noexcept { \
return static_cast<bool>(m_##NAME); \
} \
KOKKOS_DEPRECATED TYPE get_##NAME() const noexcept { return *m_##NAME; } \
static_assert(true, "no-op to require trailing semicolon")
#else
#define KOKKOS_IMPL_DECLARE_DEPRECATED(TYPE, NAME) \
static_assert(true, "no-op to require trailing semicolon")
#endif

public:
KOKKOS_IMPL_DECLARE(int, num_threads);
KOKKOS_IMPL_DECLARE(int, device_id);
KOKKOS_IMPL_DECLARE(std::string, map_device_id_by);
KOKKOS_IMPL_DECLARE(int, num_devices); // deprecated
KOKKOS_IMPL_DECLARE(int, skip_device); // deprecated
KOKKOS_IMPL_DECLARE_DEPRECATED(int, num_devices);
KOKKOS_IMPL_DECLARE_DEPRECATED(int, skip_device);
KOKKOS_IMPL_DECLARE(bool, disable_warnings);
KOKKOS_IMPL_DECLARE(bool, print_configuration);
KOKKOS_IMPL_DECLARE(bool, tune_internals);
Expand Down
4 changes: 0 additions & 4 deletions core/unit_test/TestInitializationSettings.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@ TEST(defaultdevicetype, initialization_settings) {
EXPECT_TRUE(settings.has_num_threads());
EXPECT_EQ(settings.get_num_threads(), 255);
EXPECT_FALSE(settings.has_device_id());
EXPECT_FALSE(settings.has_num_devices());
EXPECT_FALSE(settings.has_skip_device());
EXPECT_TRUE(settings.has_disable_warnings());
EXPECT_FALSE(settings.get_disable_warnings());
EXPECT_FALSE(settings.has_tune_internals());
Expand All @@ -51,8 +49,6 @@ constexpr bool test_initialization_settings_getter() {
TYPE>::value);
CHECK_INITIALIZATION_SETTINGS_GETTER_RETURN_TYPE(num_threads, int);
CHECK_INITIALIZATION_SETTINGS_GETTER_RETURN_TYPE(device_id, int);
CHECK_INITIALIZATION_SETTINGS_GETTER_RETURN_TYPE(num_devices, int);
CHECK_INITIALIZATION_SETTINGS_GETTER_RETURN_TYPE(skip_device, int);
CHECK_INITIALIZATION_SETTINGS_GETTER_RETURN_TYPE(disable_warnings, bool);
CHECK_INITIALIZATION_SETTINGS_GETTER_RETURN_TYPE(tune_internals, bool);
CHECK_INITIALIZATION_SETTINGS_GETTER_RETURN_TYPE(tools_help, bool);
Expand Down

0 comments on commit d560c47

Please sign in to comment.