Linux 下几个文件操作命令的代码实现

2620阅读　0评论2011-03-07　whyliyi
分类：LINUX

原文地址：http://www.ibm.com/developerworks/cn/linux/l-cn-commands/index.html

本文章中的示例代码是在 CentOS 5.4 64 位环境下运行通过的，在其它 unix 系统上没有测试过。

Linux 操作系统中的命令实际上是编译好的可执行程序，比如说 ls 这个命令，这个文件位于 /bin 目录下面，当我们用 file /bin/ls 命令查看的时候会有以下输出：

  1. [root@localhost ~]# file /bin/ls
  2. /bin/ls: ELF 64-bit LSB executable,
  3. AMD x86-64, version 1 (SYSV), for GNU/Linux 2.6.9,
  4. dynamically linked (uses shared libs), for GNU/Linux 2.6.9, stripped


这个命令通过调用 stat 系统调用和 /usr/share/file/magic.mgc 文件来决定文件的类型。如上的 /bin/ls 是一个 ELF 格式的动态链接的 64 位的可执行文件。

系统调用是用户程序和操作系统内核之间的接口，我们可以使用操作系统提供的系统调用来请求分配资源和服务。我们可以通过 man 2 章节来查找 Linux 提供的系统调用的具体使用方法。有关文件操作的常见系统调用命令有：open、creat、close、read、write、lseek、opendir、readdir、mkdir、stat 等等。

大家也都知道 cp 这个命令主要的作用就是把一个文件从一个位置复制到另一个位置。比如现在 /root 目录下有一个 test.txt 文件，如果我们用 cp test.txt test2.txt 命令的话，在同一个目录下面就会生成一个同样内容的 test2.txt 文件了。

那么 cp 命令是怎么实现的呢，我们看如下代码：


  1. #include <stdio.h>
  2. #include <unistd.h>
  3. #include <fcntl.h>
  4. #include <stdlib.h>
  5. #define BUFFERSIZE 4096
  6. #define COPYMODE 0644

  8. void oops(char *, char *);

  10. main(int argc, char * argv[])
  11. {
  12. int in_fd, out_fd, n_chars;
  13. char buf[BUFFERSIZE];
  14. if ( argc != 3 )
  15. {
  16.     fprintf( stderr, "usage: %s source destination\n", *argv);
  17.     exit(1);
  18. }
  19. if ( (in_fd=open(argv[1], O_RDONLY)) == -1 )
  20. { oops("Cannot open ", argv[1]); }
  21. if ( (out_fd=creat( argv[2], COPYMODE)) == -1 )
  22. { oops( "Cannot creat", argv[2]); }

  24. while ( (n_chars = read(in_fd , buf, BUFFERSIZE)) > 0 )
  25. { if ( write( out_fd, buf, n_chars ) != n_chars )
  26. { oops("Write error to ", argv[2]); } }
  27. if ( n_chars == -1 )
  28. { oops("Read error from ", argv[1]); }

  30. if ( close(in_fd) == -1 || close(out_fd) == -1 )
  31. oops("Error closing files","");
  32. }

  34. void oops(char *s1, char *s2)
  35. {
  36. fprintf(stderr,"Error: %s ", s1); perror(s2); exit(1);
  37. }

该程序的主要实现思想是：打开一个输入文件，创建一个输出文件，建立一个 BUFFERSIZE 大小的缓冲区；然后在判断输入文件未完的循环中，每次读入多少就向输出文件中写入多少，直到输入文件结束。

让我来详细的讲述一下这个程序：

  • 开头四行包含了 4 个头文件， 文件包含了 fprintf、perror 的函数原型定义； 文件包含了 read、write 的函数原型定义； 文件包含了 open、creat 的函数原型定义、 文件包含了 exit 的函数原型定义。这些函数原型有些是系统调用、有些是库函数，通常都可以在 /usr/include 目录中找到这些头文件。
  • 接下来的 2 行以宏定义的方式定义了 2 个常量。BUFFERSIZE 用来表示缓冲区的大小、COPYMODE 用来定义创建文件的权限。
  • 接下来的一行定义了一个函数原型 oops，该函数的具体定义在最后出现，用来输出出错信息到 stderr，也就是标准错误输出的文件流。
  • 接下来主程序开始。首先定义了 2 个文件描述符、一个存放读出字节数的变量 n_chars、和一个 BUFFERSIZE 大小的字符数组用来作为拷贝文件的缓冲区。
  • 接下来判断输入参数的个数是否为 3，也就是程序名 argv[0]、拷贝源文件 argv[1]、目标文件 argv[2]。不为 3 的话就输出错误信息到 stderr，然后退出程序。
  • 接下来的 2 行，用 open 系统调用以 O_RDONLY 只读模式打开拷贝源文件，如果打开失败就输出错误信息并退出。如果想了解文件打开模式的详细内容请使用命令 man 2 open，来查看帮助文档。
  • 接下来的 2 行，用 creat 系统调用以 COPYMODE 的权限建立一个文件，如果建立失败函数的返回值为 -1 的话，就输出错误信息并退出。
  • 接下来的循环是拷贝的主要过程。它从输入文件描述符 in_fd 中，读入 BUFFERSIZE 字节的数据，存放到 buf 字符数组中。在正常读入的情况下，read 函数返回实际读入的字节数，也就是说只要没有异常情况和文件没有读到结尾，那么 n_chars 中存放的就是实际读出的字节的数字。然后 write 函数将从 buf 缓冲区中，读出 n_chars 个字符，写入 in_out 输出文件描述符。由于 write 系统调用返回的是实际写入成功的字节数。所以当读出 N 个字符，又成功写入 N 个字符到输出文件描述符中去的时候，就表示写成功了，否则就报告写入错误。
  • 最后就是用 close 系统调用关闭打开的输入和输出文件描述符。

回页首

rm 命令主要是用来删除一个文件。

该命令的实现代码如下：


  1. #include <unistd.h>
  2. #include <stdio.h>
  3. #include <stdlib.h>
  4. int main(int argc , char * argv[])
  5. {
  6.     int rt;
  7.     if(argc != 2)
  8.     { exit(2); }
  9.     else
  10.     {
  11.         if((rt = unlink(argv[1])) != 0)
  12.         {
  13.             fprintf(stderr,"error.");
  14.             exit(3);
  15.         }
  16.     }
  17.     return 0;
  18. }

其中程序的关键是 unlink 系统调用，unlink 函数原型包含在 头文件里面。

我们从这个程序的创建过程来分析这个程序。

这个命令的模拟程序是怎么写出来的呢？

首先，我们可以在机器上 touch test 建立一个 test 文件，然后调用 strace rm test 命令来查看 rm 命令具体使用了那些系统调用。

通过查看，我们看到主要使用的系统调用如下：

  1. [root@localhost aa]# strace rm test 
  2. execve("/bin/rm", ["rm", "test"], [/* 24 vars */]) = 0 
  3. brk(0) = 0xcc66000 
  4. mmap(NULL, 4096, PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, -1, 0) = 0x2aff83ffb000 uname({sys="Linux", node="localhost.localdomain", ...}) = 0 ... ... lstat("test", {st_mode=S_IFREG|0644, st_size=0, ...}) = 0 
  5. stat("test", {st_mode=S_IFREG|0644, st_size=0, ...}) = 0 
  6. geteuid() = 0 
  7. getegid() = 0 
  8. getuid() = 0 
  9. getgid() = 0 
  10. access("test", W_OK) = 0 
  11. unlink("test") = 0 
  12. close(1) = 0 
  13. exit_group(0) = ?

我们可以看到起主要作用的就是 unlink(“test”) 这个系统调用。

让我们来分析一下这些输出的含义：

  • 首先第一行 execve 系统调用。该系统调用执行参数“/bin/rm”中的程序（以 #! 开头的可执行脚本也可以），后面第一个方括号中表示执行的参数，第二个方括号中表示执行的环境变量。
  • 接下来的 brk 和 mmap 命令，主要是用来给可执行命令分配内存空间。
  • 后面的 lstat 系统调用用来确定文件的 mode 信息，包括文件的类型和权限，文件大小等等。
  • 然后 access 系统调用检查当前用户进程对于 test 文件的写入访问权限。这里返回值为 0 也就是说进程对于 test 文件有写入的权限。
  • 最后调用 unlink 系统调用删除文件。

这里如果我们建立一个目录 test1，然后用 rm test1 去删除这个目录会有什么结果呢？

我们看到有如下输出：

rm: cannot remove `test1': Is a directory

这时我们用 strace 命令来追踪一下，发现输出主要是如下不同。

unlink("test") = -1 EISDIR (Is a directory)

这里说明了删除不掉的原因是 unlink 系统调用报错，unlink 它认为 test 是一个目录，不予处理。

那么怎么删除一个目录呢？应该是用 rmdir 系统调用，这样就不会出现上述的问题了。


再让我们来看看 mkdir 的实现。

完整的代码如下：


  1. #include <sys/stat.h>
  2.  #include <sys/types.h> 
  3. #include <stdio.h> 
  4. int main(int argc, char *argv[])
  5. { 
  6.     int rt; 
  7.     if( (rt = mkdir (argv[1],10705)) == -1 )
  8.     { fprintf(stderr,"cannot mkdir"); } 
  9.     return 0; 
  10. }

这段代码也比较简单，我这里就不逐行解释了，主要说以下几点：

首先 mkdir 函数是定义于 和 头文件之中的。

而 fprintf 函数是位于 文件之中的。

mkdir 的函数原型如下：

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

mode 声明为 mode_t 类型。

那么 mode_t 数据类型是什么数据类型，应该从哪个文件去查看它的定义呢？

让我们逐步查找一下。

首先从文件 /usr/include/sys/stat.h 中找到 mode_t 类型

/usr/include/sys/stat.h -> typedef __mode_t mode_t;

说明 mode_t 只是对 __mode_t 的一种定义。

然后从 /usr/include/bits/types.h 中找到 __mode_t 类型

/usr/include/bits/types.h -> __STD_TYPE __MODE_T_TYPE __mode_t;

说明 __mode_t 也只是对 __MODE_T_TYPE 的一种定义。

/usr/include/bits/typesizes.h -> #define __MODE_T_TYPE __U32_TYPE

说明 __MODE_T_TYPE 是对 __U32_TYPE 的一种定义。

/usr/include/bits/types.h -> #define __U32_TYPE unsigned int

最后 __U32_TYPE 是一种无符号的整数的定义。

从上述推导可以看出，mode_t 实际上也就是一种无符号整数。

另外如下结构 struct stat 定义中的 st_mode 成员变量也是使用的 mode_t 类型的变量。

从 man 2 stat 中可以找到结构 struct stat 的定义，如下：

struct stat { dev_t st_dev; /* ID of device containing file */ ino_t st_ino; /* inode number */ mode_t st_mode; /* protection */ nlink_t st_nlink; /* number of hard links */ uid_t st_uid; /* user ID of owner */ gid_t st_gid; /* group ID of owner */ dev_t st_rdev; /* device ID (if special file) */ off_t st_size; /* total size, in bytes */ blksize_t st_blksize; /* blocksize for filesystem I/O */ blkcnt_t st_blocks; /* number of blocks allocated */ time_t st_atime; /* time of last access */ time_t st_mtime; /* time of last modification */ time_t st_ctime; /* time of last status change */ };

该结构也是我们在后面的 tac 命令实现中需要用到的结构体。我们需要用到结构体中的 st_size 成员，该成员反映了被读取的文件描述符对应的文件的大小。


tac 命令主要用来以倒序的方式显示一个文本文件的内容，也就是先显示最后一行的内容，最后显示第一行的内容。代码如下：


  1. #include <stdio.h>
  2. #include <sys/types.h> 
  3. #include <sys/stat.h> 
  4. #include <fcntl.h> 
  5. #include <string.h> 
  6. #include <unistd.h> 
  7. #include <stdlib.h> 
  8. #include <errno.h> 
  9. #define SIZE 1000001 
  10. #define NLINE '\n' 
  11. int main(int argc , char *argv[])
  12. { 
  13. char buf[SIZE]; 
  14. char *p1,*p2,*p3,*p4; 
  15. struct stat *fp; int fd; 
  16. fp=(struct stat *)malloc(sizeof(struct stat)); 
  17. if(argc != 2)
  18. { fprintf(stderr,"input error %s \n"); exit(1); } 
  19. if( (fd=open(argv[1],O_RDONLY)) == -1 )
  20. { fprintf(stderr,"open error %s \n",strerror(errno)); exit(1); } 
  21. if(fstat(fd,fp)== -1){ fprintf(stderr,"fstat error %s \n",strerror(errno)); exit(2); } 
  22. if(fp->st_size > (SIZE-1)){ fprintf(stderr,"buffer size is not big enough \n"); exit(3); } 
  23. if(read(fd,buf,fp->st_size) == -1){ fprintf(stderr,"read error.\n"); exit(4); } 

  25. p1=strchr(buf,NLINE); 
  26. p2=strrchr(buf,NLINE); 
  27. *p2='\0'; 
  28. do
  29. { p2=strrchr(buf,NLINE); 
  30. p4=p2; 
  31. p3=p2+sizeof(char); 
  32. printf("%s\n",p3); 
  33. *p4='\0'; 
  34. }while(p2 != p1); 
  36. if(p2 == p1){ *p2 = '\0'; printf("%s\n",buf); } 
  37. return 0; 
  38. }

让我们来运行一下该程序：

程序的运行情况如下，假设编译后的可执行文件名为 emulatetac，有一个文本文件 test.txt。

# gcc emulatetac.c -o emulatetac # cat test.txt 1 2 3 a b # ./emulatetac test.txt b a 3 2 1

可以看出文件内容以倒序方式显示输出了。

下面逐行讲解：

  • #include 的头文件，都应该通过 man 2 系统调用命令来查找，这里就不多说了。
  • 下面定义了一个宏常量 SIZE，该常量主要用来表示能够读入最大多少个字节的文件，当文件过大的时候程序就不执行，直接退出。然后定义了宏常量 NLINE 表示换行符'\n'。
  • 接下来主程序体开始了：首先定义一个字符数组 buf，用来把读入文件的每个字节都存在该数组里面。
  • 然后定义了 4 个字符串指针，一个指向结构体 struct stat 的指针 fp，一个文件描述符。
  • 然后为指向结构体的指针 fp 分配存储空间。
  • 接下来判断输入参数是否为 2 个，也就是命令本身和文件名。不是 2 个就直接退出。
  • 然后以只读方式打开输入文件名的文件，也就是 test.txt。打开成功的话，把打开的文件赋值到文件描述符 fd 中，错误的话退出。
  • 然后用 fstat 系统调用把文件描述符 fd 中对应文件的元信息，存放到结构体指针 fp 指向的结构中。
  • 下面判断当文件的大小超过缓冲区数组 buf 的大小 SIZE-1 时，就退出。
  • 下面将把文件 test.txt 中的每个字符存放到数组 buf 中。
  • 下面是程序的核心部分：首先我们找到字符串 buf 中的第一个换行字符存放到 p1 指针里面，然后把最后一个换行字符置为字符串结束符。
  • 接下来我们从后往前查找字符串 buf 中的换行符，直到遇到第一个换行符 p1。同时打印每个找到的换行符'\n'中的下一个字符开始的字符串，也就刚好是一行文本。
  • 最后当从后向前找到第一个换行字符时，打印第一行，程序结束。


通过 strace 命令查看 df 主要使用了如下的系统调用：open、fstat、read、statfs

我这里实际上是模拟实现的 df --block-size=4096 这个命令，也就是说以 4096 字节为块大小来显示磁盘使用情况。

这里最为关键的是 statfs 这个结构体，该结构体的某些字段被用作 df 命令的输出字段：

  1. struct statfs 
  2. { 
  3. long f_type; /* type of filesystem (see below) */ 
  4. long f_bsize; /* optimal transfer block size */ 
  5. long f_blocks; /* total data blocks in file system */ 
  6. long f_bfree; /* free blocks in fs */ 
  7. long f_bavail; /* free blocks avail to non-superuser */ 
  8. long f_files; /* total file nodes in file system */ 
  9. long f_ffree; /* free file nodes in fs */ 
  10. fsid_t f_fsid; /* file system id */ 
  11. long f_namelen; /* maximum length of filenames */ 
  12. };


比如：df --block-size=4096 的输出如下（纵向列出）：

Filesystem /dev/sda1 4K-blocks 5077005 　　
 f_blocks 字段 Used 145105 　　
f_blocks 字段 -f_bfree 字段 Available 4669841 　　
 f_bavail 字段 Use% 4% 　　
（f_blocks-f_bfree）/ f_blocks*100% 来计算磁盘使用率。
 Mounted on /

模拟实现的代码如下：


  1. #include <stdio.h> 
  2. #include <errno.h> 
  3. #include <stdlib.h> 
  4. #include <string.h> 
  5. #include <sys/vfs.h> 
  6. #include <math.h> 
  7. #define SIZE1 100 
  8. #define FN "/etc/mtab" 
  9. #define SPACE ' ' 

  11. int displayapartition(char * pt,char * pt1); 

  13. int main(void){ 
  14. char tmpline[SIZE1]; 
  15. FILE * fp; 
  16. char * pt1; 
  17. char * pt2; 
  18. char * pt3; 
  19. if( (fp = fopen(FN,"r")) == NULL )
  20. { 
  21. fprintf(stderr,"%s \n",strerror(errno)); exit(5); 
  22. }
  23. while( fgets(tmpline, SIZE1, fp) != NULL )
  24. { 
  25. pt1=strchr(tmpline, SPACE); 
  26. pt2=pt1+sizeof(char); 
  27. *pt1='\0'; 
  28. pt3=strchr(pt2,SPACE); 
  29. *pt3='\0'; 
  30. if(strstr(tmpline,"/dev") != NULL )
  31. { displayapartition(tmpline,pt2); } 
  32. } 
  33. return 0; 
  34. } 

  36. int displayapartition(char * pt,char * pt1)
  37. { struct statfs buf; 
  38. statfs(pt1,&buf); 
  39. int usage; usage=ceil((buf.f_blocks-buf.f_bfree)*100/buf.f_blocks); 
  40. printf("%s ",pt); 
  41. printf("%ld ",buf.f_blocks); 
  42. printf("%ld ",buf.f_blocks-buf.f_bfree); 
  43. printf("%ld ",buf.f_bavail); 
  44. printf("%d%% ",usage); 
  45. printf("%s ",pt1); 
  46. printf("\n"); 
  47. return 0; 
  48. }

下面解释一下这个程序：

  • 首先，该程序定义了一个函数 displayapartition， 这里先定义它的函数原型。
  • 然后我们从主程序说起：首先定义了一个 char tmpline[SIZE1] 数组，该数组用来存放从宏定义常量 FN 代表的文件中，打开后存入文件的每行记录。
  • 接着定义了一个文件流指针和 3 个字符串指针。
  • 接下来打开文件 FN 并把结果赋值给文件流变量 fp, 如果打开失败就退出。
  • 下面从打开的文件流中读出 SIZE1 个字符到临时数组 tmpline。比如读出一行数据为：/dev/sda1 / ext3 rw 0 0 　将把 /dev/sda1 放入数组 tmpline，把加载点 / 放入指针 pt2，同时判断字符串 tmpline 是否包含 /dev 字符串，这样来判断是否是一个磁盘文件，如果是的话就调用子函数 displayapartition，不是则返回。
  • 子函数 displayapartition 是做什么的呢？该函数接受 2 个参数，一个是行 /dev/sda1 / ext3 rw 0 0 中的第一列比如：/dev/sda1 也就是实际磁盘作为 pt 指针，一个是行中的第二列比如：/ 也就是挂载点作为 pt1 指针。然后子函数通过 pt1 指针，读取挂载上的文件系统信息到 buf 数据结构里面。
  • 根据开头介绍过的 statfs 结构体，buf.f_blocks 表示打开的文件系统的总数据块，buf.f_blocks-buf.f_bfree 表示已经使用的数据块，buf.f_bavail 表示非超级用户可用的剩余数据块，磁盘使用率就是前面列出过的计算表达式：（f_blocks- f_bfree）/ f_blocks*100%。通过子函数就可以打印出 df 需要显示的所有信息到标准输出了。


本文依次讲述了 cp、rm、mkdir、tac、df 命令的主要功能实现代码，当然每个命令还有很多参数，我这个模拟实现代码甚至连主要功能的很多细节都没有实现，比如 df 命令的输出头我没有打印出来，这牵涉到打印头和输出格式化等很多细节。所以，从这里我们就可以推断出，真实的源代码肯定是考虑得非常全面、严谨和健壮的。我这里只是抛砖引玉，希望能给爱好 Linux 的朋友们提供一种理解 Linux 系统的思路。


源码下载地址：http://www.ibm.com/developerworks/apps/download/index.jsp?contentid=630370&filename=code.zip&method=http&locale=zh_CN

上一篇：网卡工作原理
下一篇：linux mmap 详解