nvcomp_adapter.hpp

/*
 * Copyright (c) 2024, NVIDIA CORPORATION.
 *
 * 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.
 */
 
#pragma once
 
#include <cudf/utilities/export.hpp>
 
#include <optional>
#include <string>
 
namespace CUDF_EXPORT cudf {
namespace io::detail::nvcomp {
 
enum class compression_type { SNAPPY, ZSTD, DEFLATE, LZ4, GZIP };
 
struct feature_status_parameters {
  int lib_major_version;                 
  int lib_minor_version;                 
  int lib_patch_version;                 
  bool are_all_integrations_enabled;     
  bool are_stable_integrations_enabled;  
 
  feature_status_parameters();
 
  feature_status_parameters(bool all_enabled, bool stable_enabled);
};
 
inline bool operator==(feature_status_parameters const& lhs, feature_status_parameters const& rhs)
{
  return lhs.lib_major_version == rhs.lib_major_version and
         lhs.lib_minor_version == rhs.lib_minor_version and
         lhs.lib_patch_version == rhs.lib_patch_version and
         lhs.are_all_integrations_enabled == rhs.are_all_integrations_enabled and
         lhs.are_stable_integrations_enabled == rhs.are_stable_integrations_enabled;
}
 
[[nodiscard]] std::optional<std::string> is_compression_disabled(
  compression_type compression, feature_status_parameters params = feature_status_parameters());
 
[[nodiscard]] std::optional<std::string> is_decompression_disabled(
  compression_type compression, feature_status_parameters params = feature_status_parameters());
 
}  // namespace io::detail::nvcomp
}  // namespace CUDF_EXPORT cudf