Linux下C语言编程中的一些经验小结

=Start=

缘由：

总结、提高需要

正文：

参考解答：

1、在使用一个返回类型为指针的函数时，一定要明确知道是否需要在使用后free，因为不free会造成内存泄露，但不需要free却又主动free的话会造成程序异常且不容易检测；比如get_current_dir_name()函数返回的指针就需要主动free()，在它的手册中提到它是malloc()后返回的，需要调用者对非NULL返回调用free()，但是ttyname()返回的指针就不应该手动free()，因为ttyname()返回的是一个静态分配的字符串；

2、尽量通过传参的方式获取处理结果，避免通过函数内部malloc后返回指针的方式，一来是避免调用者忘记free导致的内存泄露，或者主动free导致的程序异常，二来是这样编写的函数是可重入且线程安全的；比如 ttyname() 和 ttyname_r() 中就应该优先使用ttyname_r()；

3、在关键路径上使用的函数最好要是异步的，避免成为瓶颈从而引发故障；比如：syslog()函数其实是同步而非异步的，具体信息可参见「rsyslog使用之坑」；

4、不要相信传入函数的参数，函数中的第一步操作就应该是参数的合理/合法性校验，不通过的话直接return，既高效又可避免错误；比如下面这个函数：

int get_cmdline_from_pid (int pid, char cmdline[PATH_MAX])
{
    char file[PATH_MAX];
    snprintf(file, PATH_MAX, "/proc/%d/cmdline", pid);
    int i, r = 0, fd = open(file, O_RDONLY);
    memset(cmdline, 0, PATH_MAX);
    if (fd > 0) {
        r = read(fd, cmdline, PATH_MAX);
        close(fd);

        for (i = 0; r > 0 && i < r-1; i++) {
            if (cmdline[i] == 0)
                cmdline[i] = ' ';
        }
        return 0;
    }
    return -1;
}

存在几个问题：1.现有的两个参数应该显式改为三个参数（因为C语言中的函数参数是没有数组这一类型的，它对于函数来说就是一指针，指针指向的原始数组大小需要用另一个参数来显式说明）；2.函数体中第一步应该做参数的合理性校验，避免后面出现对NULL指针进行操作导致segmentation fault，同时也可以提高效率；3.对于系统调用read()的返回值没有做判断以及相应的操作，这样虽然对cmdline的内容没什么影响，但是函数的返回值却会是0，可能会造成调用者的误解并引发后续错误。修改后的效果如下：

int get_cmdline_from_pid (int pid, char cmdline[], int cmdline_size)
{
    if (pid <= 0 || cmdline == NULL || cmdline_size <= 0) {
        return -1;
    }

    char file[PATH_MAX];
    snprintf(file, PATH_MAX, "/proc/%d/cmdline", pid);
    int i, r = 0, fd = open(file, O_RDONLY);
    if (fd > 0) {
        memset(cmdline, 0, cmdline_size);
        r = read(fd, cmdline, cmdline_size);
        if (r <= 0) {
            close(fd);
            return -1;
        }

        for (i = 0; r > 0 && i < r-1; i++) {
            if (cmdline[i] == 0)
                cmdline[i] = ' ';
        }
        close(fd);
        return 0;
    }
    return -1;
}

增加了一些检查、判断之后，整体逻辑要清晰了不少，也可避免不少不必要的错误。

补充一个memset()对NULL指针进行操作导致「段错误」的示例：

#include <unistd.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>

int main(int argc, char const *argv[])
{
    // char *cwd = get_current_dir_name();
    // printf("current_dir_name = %s\n", cwd);
    // if (cwd) {
    //     free(cwd);    // we should free
    // }

    char *ttyname_b = ttyname (0);
    printf("ttyname = %s\n", ttyname_b);
    if (ttyname_b) {
        free(ttyname_b);    // should not free
    }

    char arr[100] = "this is an char array";
    printf("arr = %s\n", arr);
    memset(arr, 0, sizeof(arr));
    printf("arr = %s\n", arr);

    char *str = NULL;
    printf("str = %s\n", str);
    memset(str, 0, sizeof(str));    // segmentation fault
    printf("str = %s\n", str);

    return 0;
}

参考链接：

=END=

19 8 月, 2017

Docker

KnowledgeBase, Programing

C, 参数检查, 异步