nvidia--tensorrt/plugin/common/serialize.hpp

/*
 * SPDX-FileCopyrightText: Copyright (c) 1993-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * 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 <cstring>
#include <stdexcept>
#include <type_traits>
#include <vector>

#include <iostream>
using std::cerr;
using std::cout;
using std::endl;

template <typename T>
inline void serialize_value(void** buffer, T const& value);

template <typename T>
inline void deserialize_value(void const** buffer, size_t* buffer_size, T* value);

namespace
{

template <typename T, class Enable = void>
struct Serializer
{
};

template <typename T>
struct Serializer<T, std::enable_if_t<std::is_arithmetic_v<T> || std::is_enum_v<T> || std::is_pod_v<T>>>
{
    static size_t serialized_size(T const&)
    {
        return sizeof(T);
    }
    static void serialize(void** buffer, T const& value)
    {
        ::memcpy(*buffer, &value, sizeof(T));
        reinterpret_cast<char*&>(*buffer) += sizeof(T);
    }
    static void deserialize(void const** buffer, size_t* buffer_size, T* value)
    {
        if (*buffer_size < sizeof(T))
        {
            throw std::runtime_error("Deserialization error: buffer too small for scalar value");
        }
        ::memcpy(value, *buffer, sizeof(T));
        reinterpret_cast<char const*&>(*buffer) += sizeof(T);
        *buffer_size -= sizeof(T);
    }
};

template <>
struct Serializer<const char*>
{
    static size_t serialized_size(const char* value)
    {
        return strlen(value) + 1;
    }
    static void serialize(void** buffer, const char* value)
    {
        ::strcpy(static_cast<char*>(*buffer), value);
        reinterpret_cast<char*&>(*buffer) += strlen(value) + 1;
    }
    static void deserialize(void const** buffer, size_t* buffer_size, char const** value)
    {
        *value = static_cast<char const*>(*buffer);
        size_t const data_size = strnlen(*value, *buffer_size) + 1;
        if (*buffer_size < data_size)
        {
            throw std::runtime_error("Deserialization error: buffer too small for C string");
        }
        reinterpret_cast<char const*&>(*buffer) += data_size;
        *buffer_size -= data_size;
    }
};

template <typename T>
struct Serializer<std::vector<T>, std::enable_if_t<std::is_arithmetic_v<T> || std::is_enum_v<T> || std::is_pod_v<T>>>
{
    static size_t serialized_size(std::vector<T> const& value)
    {
        return sizeof(value.size()) + value.size() * sizeof(T);
    }
    static void serialize(void** buffer, std::vector<T> const& value)
    {
        serialize_value(buffer, value.size());
        size_t nbyte = value.size() * sizeof(T);
        ::memcpy(*buffer, value.data(), nbyte);
        reinterpret_cast<char*&>(*buffer) += nbyte;
    }
    static void deserialize(void const** buffer, size_t* buffer_size, std::vector<T>* value)
    {
        size_t size;
        deserialize_value(buffer, buffer_size, &size);
        // Single division-based check covers both integer overflow (size*sizeof(T) wraps)
        // and out-of-bounds memcpy, and must happen before resize() to prevent DoS.
        if (size > *buffer_size / sizeof(T))
        {
            throw std::runtime_error("Deserialization error: vector size exceeds available buffer");
        }
        size_t const nbyte = size * sizeof(T);
        value->resize(size);
        ::memcpy(value->data(), *buffer, nbyte);
        reinterpret_cast<char const*&>(*buffer) += nbyte;
        *buffer_size -= nbyte;
    }
};

template <>
struct Serializer<std::string>
{
    static size_t serialized_size(std::string const& value)
    {
        return sizeof(value.size()) + value.size();
    }
    static void serialize(void** buffer, std::string const& value)
    {
        size_t nbyte = value.size();
        serialize_value(buffer, nbyte);
        ::memcpy(*buffer, value.data(), nbyte);
        reinterpret_cast<char*&>(*buffer) += nbyte;
    }
    static void deserialize(void const** buffer, size_t* buffer_size, std::string* value)
    {
        size_t nbyte;
        deserialize_value(buffer, buffer_size, &nbyte);
        if (nbyte > *buffer_size)
        {
            throw std::runtime_error("Deserialization error: string size exceeds available buffer");
        }
        value->resize(nbyte);
        ::memcpy(const_cast<char*>(value->data()), *buffer, nbyte);
        reinterpret_cast<char const*&>(*buffer) += nbyte;
        *buffer_size -= nbyte;
    }
};

} // namespace

template <typename T>
inline size_t serialized_size(T const& value)
{
    return Serializer<T>::serialized_size(value);
}

template <typename T>
inline void serialize_value(void** buffer, T const& value)
{
    return Serializer<T>::serialize(buffer, value);
}

template <typename T>
inline void deserialize_value(void const** buffer, size_t* buffer_size, T* value)
{
    return Serializer<T>::deserialize(buffer, buffer_size, value);
}