内存内容操作函数详解[5]：memchr()

c内存操作系列讲解之一：c内存内容操作之一：memcmp函数详解-CSDN博客

c内存操作系列讲解之二：c内存内容操作之二：memcpy函数详解-CSDN博客

c内存操作系列讲解之三：c内存内容操作之三：memmove函数详解-CSDN博客

c内存操作系列讲解之四：c内存内容操作之四：memset函数详解-CSDN博客

一、函数简介

memchr 函数用于在内存块中搜索一个特定的字符（实际上是 unsigned char 类型的值），并返回该字符第一次出现的指针。如果未找到该字符，则返回 NULL。这个函数在处理字节流、字符串或任何形式的原始内存数据时非常有用。

二、函数原型

在 <string.h> 头文件中，memchr 函数的原型定义如下：

void *memchr(const void *str, int c, size_t n);

参数

• str 参数：应指向一个有效的内存块，用于搜索操作。如果 str 为空指针，则行为未定义，可能导致程序崩溃。
• c 参数：虽然以 int 类型传递，但在函数内部会将其视为 unsigned char 进行比较。意味着即使传递的是一个负整数，它也会被解释为无符号字符。
• n参数：指定了要搜索的字节数。如果 count 为 0，则函数的行为是未定义的。此外，如果 ptr 指向的内存块小于 count 指定的字节数，但搜索在该范围内成功找到字符，则行为是良好定义的。

返回值

• 如果在指定内存范围内找到字符 c，memchr 返回指向该字符的指针（转换为 void* 类型）。
• 如果未找到字符 c，则返回 NULL。

三、函数实现（伪代码）

memchr 的具体实现可能会因编译器和库的不同而有所差异，但基本思想是相同的。以下是一个简单的 memchr 实现示例，用于说明其工作原理：

#include <stddef.h> // 包含 size_t 的定义  
  
void *my_memchr(const void *str, int c, size_t n) {  
    // 将 c 转换为 unsigned char，以便与内存中的字节进行比较  
    unsigned char uc = (unsigned char)c;  
    // 将 str 转换为 const unsigned char* 类型，以便按字节访问  
    const unsigned char *p = (const unsigned char *)str;  
  
    // 遍历内存块，直到找到匹配的字节或达到搜索长度  
    for (size_t i = 0; i < n; i++) {  
        if (p[i] == uc) {  
            // 返回指向匹配字节的指针（注意类型转换回 void*）  
            return (void *)&p[i];  
        }  
    }  
  
    // 未找到匹配的字节，返回 NULL  
    return NULL;  
}

需要注意的是，由于 c 参数的类型是 int，但在比较时我们将其转换为 unsigned char，这是为了避免潜在的符号扩展问题（如果 c 的值在 char 的表示范围内但具有负符号，则直接比较可能会产生不正确的结果）。

此外，虽然这个实现很简单，但标准库中的 memchr 可能会使用更高效的算法或硬件加速技术（如 SIMD 指令）来提高性能，特别是在处理大量数据时。

四、使用场景

以下是memchr的一些典型使用场景。

4.1. 大规模数据处理

• 日志文件分析：在处理大规模的日志文件时，memchr可以用于快速定位日志中的特定标记或错误代码，从而加速日志解析和错误排查的过程。
• 网络数据包解析：在网络通信中，数据包通常包含一系列的字段和标志，memchr可以帮助开发者快速找到这些关键信息，从而正确解析数据包内容。

4.2. 实时数据处理

• 实时数据流分析：在需要实时处理大量数据流的应用中（如实时监控系统、金融交易系统等），memchr的高性能特性使得它能够快速响应并处理数据中的关键信息。
• 嵌入式系统开发：在资源受限的嵌入式系统中，memchr的高效性尤为重要，它可以帮助开发者在有限的资源下实现复杂的数据处理任务。

4.3. 文本处理

• 关键词查找：在文本处理应用中，memchr可以用于快速查找文本中的关键词或特定字符，在搜索引擎、文本编辑器、编译器等场景中非常有用。
• 字符串操作：在进行字符串分割、替换等操作时，memchr可以作为基础工具来定位字符串中的特定字符，从而简化操作过程。

4.4. 跨平台兼容性

• 多平台支持：memchr通常支持多种平台（如x86_64、wasm32、aarch64等），这使得它可以在不同的硬件和软件环境下工作，提高了代码的可移植性和复用性。

4.5. 高度优化

• 性能优化：memchr通过利用SIMD指令和SWAR（Single Word Access with Range）技术等高级技术来提高搜索性能，特别是在处理大量数据时，其性能优势更加明显。

五、注意事项

在使用 memchr 函数时，需要注意以下几点以确保正确性和效率。

5.1.  性能考虑

• memchr 函数按顺序读取内存块中的每个字节，直到找到匹配的字符或达到指定的字节数。因此，其性能与要搜索的内存块的大小以及字符在内存块中的位置有关。
• 在处理大量数据时，应考虑使用更高效的搜索算法或利用硬件加速技术（如 SIMD 指令）来提高性能。

5.2. 安全性

• 确保不会越界访问内存。即，str 指向的内存块必须至少包含 n个字节的可访问内存。
• 避免在不确定内存内容的情况下使用 memchr，因为这可能会导致不可预测的行为。

5.3 兼容性

• memchr 是标准 C 库的一部分，因此在大多数 C / C++ 编译器中都是可用的。然而，不同编译器或平台的具体实现可能会有所不同，因此在使用时应遵循该平台的特定规范。。

5.4. 替代方案

• 如果需要搜索的是字符串中的字符，并且不关心字符的字节表示（即不考虑字符的编码方式），则可以考虑使用 strchr 函数。strchr 在字符串中搜索第一个出现的字符，并返回指向该字符的指针。但请注意，strchr 会在遇到字符串的终止符 \0 时停止搜索。
• 如果需要比较内存块中的内容，而不是搜索特定字符，则可以使用 memcmp 函数。

六、示例代码

以下是一个使用 memchr 的示例代码，该示例演示了如何在一段给定的内存区域中搜索字符 'a' 的位置，并打印出找到的位置（如果找到的话）。

#include <stdio.h>  
#include <string.h>  
  
int main() {  
    // 定义一个包含字符的数组（以及一个额外的 '\0' 用于说明）  
    char data[] = "Hello, world! This is a test.";  
    // 注意：我们实际上不会检查 '\0'，因为它不是我们要搜索的字符  
  
    // 指定要搜索的字符  
    char searchChar = 'a';  
  
    // 计算数组的长度（不包括 '\0'）  
    // 在实际使用中，如果 data 指向的是动态分配的内存，则需要确保有正确的方式来获取其大小  
    size_t length = sizeof(data) - 1; // 减去 '\0'  
  
    // 使用 memchr 搜索字符  
    void *found = memchr(data, searchChar, length);  
  
    // 检查是否找到字符  
    if (found != NULL) {  
        // 如果找到，将 void* 转换为 char* 并计算偏移量  
        char *foundChar = (char *)found;  
        printf("Character '%c' found at position: %ld\n", searchChar, (long)(foundChar - data));  
    } else {  
        // 如果没有找到  
        printf("Character '%c' not found in the data.\n", searchChar);  
    }  
  
    return 0;  
}

 

memchr 被用来在 data 数组中搜索字符 'a'。注意，虽然 data 数组是以字符串的形式定义的，但 memchr 并不关心字符串的终止符 \0，它会继续搜索直到达到指定的长度 length。在这个例子中，length 被设置为 sizeof(data) - 1，以排除字符串的终止符 \0。

如果 memchr 找到了指定的字符，它会返回一个指向该字符的指针（转换为 void* 类型）。然后，我们将这个 void* 指针转换回 char* 指针，并通过计算它与原始数组 data 之间的偏移量来确定字符的位置。

如果 memchr 没有找到指定的字符，它会返回 NULL，我们在代码中相应地处理这种情况。

参考文献：https://www.trytoprogram.com/c-programming/c-string-handling-library-functions/memchr/