endian.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 <bit>
#include <concepts>
#include <cstdint>
#include <cstring>
#include <type_traits>
 
#include "iceberg/compat/byte_swap.h"
 
 
namespace iceberg {
 
template <typename T>
concept EndianConvertible = std::is_arithmetic_v<T>;
 
template <EndianConvertible T>
constexpr T ByteSwap(T value) {
  if constexpr (sizeof(T) <= 1) {
    return value;
  } else if constexpr (std::is_integral_v<T>) {
    return static_cast<T>(
        internal::ByteSwapUnsigned(static_cast<std::make_unsigned_t<T>>(value)));
  } else if constexpr (std::is_floating_point_v<T>) {
    if constexpr (sizeof(T) == sizeof(uint16_t)) {
      return std::bit_cast<T>(internal::ByteSwapUnsigned(std::bit_cast<uint16_t>(value)));
    } else if constexpr (sizeof(T) == sizeof(uint32_t)) {
      return std::bit_cast<T>(internal::ByteSwapUnsigned(std::bit_cast<uint32_t>(value)));
    } else if constexpr (sizeof(T) == sizeof(uint64_t)) {
      return std::bit_cast<T>(internal::ByteSwapUnsigned(std::bit_cast<uint64_t>(value)));
    } else {
      static_assert(sizeof(T) == 0,
                    "Unsupported floating-point size for endian conversion.");
    }
  }
}
 
template <EndianConvertible T>
constexpr T ToLittleEndian(T value) {
  if constexpr (std::endian::native == std::endian::little) {
    return value;
  } else {
    return ByteSwap(value);
  }
}
 
template <EndianConvertible T>
constexpr T FromLittleEndian(T value) {
  if constexpr (std::endian::native == std::endian::little) {
    return value;
  } else {
    return ByteSwap(value);
  }
}
 
template <EndianConvertible T>
constexpr T ToBigEndian(T value) {
  if constexpr (std::endian::native == std::endian::big) {
    return value;
  } else {
    return ByteSwap(value);
  }
}
 
template <EndianConvertible T>
constexpr T FromBigEndian(T value) {
  if constexpr (std::endian::native == std::endian::big) {
    return value;
  } else {
    return ByteSwap(value);
  }
}
 
template <EndianConvertible T>
void WriteLittleEndian(T value, void* output) {
  auto le = ToLittleEndian(value);
  std::memcpy(output, &le, sizeof(le));
}
 
template <EndianConvertible T>
T ReadLittleEndian(const void* input) {
  T value;
  std::memcpy(&value, input, sizeof(value));
  return FromLittleEndian(value);
}
 
template <EndianConvertible T>
void WriteBigEndian(T value, void* output) {
  auto be = ToBigEndian(value);
  std::memcpy(output, &be, sizeof(be));
}
 
template <EndianConvertible T>
T ReadBigEndian(const void* input) {
  T value;
  std::memcpy(&value, input, sizeof(value));
  return FromBigEndian(value);
}
 
}  // namespace iceberg