第二次代码优化

第二次优化代码

这次代码优化主要是对删除文件和文件夹操作进行优化

删除文件和文件夹

删除文件和文件夹我习惯使用rm,简单粗暴,如:

1
2
system("rm -f /etc/log_config"); //删文件
system("rm -rf /data/traffic"); //删文件夹

其实有函数可以完成删除操作,就像之前说的这样可以不用创建进程,优化性能

unlink()是用来删除文件的函数,函数原型如下:

1
2
3
#include <unistd.h>

int unlink(const char * pathname);

unlink()会删除参数pathname 指定的文件. 如果该文件名为最后连接点, 但有其他进程打开了此文件, 则在所有关于此文件的文件描述词皆关闭后才会删除. 如果参数pathname 为一符号连接, 则此连接会被删除。

成功则返回0, 失败返回-1, 错误原因存于errno

错误代码:

  1. EROFS 文件存在于只读文件系统内。
  2. EFAULT 参数pathname 指针超出可存取内存空间。
  3. ENAMETOOLONG 参数pathname 太长。
  4. ENOMEM 核心内存不足。
  5. ELOOP 参数pathname 有过多符号连接问题。
  6. EIO I/O 存取错误。

所以可以简单的封装一下,封装为我们自己的删除文件的函数:

1
2
3
4
int do_rm_file(const char *file_name)
{
return unlink(file_name);
}

remove()、rmdir()和mkdir()

remove()函数用于删除指定的文件,函数原型如下:

1
2
3
#include <stdio.h>

int remove(char *filename);

filename为要删除的文件名,可以为一目录。如果参数filename 为一文件,则调用unlink()处理;若参数filename 为一目录,则调用rmdir()来处理。


rmdir()是删除一个空目录,如果目录不为空则会返回-1,函数原型如下:

1
2
3
#include<unistd.h>

int rmdir(const char *pathname);

mkdir()是创建目录,函数原型如下:

1
2
3
#include <sys/stat.h>

int mkdir(const char *pathname, mode_t mode);

其中参数pathname是新创建目录的目录名,mode指定该目录的访问权限,

由pathname指定的新目录的父目录必须存在,并且调用进程必须具有该父目录的写权限以及pathname涉及的各个分路径目录的搜寻权限

mode如下:

参 数 说 明 参 数 说 明
S_IRUSR 所有者拥有读权限 S_IXGRP 群组拥有执行权限
S_IWUSR 所有者拥有写权限 S_IROTH 其他用户拥有读权限
S_IXUSR 所有者拥有执行权限 S_IWOTH 其他用户拥有写权限
S_IRGRP 群组拥有读权限 S_IXOTH 其他用户拥有执行权限
S_IWGRP 群组拥有写权限

nftw()

nftw()是遍历目录树的一个函数,函数原型如下:

1
2
3
4
5
#include <ftw.h>

int nftw(const char *dirpath,
int (*fn) (const char *fpath, const struct stat *sb, int typeflag, struct FTW *ftwbuf),
int nopenfd, int flags);

nftw()遍历位于文件夹dirpath下面的目录树,为每个树的节点调用一次fn()。默认情况下,当前目录总是先于其包含的文件和子目录被处理(先序遍历)。

为了避免调用进程的文件描述符被用尽,nopenfd指定了 nftw() 能够同时打开目录的最大数量。当搜索深度超过这个值,nftw() 将会变慢,因为目录必须被关掉和重新打开。nftw() 为目录树中的每一层至多使用一个文件描述符。

对于在树中发现的每个节点,nftw() 为其调用带四个参数的函数fn(),这四个参数为fpath,sb,typeflag和ftwbuf。fpath是节点的路径名,它可以表示为相对路径或者绝对路径,相对路径是相对调用进程的当前工作目录。sb是为fpath调用stat函数所返回的指向stat结构体的指针。typeflag是一个整型值,取下面其中一个值:

  • FTW_F fpath是一个普通文件。
  • FTW_D fpath是一个目录。
  • FTW_DNR fpath是一个不能被读的目录。
  • FTW_DP fpath是一个目录,并且 flag参数被指定为FTW_DEPTH。(如果flags没有被指定为- FTW_DEPTH,那么访问目录时使用的typeflag总会是FTW_D。)路径fpath下的所有文件和子目录已经被处理过了。
  • FTW_NS 在不是符号链接的fpath上调用stat失败。可能的原因是调用者对父目录有读权限,所以文件名fpath可以被看到,但是没有执行权限,所以执行stat失败。由sb指向的缓存的内容是未定义的。
  • FTW_SL fpath是一个符号链接,flags被设置为FTW_PHYS。
  • FTW_SLN fpath是一个指向不存在的文件的符号链接。(只在FTW_PHYS未被设置的时候才会发生。)

当调用fn() 时 nftw() 为其提供的第四个参数是一个类型为FTW的结构体:

1
2
3
4
5
struct FTW
{
int base;
int level;
};

base是在fpath中给定的路径名中的文件名(basename)的偏移量。level是fpath在目录树中相对于根节点的深度(dirpath的深度为0)。

为了让树的遍历停止,fn() 返回一个非0值;这个值将会成为 nftw() 的返回值。只要fn()返回值为0,nftw()将会继续遍历目录树,直到要么遍历完整个树,在这种情况下会返回0;要么遇到一个错误(比如malloc失败),在这种情况下返回-1。

因为nftw() 使用动态数据结构,遍历目录树时唯一的安全退出方法就是从fn() 返回一个非0值。为了让信号量终止遍历时不会造成内存泄露,让处理这设置一个全局的flag,由fn()对这个全局flag进行检查。不要使用longjmp,除非程序将会终止(terminate)。

nftw() 的flags 参数由下面的一个或者多个的flags进行或运算所形成:

  • FTW_ACTIONRETVAL (从 glibc 2.3.3开始支持)

    如果这个特定的glibc的flag被设置,nftw() 会对从fn()返回的值进行不同处理。fn() 应该返回下面的值的其中一个:

    • FTW_CONTINUE:让nftw() 继续正常进行。
    • FTW_SKIP_SIBLINGS:如果fn() 返回这个值,当前节点的兄弟节点会被跳过,处理从父节点继续进行。
    • FTW_SKIP_SUBTREE:如果一个目录节点调用fn()(typeflag是FTW_D),这个返回值会阻止这个目录下的对象作为参数传递给fn()。- nftw() 继续处理当前目录的下一个兄弟节点。
    • FTW_STOP:这会导致nftw() 立即返回FTW_STOP。
    • 其它返回值可以关联到未来的一些新的行为上;fn() 不应该返回除上面列出的值之外的其它值。
    • 为了从<ftw.h>中获取FTW_ACTIONRETVAL的定义,必须在Include任何头文件之前定义功能测试宏_GNU_SOURCE。
  • FTW_CHDIR

    如果设置了这个flag,在处理每个目录的内容之前,都会chdir(2)到这个目录。如果程序需要在fpath所在的某个目录做一些操作,这就是有用的。(指定这个flag不会对作为fn 参数fpath进行传递的路径名有影响。)

  • FTW_DEPTH

    设置这个flag会进行后序遍历,也就是在处理完当前目录的内容和它的所有子目录之后才会调用fn() (默认情况下,每个目录在它的内容之前被处理。)

  • FTW_MOUNT

    设置这个flag,就会停留在同一个文件系统中(也就是不会跨越挂载点)。

  • FTW_PHYS

    设置这个flag,就不会跟随符号链接。(这是你想做的。)如果不设置这个flag,就会跟随符号链接,但是没有文件会被报告两次。

    如果FTW_PHYS没有被设置,但是设置了FTW_DEPTH,那么函数fn() 就永远不会被自己是自己子孙的目录调用到。

我们想实现删除文件夹,所以要从最后一层向前删除,所以要使用后序遍历,然后在回调函数fn中将这个文件删除,如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
int unlink_cb(const char *fpath, const struct stat *sb, int typeflag, struct FTW *ftwbuf)
{
int rv = remove(fpath);

if (rv)
{
printf("remove(%s) failed, rv: %d, err: %d\n", fpath, rv, errno);
}

return rv;
}

e_ret do_rmdir(const char *path)
{
int rv = nftw(path, unlink_cb, 64, FTW_DEPTH | FTW_PHYS);

if ((rv != 0) && (errno != ENOENT))
{
return -1;
}

return 0;
}

第二次代码优化
https://carl-5535.github.io/2021/11/01/工作总结/第二次代码优化/
作者
Carl Chen
发布于
2021年11月1日
许可协议