linux/fs/open.c 程序

1 /*
2 * linux/fs/open.c
3 *
4 * (C) 1991 Linus Torvalds
5 */
6
7 #include <string.h> // 字符串头文件。主要定义了一些有关字符串操作的嵌入函数。
8 #include <errno.h> // 错误号头文件。包含系统中各种出错号。 (Linus 从 minix 中引进的)。
9 #include <fcntl.h> // 文件控制头文件。用于文件及其描述符的操作控制常数符号的定义。
10 #include <sys/types.h> // 类型头文件。定义了基本的系统数据类型。
11 #include <utime.h> // 用户时间头文件。定义了访问和修改时间结构以及 utime()原型。
12 #include <sys/stat.h> // 文件状态头文件。含有文件或文件系统状态结构 stat{}和常量。
13
14 #include <linux/sched.h> // 调度程序头文件，定义了任务结构 task_struct、初始任务 0 的数据，
// 还有一些有关描述符参数设置和获取的嵌入式汇编函数宏语句。
15 #include <linux/tty.h> // tty 头文件，定义了有关 tty_io，串行通信方面的参数、常数。
16 #include <linux/kernel.h> // 内核头文件。含有一些内核常用函数的原形定义。
17 #include <asm/segment.h> // 段操作头文件。定义了有关段寄存器操作的嵌入式汇编函数。
18
// 取文件系统信息系统调用函数。
19 int sys_ustat(int dev, struct ustat * ubuf)
20 {
21 return -ENOSYS;
22 }
23
//// 设置文件访问和修改时间。
// 参数 filename 是文件名，times 是访问和修改时间结构指针。
// 如果 times 指针不为 NULL，则取 utimbuf 结构中的时间信息来设置文件的访问和修改时间。如果
// times 指针是 NULL，则取系统当前时间来设置指定文件的访问和修改时间域。
24 int sys_utime(char * filename, struct utimbuf * times)
25 {
26 struct m_inode * inode;
27 long actime,modtime;
28
// 根据文件名寻找对应的 i 节点，如果没有找到，则返回出错码。
29 if (!(inode=namei(filename)))
30 return -ENOENT;
// 如果访问和修改时间数据结构指针不为 NULL，则从结构中读取用户设置的时间值。
31 if (times) {
32 actime = get_fs_long((unsigned long *) &times->actime);
33 modtime = get_fs_long((unsigned long *) &times->modtime);
// 否则将访问和修改时间置为当前时间。
34 } else
35 actime = modtime = CURRENT_TIME;
// 修改 i 节点中的访问时间字段和修改时间字段。
36 inode->i_atime = actime;
37 inode->i_mtime = modtime;
// 置 i 节点已修改标志，释放该节点，并返回 0。
38 inode->i_dirt = 1;
39 iput(inode);
40 return 0;
41 }
42
43 /*
44 * XXX should we use the real or effective uid? BSD uses the real uid,
45 * so as to make this call useful to setuid programs.
46 */
/*
* 文件属性 XXX，我们该用真实用户 id 还是有效用户 id？BSD 系统使用了真实用户 id，
* * 以使该调用可以供 setuid 程序使用。（注：POSIX 标准建议使用真实用户 ID）
*/
//// 检查对文件的访问权限。
// 参数 filename 是文件名， mode 是屏蔽码，由 R_OK(4)、W_OK(2)、X_OK(1)和 F_OK(0)组成。
// 如果请求访问允许的话，则返回 0，否则返回出错码。
47 int sys_access(const char * filename,int mode)
48 {
49 struct m_inode * inode;
50 int res, i_mode;
51
// 屏蔽码由低 3 位组成，因此清除所有高比特位。
52 mode &= 0007;
// 如果文件名对应的 i 节点不存在，则返回出错码。
53 if (!(inode=namei(filename)))
54 return -EACCES;
// 取文件的属性码，并释放该 i 节点。
55 i_mode = res = inode->i_mode & 0777;
56 iput(inode);
// 如果当前进程是该文件的宿主，则取文件宿主属性。
57 if (current->uid == inode->i_uid)
58 res >>= 6;
// 否则如果当前进程是与该文件同属一组，则取文件组属性。
59 else if (current->gid == inode->i_gid)
60 res >>= 6;
// 如果文件属性具有查询的属性位，则访问许可，返回 0。
61 if ((res & 0007 & mode) == mode)
62 return 0;
63 /*
64 * XXX we are doing this test last because we really should be
65 * swapping the effective with the real user id (temporarily),
66 * and then calling suser() routine. If we do call the
67 * suser() routine, it needs to be called last.
68 */
/*
* XXX 我们最后才做下面的测试，因为我们实际上需要交换有效用户 id 和
* 真实用户 id（临时地），然后才调用 suser()函数。如果我们确实要调用
* suser()函数，则需要最后才被调用。
*/
// 如果当前用户 id 为 0（超级用户）并且屏蔽码执行位是 0 或文件可以被任何人访问，则返回 0。
69 if ((!current->uid) &&
70 (!(mode & 1) || (i_mode & 0111)))
71 return 0;
// 否则返回出错码。
72 return -EACCES;
73 }
74
//// 改变当前工作目录系统调用函数。
// 参数 filename 是目录名。
// 操作成功则返回 0，否则返回出错码。
75 int sys_chdir(const char * filename)
76 {
77 struct m_inode * inode;
78
// 如果文件名对应的 i 节点不存在，则返回出错码。
79 if (!(inode = namei(filename)))
80 return -ENOENT;
// 如果该 i 节点不是目录的 i 节点，则释放该节点，返回出错码。
81 if (!S_ISDIR(inode->i_mode)) {
82 iput(inode);
83 return -ENOTDIR;
84 }
// 释放当前进程原工作目录 i 节点，并指向该新置的工作目录 i 节点。返回 0。
85 iput(current->pwd);
86 current->pwd = inode;
87 return (0);
88 }
89
//// 改变根目录系统调用函数。
// 将指定的路径名改为根目录'/'。
// 如果操作成功则返回 0，否则返回出错码。
90 int sys_chroot(const char * filename)
91 {
92 struct m_inode * inode;
93
// 如果文件名对应的 i 节点不存在，则返回出错码。
94 if (!(inode=namei(filename)))
95 return -ENOENT;
// 如果该 i 节点不是目录的 i 节点，则释放该节点，返回出错码。
96 if (!S_ISDIR(inode->i_mode)) {
97 iput(inode);
98 return -ENOTDIR;
99 }
// 释放当前进程的根目录 i 节点，并重置为这里指定目录名的 i 节点，返回 0。
100 iput(current->root);
101 current->root = inode;
102 return (0);
103 }
104
//// 修改文件属性系统调用函数。
// 参数 filename 是文件名，mode 是新的文件属性。
// 若操作成功则返回 0，否则返回出错码。
105 int sys_chmod(const char * filename,int mode)
106 {
107 struct m_inode * inode;
108
// 如果文件名对应的 i 节点不存在，则返回出错码。
109 if (!(inode=namei(filename)))
110 return -ENOENT;
// 如果当前进程的有效用户 id 不等于文件 i 节点的用户 id，并且当前进程不是超级用户，则释放该
// 文件 i 节点，返回出错码。
111 if ((current->euid != inode->i_uid) && !suser()) {
112 iput(inode);
113 return -EACCES;
114 }
// 重新设置 i 节点的文件属性，并置该 i 节点已修改标志。释放该 i 节点，返回 0。
115 inode->i_mode = (mode & 07777) | (inode->i_mode & ~07777);
116 inode->i_dirt = 1;
117 iput(inode);
118 return 0;
119 }
120
//// 修改文件宿主系统调用函数。
// 参数 filename 是文件名，uid 是用户标识符(用户 id)，gid 是组 id。
// 若操作成功则返回 0，否则返回出错码。
121 int sys_chown(const char * filename,int uid,int gid)
122 {
123 struct m_inode * inode;
124
// 如果文件名对应的 i 节点不存在，则返回出错码。
125 if (!(inode=namei(filename)))
126 return -ENOENT;
// 若当前进程不是超级用户，则释放该 i 节点，返回出错码。
127 if (!suser()) {
128 iput(inode);
129 return -EACCES;
130 }
// 设置文件对应 i 节点的用户 id 和组 id，并置 i 节点已经修改标志，释放该 i 节点，返回 0。
131 inode->i_uid=uid;
132 inode->i_gid=gid;
133 inode->i_dirt=1;
134 iput(inode);
135 return 0;
136 }
137
//// 打开（或创建）文件系统调用函数。
// 参数 filename 是文件名，flag 是打开文件标志：只读 O_RDONLY、只写 O_WRONLY 或读写 O_RDWR，
// 以及 O_CREAT、O_EXCL、O_APPEND 等其它一些标志的组合，若本函数创建了一个新文件，则 mode
// 用于指定使用文件的许可属性，这些属性有 S_IRWXU(文件宿主具有读、写和执行权限)、S_IRUSR
// (用户具有读文件权限)、S_IRWXG(组成员具有读、写和执行权限)等等。对于新创建的文件，这些
// 属性只应用于将来对文件的访问，创建了只读文件的打开调用也将返回一个可读写的文件句柄。
// 若操作成功则返回文件句柄(文件描述符)，否则返回出错码。(参见 sys/stat.h, fcntl.h)
138 int sys_open(const char * filename,int flag,int mode)
139 {
140 struct m_inode * inode;
141 struct file * f;
142 int i,fd;
143
// 将用户设置的模式与进程的模式屏蔽码相与，产生许可的文件模式。
144 mode &= 0777 & ~current->umask;
// 搜索进程结构中文件结构指针数组，查找一个空闲项，若已经没有空闲项，则返回出错码。
145 for(fd=0 ; fd<NR_OPEN ; fd++)
146 if (!current->filp[fd])
147 break;
148 if (fd>=NR_OPEN)
149 return -EINVAL;
// 设置执行时关闭文件句柄位图，复位对应比特位。
150 current->close_on_exec &= ~(1<<fd);
// 令 f 指向文件表数组开始处。搜索空闲文件结构项(句柄引用计数为 0 的项)，若已经没有空闲
// 文件表结构项，则返回出错码。
151 f=0+file_table;
152 for (i=0 ; i<NR_FILE ; i++,f++)
153 if (!f->f_count) break;
154 if (i>=NR_FILE)
155 return -EINVAL;
// 让进程的对应文件句柄的文件结构指针指向搜索到的文件结构，并令句柄引用计数递增 1。
156 (current->filp[fd]=f)->f_count++;
// 调用函数执行打开操作，若返回值小于 0，则说明出错，释放刚申请到的文件结构，返回出错码。
157 if ((i=open_namei(filename,flag,mode,&inode))<0) {
158 current->filp[fd]=NULL;
159 f->f_count=0;
160 return i;
161 }
162 /* ttys are somewhat special (ttyxx major==4, tty major==5) */
/* ttys 有些特殊（ttyxx 主号==4，tty 主号==5）*/
// 如果是字符设备文件，那么如果设备号是 4 的话，则设置当前进程的 tty 号为该 i 节点的子设备号。
// 并设置当前进程 tty 对应的 tty 表项的父进程组号等于进程的父进程组号。
163 if (S_ISCHR(inode->i_mode))
164 if (MAJOR(inode->i_zone[0])==4) {
165 if (current->leader && current->tty<0) {
166 current->tty = MINOR(inode->i_zone[0]);
167 tty_table[current->tty].pgrp = current->pgrp;
168 }
// 否则如果该字符文件设备号是 5 的话，若当前进程没有 tty，则说明出错，释放 i 节点和申请到的
// 文件结构，返回出错码。
169 } else if (MAJOR(inode->i_zone[0])==5)
170 if (current->tty<0) {
171 iput(inode);
172 current->filp[fd]=NULL;
173 f->f_count=0;
174 return -EPERM;
175 }
176 /* Likewise with block-devices: check for floppy_change */
/* 同样对于块设备文件：需要检查盘片是否被更换 */
// 如果打开的是块设备文件，则检查盘片是否更换，若更换则需要是高速缓冲中对应该设备的所有
// 缓冲块失效。
177 if (S_ISBLK(inode->i_mode))
178 check_disk_change(inode->i_zone[0]);
// 初始化文件结构。置文件结构属性和标志，置句柄引用计数为 1，设置 i 节点字段，文件读写指针
// 初始化为 0。返回文件句柄。
179 f->f_mode = inode->i_mode;
180 f->f_flags = flag;
181 f->f_count = 1;
182 f->f_inode = inode;
183 f->f_pos = 0;
184 return (fd);
185 }
186
//// 创建文件系统调用函数。
// 参数 pathname 是路径名，mode 与上面的 sys_open()函数相同。
// 成功则返回文件句柄，否则返回出错码。
187 int sys_creat(const char * pathname, int mode)
188 {
189 return sys_open(pathname, O_CREAT | O_TRUNC, mode);
190 }
191
// 关闭文件系统调用函数。
// 参数 fd 是文件句柄。
// 成功则返回 0，否则返回出错码。
192 int sys_close(unsigned int fd)
193 {
194 struct file * filp;
195
// 若文件句柄值大于程序同时能打开的文件数，则返回出错码。
196 if (fd >= NR_OPEN)
197 return -EINVAL;
// 复位进程的执行时关闭文件句柄位图对应位。
198 current->close_on_exec &= ~(1<<fd);
// 若该文件句柄对应的文件结构指针是 NULL，则返回出错码。
199 if (!(filp = current->filp[fd]))
200 return -EINVAL;
// 置该文件句柄的文件结构指针为 NULL。
201 current->filp[fd] = NULL;
// 若在关闭文件之前，对应文件结构中的句柄引用计数已经为 0，则说明内核出错，死机。
202 if (filp->f_count == 0)
203 panic("Close: file count is 0");
// 否则将对应文件结构的句柄引用计数减 1，如果还不为 0，则返回 0（成功）。若已等于 0，说明该
// 文件已经没有句柄引用，则释放该文件 i 节点，返回 0。
204 if (--filp->f_count)
205 return (0);
206 iput(filp->f_inode);
207 return (0);
208 }
209