C / C++ / 系统课时

实现一个简易 ls 工具

实现一个简易 ls 工具

这一节把目录遍历和文件元数据查询组合成一个可运行的命令行程序:读取指定目录,逐项输出文件类型、权限、大小和名称。重点不是复制完整 ls,而是掌握 opendir、readdir、lstat 和路径拼接如何协作。

学习目标

  • 使用 opendir、readdir 和 closedir 完成目录遍历。
  • 使用 lstat 获取目录项类型、权限和大小,并正确处理符号链接。
  • 处理单个目录项失败、遍历结束与遍历错误之间的差异。

先拆清接口职责

opendir 打开目录并返回 DIR *;readdir 每次返回一个目录项名称;lstat 根据完整路径读取该目录项的 struct stat。遍历完成后必须调用 closedir 释放目录流。

不要只依赖 struct dirent 的 d_type 判断类型。部分文件系统会把它返回为 DT_UNKNOWN,而 lstat 能从文件系统元数据得到更可靠的信息,并且查看符号链接本身而不是跟随到目标文件。

完整实现

下面程序默认列出当前目录,也可以接收一个目录参数。它跳过 . 和 ..,但保留其他以点开头的名称;输出顺序采用文件系统返回顺序,不额外排序。

c
#define _XOPEN_SOURCE 700
#include <dirent.h>
#include <errno.h>
#include <inttypes.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>

static const char *type_name(mode_t mode) {
    if (S_ISREG(mode)) return "file";
    if (S_ISDIR(mode)) return "dir";
    if (S_ISLNK(mode)) return "link";
    if (S_ISCHR(mode)) return "char";
    if (S_ISBLK(mode)) return "block";
    if (S_ISFIFO(mode)) return "fifo";
    if (S_ISSOCK(mode)) return "socket";
    return "other";
}

static void permission_text(mode_t mode, char out[10]) {
    out[0] = (mode & S_IRUSR) ? 'r' : '-';
    out[1] = (mode & S_IWUSR) ? 'w' : '-';
    out[2] = (mode & S_ISUID) ? ((mode & S_IXUSR) ? 's' : 'S')
                              : ((mode & S_IXUSR) ? 'x' : '-');
    out[3] = (mode & S_IRGRP) ? 'r' : '-';
    out[4] = (mode & S_IWGRP) ? 'w' : '-';
    out[5] = (mode & S_ISGID) ? ((mode & S_IXGRP) ? 's' : 'S')
                              : ((mode & S_IXGRP) ? 'x' : '-');
    out[6] = (mode & S_IROTH) ? 'r' : '-';
    out[7] = (mode & S_IWOTH) ? 'w' : '-';
    out[8] = (mode & S_ISVTX) ? ((mode & S_IXOTH) ? 't' : 'T')
                              : ((mode & S_IXOTH) ? 'x' : '-');
    out[9] = '\0';
}

static char *join_path(const char *dir, const char *name) {
    size_t dir_len = strlen(dir);
    size_t name_len = strlen(name);
    int need_slash = dir_len > 0 && dir[dir_len - 1] != '/';
    size_t total = dir_len + name_len + (need_slash ? 2 : 1);

    char *path = malloc(total);
    if (path == NULL) return NULL;

    snprintf(path, total, "%s%s%s", dir, need_slash ? "/" : "", name);
    return path;
}

int main(int argc, char *argv[]) {
    if (argc > 2) {
        fprintf(stderr, "usage: %s [DIRECTORY]\n", argv[0]);
        return 2;
    }

    const char *dir_path = argc == 2 ? argv[1] : ".";
    DIR *dir = opendir(dir_path);
    if (dir == NULL) {
        perror("opendir");
        return 1;
    }

    int status = 0;
    printf("%-7s %-9s %10s %s\n", "TYPE", "PERM", "SIZE", "NAME");

    for (;;) {
        errno = 0;
        struct dirent *entry = readdir(dir);

        if (entry == NULL) {
            if (errno != 0) {
                perror("readdir");
                status = 1;
            }
            break;
        }

        if (strcmp(entry->d_name, ".") == 0 ||
            strcmp(entry->d_name, "..") == 0) {
            continue;
        }

        char *full_path = join_path(dir_path, entry->d_name);
        if (full_path == NULL) {
            fprintf(stderr, "out of memory\n");
            status = 1;
            break;
        }

        struct stat st;
        if (lstat(full_path, &st) == -1) {
            fprintf(stderr, "lstat %s: %s\n",
                    full_path, strerror(errno));
            free(full_path);
            status = 1;
            continue;
        }

        char perms[10];
        permission_text(st.st_mode, perms);
        printf("%-7s %-9s %10jd %s\n",
               type_name(st.st_mode), perms,
               (intmax_t)st.st_size, entry->d_name);

        free(full_path);
    }

    if (closedir(dir) == -1) {
        perror("closedir");
        status = 1;
    }

    return status;
}

预期结果

text
TYPE    PERM            SIZE NAME
<TYPE>  <PERM>        <SIZE> <NAME>

具体数据取决于目标目录。接下来创建一个可控目录验证实现;目录本身的大小由文件系统决定,因此输出中用 <SIZE> 表示动态值。

bash
cc -Wall -Wextra -std=c11 mini_ls.c -o mini_ls
tmp=$(mktemp -d)
printf 'abc' > "$tmp/a.txt"
mkdir "$tmp/subdir"
chmod 640 "$tmp/a.txt"
chmod 750 "$tmp/subdir"
./mini_ls "$tmp"
rm -rf "$tmp"

预期输出

text
TYPE    PERM            SIZE NAME
file    rw-r-----          3 a.txt
dir     rwxr-x---     <SIZE> subdir

两条数据行的先后顺序可能不同,因为 readdir 不保证排序。<SIZE> 是该目录在当前文件系统上的实际字节数。

为什么要用 lstat

如果改用 stat,遇到符号链接时会跟随链接并返回目标文件的信息;lstat 返回的是链接本身的信息,因此更适合实现“列出这个目录项是什么”的工具。对于普通文件和目录,两者得到的主体元数据通常一致。

st_mode 同时保存文件类型位和权限位,所以程序分别通过 S_ISREG、S_ISDIR 等宏判断类型,再通过 S_IRUSR、S_IWUSR 等位生成九位权限字符串。文件大小使用 off_t,输出时转换为 intmax_t 并配合 %jd,避免直接假定它等于 long。

处理真实目录时的边界

这个简易实现故意保留了几项与真实 ls 的差异。它不排序,不格式化时间和所有者,也没有转义包含换行等特殊字符的文件名。若要更接近常用 ls,应先收集目录项再用 qsort 排序,并增加终端安全的名称显示规则。

还有一个容易忽略的错误处理点:readdir 返回 NULL 既可能表示遍历结束,也可能表示出错,所以程序在每次调用前把 errno 清零,再据此判断结果。单个文件的 lstat 失败时则记录错误并继续遍历,最终用非零退出码告诉调用者“结果不完整”。

把目录流、路径拼接、元数据读取和错误处理组合起来后,就已经具备实现文件浏览、目录扫描和批量处理工具所需的核心文件系统能力。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

实现一个简易 ls 工具

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通