TensorRT-LLMs/cpp/include/tensorrt_llm/common/stringUtils.h

/*
 * Copyright (c) 2021, NVIDIA CORPORATION.  All rights reserved.
 *
 * 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 "tensorrt_llm/common/config.h"
#if ENABLE_BF16
#include <cuda_bf16.h>
#endif // ENABLE_BF16
#include <cuda_fp16.h>

#include <cstdarg>
#include <memory>  // std::make_unique
#include <sstream> // std::stringstream
#include <string>
#include <unordered_set>
#include <vector>

TRTLLM_NAMESPACE_BEGIN

namespace common
{
#if ENABLE_BF16
static inline std::basic_ostream<char>& operator<<(std::basic_ostream<char>& stream, __nv_bfloat16 const& val)
{
    stream << __bfloat162float(val);
    return stream;
}
#endif // ENABLE_BF16

static inline std::basic_ostream<char>& operator<<(std::basic_ostream<char>& stream, __half const& val)
{
    stream << __half2float(val);
    return stream;
}

// Add forward declaration before printElement functions
template <typename... Args>
std::ostream& operator<<(std::ostream& os, std::tuple<Args...> const& t);

namespace
{

// Print element - default case for non-tuple types
template <typename T>
void printElement(std::ostream& os, T const& t)
{
    os << t;
}

// Print tuple implementation
template <typename Tuple, std::size_t... Is>
void printTupleImpl(std::ostream& os, Tuple const& t, std::index_sequence<Is...>)
{
    os << "(";
    ((Is == 0 ? os : (os << ", "), printElement(os, std::get<Is>(t))), ...);
    os << ")";
}

// Print element - specialized for tuples
template <typename... Args>
void printElement(std::ostream& os, std::tuple<Args...> const& t)
{
    printTupleImpl(os, t, std::index_sequence_for<Args...>{});
}

class va_list_guard
{
public:
    explicit va_list_guard(va_list& args)
        : mArgs(args)
    {
    }

    ~va_list_guard()
    {
        va_end(mArgs);
    }

    va_list_guard(va_list_guard const&) = delete;
    va_list_guard& operator=(va_list_guard const&) = delete;
    va_list_guard(va_list_guard&&) = delete;
    va_list_guard& operator=(va_list_guard&&) = delete;

private:
    va_list& mArgs;
};

} // namespace

// Override operator<< for any tuple
template <typename... Args>
std::ostream& operator<<(std::ostream& os, std::tuple<Args...> const& t)
{
    printElement(os, t);
    return os;
}

template <typename... Args>
std::string to_string(std::tuple<Args...> const& t)
{
    std::stringstream ss;
    ss << t;
    return ss.str();
}

inline std::string fmtstr(std::string const& s)
{
    return s;
}

inline std::string fmtstr(std::string&& s)
{
    return s;
}

typedef char* (*fmtstr_allocator)(void* target, size_t count);
void fmtstr_(char const* format, fmtstr_allocator alloc, void* target, va_list args);

#if defined(_MSC_VER)
inline std::string fmtstr(char const* format, ...);
#else
inline std::string fmtstr(char const* format, ...) __attribute__((format(printf, 1, 2)));
#endif

inline std::string fmtstr(char const* format, ...)
{
    std::string result;

    va_list args;
    va_start(args, format);
    va_list_guard args_guard(args);

    fmtstr_(
        format,
        [](void* target, size_t count) -> char*
        {
            if (count <= 0)
            {
                return nullptr;
            }

            const auto str = static_cast<std::string*>(target);
            str->resize(count);
            return str->data();
        },
        &result, args);

    return result;
}

// __PRETTY_FUNCTION__ is used for neat debugging printing but is not supported on Windows
// The alternative is __FUNCSIG__, which is similar but not identical
#if defined(_WIN32)
#define __PRETTY_FUNCTION__ __FUNCSIG__
#endif

auto constexpr kDefaultDelimiter = ", ";

template <typename U, typename TStream, typename T>
inline TStream& arr2outCasted(TStream& out, T* arr, size_t size, char const* delim = kDefaultDelimiter)
{
    out << "(";
    if (size > 0)
    {
        for (size_t i = 0; i < size - 1; ++i)
        {
            out << static_cast<U>(arr[i]) << delim;
        }
        out << static_cast<U>(arr[size - 1]);
    }
    out << ")";
    return out;
}

template <typename TStream, typename T>
inline TStream& arr2out(TStream& out, T* arr, size_t size, char const* delim = kDefaultDelimiter)
{
    return arr2outCasted<T>(out, arr, size, delim);
}

template <typename T>
inline std::string arr2str(T* arr, size_t size, char const* delim = kDefaultDelimiter)
{
    std::stringstream ss;
    return arr2out(ss, arr, size, delim).str();
}

template <typename T>
inline std::string vec2str(std::vector<T> const& vec, char const* delim = kDefaultDelimiter)
{
    return arr2str(vec.data(), vec.size(), delim);
}

inline bool strStartsWith(std::string const& str, std::string const& prefix)
{
    return str.rfind(prefix, 0) == 0;
}

/// @brief Split a string into a set of strings using a delimiter
std::unordered_set<std::string> str2set(std::string const& input, char delimiter);

/// @brief Convert string to lower-case (inplace)
inline void toLower(std::string& s)
{
    for (char& c : s)
    {
        c = std::tolower(static_cast<unsigned char>(c));
    }
}

/// @brief Convert string to upper-case (inplace)
inline void toUpper(std::string& s)
{
    for (char& c : s)
    {
        c = std::toupper(static_cast<unsigned char>(c));
    }
}

} // namespace common

TRTLLM_NAMESPACE_END