抽取目录转宽字符代码为独立函数后失效的问题排查

问题背景与错误分析 #

原工作代码在函数内直接使用栈数组存储转换后的宽字符路径，逻辑正常：

// 在list_directory_contents函数内
// Convert directory name to wide-character string
u16  dir_address[268];  
u64 dest;               
int errorD = mbstowcs_s(&dest, dir_address, 268, directory, 268);

尝试抽取成独立函数时，出现两类核心错误：

1. 返回单个u16的逻辑错误 #

最初错误地将函数声明为返回单个无符号16位整数，完全不符合mbstowcs_s的需求：

// .h中的错误声明
u16 get_absolute_path(char *directory);

// .c中的错误实现
u16 get_absolute_path(char *directory) {
    u16 return_address; 
    u64 dest;
    // Clang提示加&，但修改后仍无效
    int errorDir = mbstowcs_s(&dest, &return_address, 268, directory, 268);
    return return_address;
}

// 错误调用
u16 dir_address = get_absolute_path(directory);

错误原因：mbstowcs_s需要写入一个宽字符数组来存储完整路径，单个u16只能容纳一个宽字符，根本无法存储路径字符串，逻辑上完全不成立。

2. 返回栈数组的野指针问题 #

改成返回栈数组时，触发编译器警告：

u16 get_absolute_path(char *directory) {
    u16 return_address[268];    
    u64 dest;
    int errorDir = mbstowcs_s(&dest, return_address, 268, directory, 268);
    return return_address; // 警告：返回栈上局部变量的地址
}

错误原因：函数内的局部数组分配在栈帧上，函数返回后栈帧被销毁，该数组内存会被后续操作覆盖，返回的地址成为无效野指针，属于未定义行为。

正确实现方案 #

针对返回字符串的场景，有两种可靠的实现方式：

方案1：调用者提供目标数组 #

让调用者负责分配内存（栈或堆），函数接收数组指针和长度，内存生命周期由调用者控制：

// .h声明
// 返回转换错误码，方便调用者处理异常
int get_absolute_path(char *directory, u16 *dest_buf, size_t buf_size);

// .c实现
int get_absolute_path(char *directory, u16 *dest_buf, size_t buf_size) {
    u64 converted_count;
    // 预留位置给宽字符终止符\0
    int error = mbstowcs_s(&converted_count, dest_buf, buf_size, directory, buf_size - 1);
    return error;
}

// 调用示例（与原代码逻辑一致，使用栈数组）
u16 dir_address[268];
int error = get_absolute_path(directory, dir_address, sizeof(dir_address)/sizeof(u16));
if (error != 0) {
    // 处理转换错误（如路径过长、编码不兼容等）
}

这种方式无内存泄漏风险，完全匹配原代码的使用习惯。

方案2：函数内部动态分配内存 #

如果需要函数直接返回字符串，可在堆上分配内存，返回指针，但必须提醒调用者手动释放：

// .h声明
u16* get_absolute_path(char *directory);

// .c实现
u16* get_absolute_path(char *directory) {
    const size_t buf_size = 268;
    u16 *return_address = malloc(buf_size * sizeof(u16));
    if (return_address == NULL) {
        // 处理内存分配失败
        return NULL;
    }
    u64 converted_count;
    int errorDir = mbstowcs_s(&converted_count, return_address, buf_size, directory, buf_size - 1);
    if (errorDir != 0) {
        // 转换失败，释放已分配内存避免泄漏
        free(return_address);
        return NULL;
    }
    return return_address;
}

// 调用示例
u16 *dir_address = get_absolute_path(directory);
if (dir_address != NULL) {
    // 使用路径
    free(dir_address); // 必须手动释放，避免内存泄漏
}

额外注意点 #

• mbstowcs_s的最后一个参数建议传入buf_size - 1，预留位置给宽字符串终止符\0。
• 从u16的定义来看，代码针对Windows平台（对应wchar_t），跨平台场景需注意宽字符类型的兼容性。

内容的提问来源于stack exchange，提问作者Desert Wind