VFS：8.fd管理-fs/file.c源码阅读

Kernel源码笔记目录

源码基于4.19。

之前因为工作需要，把fs/file.c的源码通读了一遍，拿出来与大家分享。

file.c里主要是关于fd, fdtable的管理。读懂这个文件里的代码，对理解进程里关于文件的管理有很大的帮助。

1. 数据结构

struct fdtable {unsigned int max_fds; // fd数组最多能存的file数组struct file __rcu **fd; // struct file数组数量unsigned long *close_on_exec; // 执行时关闭位图unsigned long *open_fds; // 已打开文件位图unsigned long *full_fds_bits; // 一个long全部打开的位图, 每1位代表一个long数量的文件是否打开struct rcu_head rcu;
};

2. 源码

// 打开文件数量:默认1048576
unsigned int sysctl_nr_open __read_mostly = 1024*1024;
// 最小打开数量:64个
unsigned int sysctl_nr_open_min = BITS_PER_LONG;
/* our min() is unusable in constant expressions ;-/ */
#define __const_min(x, y) ((x) < (y) ? (x) : (y))
// 最大能打开的数量是int的最大值
unsigned int sysctl_nr_open_max =__const_min(INT_MAX, ~(size_t)0/sizeof(void *)) & -BITS_PER_LONG;// 释放fd表
static void __free_fdtable(struct fdtable *fdt)
{// 释放file数组kvfree(fdt->fd);// 释放位图. 这里释放的是close_on_exec, open_fds, full_fds_bits// 因为在分配内存的时候这三个内存是连续的,open_fds使用的是分配内存的第一块内存,// 所以只需要释放open_fdskvfree(fdt->open_fds);// 释放fdt本身kfree(fdt);
}// rcu释放回调
static void free_fdtable_rcu(struct rcu_head *rcu)
{__free_fdtable(container_of(rcu, struct fdtable, rcu));
}// 有多少个long的bit, 一个bit代表一个long
#define BITBIT_NR(nr)	BITS_TO_LONGS(BITS_TO_LONGS(nr))
// bitbit对应的内存大小
#define BITBIT_SIZE(nr)	(BITBIT_NR(nr) * sizeof(long))/** 从旧表向新表复制count个fd数量,并清除多余空间,如果有的话. 这里不复制file指针.* 调用的时候需要files的spinlock.*/
static void copy_fd_bitmaps(struct fdtable *nfdt, struct fdtable *ofdt,unsigned int count)
{unsigned int cpy, set;// 把count转成字节数量.这里count表示要复制多少个fd, 也就是多少位cpy = count / BITS_PER_BYTE;// 需要清0的字节数量set = (nfdt->max_fds - count) / BITS_PER_BYTE;// 复制老数据,并清空多余的数据memcpy(nfdt->open_fds, ofdt->open_fds, cpy);memset((char *)nfdt->open_fds + cpy, 0, set);memcpy(nfdt->close_on_exec, ofdt->close_on_exec, cpy);memset((char *)nfdt->close_on_exec + cpy, 0, set);// count对应的long-bit的数量cpy = BITBIT_SIZE(count);// 需要清空的long-bit数量set = BITBIT_SIZE(nfdt->max_fds) - cpy;// 同上, 复制+清空memcpy(nfdt->full_fds_bits, ofdt->full_fds_bits, cpy);memset((char *)nfdt->full_fds_bits + cpy, 0, set);
}/** 从旧表向新表复制所有的文件描述符, 扩展表并且清除多余空间. 调用时需要files->spinlock*/
static void copy_fdtable(struct fdtable *nfdt, struct fdtable *ofdt)
{size_t cpy, set;// 新表的最大值小于旧表的最大值, 怎么可能呢?BUG_ON(nfdt->max_fds < ofdt->max_fds);// 把要复制的file结构数量,转成字节cpy = ofdt->max_fds * sizeof(struct file *);// 需要清空的多余数量set = (nfdt->max_fds - ofdt->max_fds) * sizeof(struct file *);// 复制并清除memcpy(nfdt->fd, ofdt->fd, cpy);memset((char *)nfdt->fd + cpy, 0, set);// 复制位图copy_fd_bitmaps(nfdt, ofdt, ofdt->max_fds);
}// 分配fd表
static struct fdtable * alloc_fdtable(unsigned int nr)
{struct fdtable *fdt;void *data;/** 计算出多少在这个fdtable里我们想要支持多少个fd, 分配步骤取决于fdarray的大小, 因为它* 的增长远快于其他动态数据.我们试图装fdarray放入合适的page块里: 从1024B开始, 然后以2* 的幂增长.*/// todo: 没太看懂nr /= (1024 / sizeof(struct file *));nr = roundup_pow_of_two(nr + 1);nr *= (1024 / sizeof(struct file *));/** 注意: 如果 sysctl_nr_open 被设置的低于expand_files和这里的值, 上面算出来的nr可能会低* 于传进来的值. 在caller那里处理会更方便** 我们要确保nr保持为BITS_PER_LONG的倍数, 否则下面的位图会不好处理*/// 把nr的值限制到sysctl_nr_open范围内if (unlikely(nr > sysctl_nr_open))nr = ((sysctl_nr_open - 1) | (BITS_PER_LONG - 1)) + 1;// 分配 fdtfdt = kmalloc(sizeof(struct fdtable), GFP_KERNEL_ACCOUNT);if (!fdt)goto out;// 设置新的最大fd值fdt->max_fds = nr;// 分配fdarraydata = kvmalloc_array(nr, sizeof(struct file *), GFP_KERNEL_ACCOUNT);if (!data)goto out_fdt;fdt->fd = data;// 分配位图数据块, 这里分配的数量是2个nr的字节再加上bitbit-nr.前两个是给open_fds, close_on_exec用的// 最后的bitbit-nr是给full_fds_bits用的data = kvmalloc(max_t(size_t,2 * nr / BITS_PER_BYTE + BITBIT_SIZE(nr), L1_CACHE_BYTES),GFP_KERNEL_ACCOUNT);if (!data)goto out_arr;// 设置3个位图地址, 依次为: open_fds, close_on_exec, full_fds_bitsfdt->open_fds = data;data += nr / BITS_PER_BYTE;fdt->close_on_exec = data;data += nr / BITS_PER_BYTE;fdt->full_fds_bits = data;return fdt;out_arr:kvfree(fdt->fd);
out_fdt:kfree(fdt);
out:return NULL;
}/** 扩展文件描述符表* 这个函数将会分配一个新的fdtable, 以及给定大小的fd数组和fdset* 出错返回小于0的错误码, 1表示成功完成* 进这个函数的时候应该锁files->file_lock, 退出时也持有*/
static int expand_fdtable(struct files_struct *files, unsigned int nr)__releases(files->file_lock)__acquires(files->file_lock)
{struct fdtable *new_fdt, *cur_fdt;spin_unlock(&files->file_lock);// 分配一个fdtable对象, 及里面的数组, 位图new_fdt = alloc_fdtable(nr);/* 确保所有的__fd_install()能看见resize_in_progress* 或者已经完成了他们的 rcu_read_lock_sched() 代码区间*/if (atomic_read(&files->count) > 1)synchronize_rcu();// 加锁spin_lock(&files->file_lock);// todo: 为啥加锁之后才叛空if (!new_fdt)return -ENOMEM;/** 极端情况下不太可能的竞争 - sysctl_nr_open 在caller调用时和* alloc_fdtable之间被减小, 简单的处理它...*/if (unlikely(new_fdt->max_fds <= nr)) {__free_fdtable(new_fdt);return -EMFILE;}// 获取老的fdtcur_fdt = files_fdtable(files);// nr不可能小于之前的老的max_fdsBUG_ON(nr < cur_fdt->max_fds);// 从老的fdt给新的fdt复制数据copy_fdtable(new_fdt, cur_fdt);// 设置新表rcu_assign_pointer(files->fdt, new_fdt);// fdtab是静态数据, 如果是新分配的数据,才调用free_fdtable_rcu来释放内存if (cur_fdt != &files->fdtab)call_rcu(&cur_fdt->rcu, free_fdtable_rcu);/* 与__fd_install()里的smp_rmb()对应的 */smp_wmb();return 1;
}/** 扩展文件* 这个函数将扩展file数据结构, 如果需要的大小超过了当前的容量就扩展空间* 如果出错返回小于0的错误码, 0表示什么都没做, 1表示文件被扩展了而且程序可能会被阻塞* 进这个函数应该锁files->file_lock, 一直到退出也会持有锁*/
static int expand_files(struct files_struct *files, unsigned int nr)__releases(files->file_lock)__acquires(files->file_lock)
{struct fdtable *fdt;int expanded = 0;repeat:// 获取fdtfdt = files_fdtable(files);/* 小于max_fds就不用扩展了, 返回0 */if (nr < fdt->max_fds)return expanded;/* 超过了最大打开数量, 也不能扩展 */if (nr >= sysctl_nr_open)return -EMFILE;// 当前文件正在扩展中if (unlikely(files->resize_in_progress)) {// 先释放锁spin_unlock(&files->file_lock);expanded = 1;// 等待扩展结束wait_event(files->resize_wait, !files->resize_in_progress);// 加锁之后再重试.spin_lock(&files->file_lock);goto repeat;}// 正在扩展标志files->resize_in_progress = true;// 扩展表expanded = expand_fdtable(files, nr);// 取消标志files->resize_in_progress = false;// 唤醒所有等待的人, 与上面的等待对应wake_up_all(&files->resize_wait);return expanded;
}// 设置执行时关闭位
static inline void __set_close_on_exec(unsigned int fd, struct fdtable *fdt)
{__set_bit(fd, fdt->close_on_exec);
}// 清除执行时关闭位
static inline void __clear_close_on_exec(unsigned int fd, struct fdtable *fdt)
{if (test_bit(fd, fdt->close_on_exec))__clear_bit(fd, fdt->close_on_exec);
}// 设置打开文件位
static inline void __set_open_fd(unsigned int fd, struct fdtable *fdt)
{// 先设置打开文件位__set_bit(fd, fdt->open_fds);// 该位对应的longfd /= BITS_PER_LONG;// full_fds_bits里的每1位表示 open_fds 里的一整个long是否被设置,// 在查找fd时,可以加速查找// 如果整个long都被设置了,则设置full_fdsif (!~fdt->open_fds[fd])__set_bit(fd, fdt->full_fds_bits);
}// 清除打开文件位
static inline void __clear_open_fd(unsigned int fd, struct fdtable *fdt)
{// 清除已打开位__clear_bit(fd, fdt->open_fds);// 直接清除对应的full_fds, 因为其中1位置空, full_fds肯定不会是全1__clear_bit(fd / BITS_PER_LONG, fdt->full_fds_bits);
}// 统计打开文件数量
static unsigned int count_open_files(struct fdtable *fdt)
{// 最大的fdsunsigned int size = fdt->max_fds;unsigned int i;// 找到最后被设置的fdfor (i = size / BITS_PER_LONG; i > 0; ) {if (fdt->open_fds[--i])break;}// 总的已打开文件数// todo: 这个判断好像不准吧，并不是每个long全设置i = (i + 1) * BITS_PER_LONG;return i;
}// 检查fdtable的大小
static unsigned int sane_fdtable_size(struct fdtable *fdt, unsigned int max_fds)
{unsigned int count;// 已打开文件数量count = count_open_files(fdt);// NR_OPEN_DEFAULT 是 64if (max_fds < NR_OPEN_DEFAULT)max_fds = NR_OPEN_DEFAULT;// 选一个较小值return min(count, max_fds);
}/** 分配一个新的files_struct结构，并从传进来的老的files_struct结构里复制* 内容到新分配的结构里.* 当返回NULL时, errorp里会有值*/
struct files_struct *dup_fd(struct files_struct *oldf, unsigned int max_fds, int *errorp)
{struct files_struct *newf;struct file **old_fds, **new_fds;unsigned int open_files, i;struct fdtable *old_fdt, *new_fdt;*errorp = -ENOMEM;// 分配一个新的files_structnewf = kmem_cache_alloc(files_cachep, GFP_KERNEL);if (!newf)goto out;// 设置引用为1atomic_set(&newf->count, 1);// 初始化newf里的各种字段spin_lock_init(&newf->file_lock);newf->resize_in_progress = false;init_waitqueue_head(&newf->resize_wait);newf->next_fd = 0;new_fdt = &newf->fdtab;new_fdt->max_fds = NR_OPEN_DEFAULT;new_fdt->close_on_exec = newf->close_on_exec_init;new_fdt->open_fds = newf->open_fds_init;new_fdt->full_fds_bits = newf->full_fds_bits_init;new_fdt->fd = &newf->fd_array[0];// 注意:这里加的是oldf的锁spin_lock(&oldf->file_lock);// 这个是使用rcu获取old_fdtold_fdt = files_fdtable(oldf);// old_fdt里已打开的文件数量open_files = sane_fdtable_size(old_fdt, max_fds);/** 检查我们是否需要分配一个新的更大的fd数组和fd集合*/// 已打开的文件数量大于新的max_fds才会分配, 因为上面是刚分配的, 所以max_fds是64// 这个循环只有在非常极端的情况下才会走, 在调用这个函数期间, old_fdt发生了改变while (unlikely(open_files > new_fdt->max_fds)) {// 因为new_fdt还没用,所以不用加锁spin_unlock(&oldf->file_lock);// 如果new_fdt是动态分配的,则释放它的内存if (new_fdt != &newf->fdtab)__free_fdtable(new_fdt);// 新分配一个fdt, todo: 为什么要open_files - 1 ?new_fdt = alloc_fdtable(open_files - 1);// 分配失败if (!new_fdt) {*errorp = -ENOMEM;goto out_release;}/* 超过了 sysctl_nr_open 的数量, 直接返回 */if (unlikely(new_fdt->max_fds < open_files)) {__free_fdtable(new_fdt);*errorp = -EMFILE;goto out_release;}/** 重新获取oldf的锁, 因为我们要用oldf的fdtable, 因为fdt里的文件数* 可能已经变了, 我们需要最新的指针*/spin_lock(&oldf->file_lock);old_fdt = files_fdtable(oldf);// 再获取已打开文件的数量open_files = sane_fdtable_size(old_fdt, max_fds);}// 走到这儿的时候, oldf的锁还在// 复制位图数据copy_fd_bitmaps(new_fdt, old_fdt, open_files);// 新旧老的fd数组old_fds = old_fdt->fd;new_fds = new_fdt->fd;// 复制file指针for (i = open_files; i != 0; i--) {struct file *f = *old_fds++;// 如果file有值,就增加它的指针if (f) {get_file(f);} else {/** 有可能位图上有值, 但数组里却是空的, 有可能并发线程只到达了* open的一半,if a sibling thread 所以确保在新的进程里fd* 是可用的.* todo: 不用并发,这里也有可能是空呀!!*/__clear_open_fd(open_files - i, new_fdt);}// 给新的数组里设置文件的指针, 有可能是NULLrcu_assign_pointer(*new_fds++, f);}spin_unlock(&oldf->file_lock);// 清除其余的字节memset(new_fds, 0, (new_fdt->max_fds - open_files) * sizeof(struct file *));// 重新设置newf的fdtrcu_assign_pointer(newf->fdt, new_fdt);return newf;out_release:kmem_cache_free(files_cachep, newf);
out:return NULL;
}// 关闭fdt里的所有文件
static struct fdtable *close_files(struct files_struct * files)
{/** 在这里不用rcu lock和file_lock是安全的, 因为这里是最后一次引用* files这个结构*/struct fdtable *fdt = rcu_dereference_raw(files->fdt);unsigned int i, j = 0;// 遍历每一个位, 然后关闭文件for (;;) {unsigned long set;// i保存的是fd, j保存的是第几个longi = j * BITS_PER_LONG;// 大于max则退出if (i >= fdt->max_fds)break;// 取出第j个longset = fdt->open_fds[j++];// 遍历该long里每一位while (set) {// 如果这一位上有值if (set & 1) {// 给fd[i]设置NULL, 并返回filestruct file * file = xchg(&fdt->fd[i], NULL);// 关闭文件if (file) {filp_close(file, files);cond_resched();}}// fd递增i++;// 位图右移set >>= 1;}}return fdt;
}// 获取进程的files_struct
struct files_struct *get_files_struct(struct task_struct *task)
{struct files_struct *files;// 锁的是task->alloc_locktask_lock(task);// 递增引用计数files = task->files;if (files)atomic_inc(&files->count);task_unlock(task);return files;
}// 释放进程的files_struct
void put_files_struct(struct files_struct *files)
{// 减少文件引用,如果达到0, 则释放if (atomic_dec_and_test(&files->count)) {// 关闭所有文件struct fdtable *fdt = close_files(files);// 如果不是数据结构里内置的fdt, 则释放其内存if (fdt != &files->fdtab)__free_fdtable(fdt);// 释放files内存kmem_cache_free(files_cachep, files);}
}// 替换进程里的files结构
void reset_files_struct(struct files_struct *files)
{struct task_struct *tsk = current;struct files_struct *old;// 老的filesold = tsk->files;// 锁住进程task_lock(tsk);// 设置新的filestsk->files = files;task_unlock(tsk);// 释放老的filesput_files_struct(old);
}// 退出进程的files
void exit_files(struct task_struct *tsk)
{// 进程的filesstruct files_struct * files = tsk->files;if (files) {// 锁住进程task_lock(tsk);// 进程的file置空tsk->files = NULL;task_unlock(tsk);// 释放filesput_files_struct(files);}
}// init进程用的, 设置了fdt指向内部的数据, 初始化一些锁
struct files_struct init_files = {.count		= ATOMIC_INIT(1),.fdt		= &init_files.fdtab,.fdtab		= {.max_fds	= NR_OPEN_DEFAULT,.fd		= &init_files.fd_array[0],.close_on_exec	= init_files.close_on_exec_init,.open_fds	= init_files.open_fds_init,.full_fds_bits	= init_files.full_fds_bits_init,},.file_lock	= __SPIN_LOCK_UNLOCKED(init_files.file_lock),.resize_wait	= __WAIT_QUEUE_HEAD_INITIALIZER(init_files.resize_wait),
};// 找下一个fd, start是起点
static unsigned int find_next_fd(struct fdtable *fdt, unsigned int start)
{// 当前fdt最大支持的fdunsigned int maxfd = fdt->max_fds;// 有多少个longunsigned int maxbit = maxfd / BITS_PER_LONG;// 起点所在的longunsigned int bitbit = start / BITS_PER_LONG;// 先从full里找一个空的位, full里一个位为0, 说明整个long还没有分配完// full里一位代表一个long, 所以最后乘以 BITS_PER_LONGbitbit = find_next_zero_bit(fdt->full_fds_bits, maxbit, bitbit) * BITS_PER_LONG;// 大于maxfd说明所有位都用了if (bitbit > maxfd)return maxfd;// 如果大于start, 则从bitbit开始. 说明start已经被用了if (bitbit > start)start = bitbit;// 在open里从start开始找一个空闲的位return find_next_zero_bit(fdt->open_fds, maxfd, start);
}/** 分配一个文件描述符并置位*/
int __alloc_fd(struct files_struct *files,unsigned start, unsigned end, unsigned flags)
{unsigned int fd;int error;struct fdtable *fdt;spin_lock(&files->file_lock);
repeat:fdt = files_fdtable(files);// 从start开始找fd = start;// 如果小于next, 则从next开始找// next里放的是下一个待分配的fd, 加速查找if (fd < files->next_fd)fd = files->next_fd;// 找下一个fdif (fd < fdt->max_fds)fd = find_next_fd(fdt, fd);/** 注意: 对于clone的任务共享files结构, 这个测试将会* 限制总的打开文件的数量*/error = -EMFILE;if (fd >= end)goto out;// 扩展files结构error = expand_files(files, fd);// 小于0表示出错了if (error < 0)goto out;/** 大于0说明扩展了, 有可能会阻塞, 需要重试* 因为fdt有可能已经变了*/if (error)goto repeat;// next_fd置为start的下一位, 当然下一位有可能已经用了if (start <= files->next_fd)files->next_fd = fd + 1;// 在open位图上设置fd为1__set_open_fd(fd, fdt);// 根据是否有执行时关闭, 在相应位图上执行操作if (flags & O_CLOEXEC)__set_close_on_exec(fd, fdt);else__clear_close_on_exec(fd, fdt);// 设置结果error = fd;// 如果不为空, 则强制置空
#if 1/* Sanity check */if (rcu_access_pointer(fdt->fd[fd]) != NULL) {printk(KERN_WARNING "alloc_fd: slot %d not NULL!\n", fd);rcu_assign_pointer(fdt->fd[fd], NULL);}
#endifout:spin_unlock(&files->file_lock);return error;
}// 分配fd, 这个可以指定搜索的起点
static int alloc_fd(unsigned start, unsigned flags)
{// 限制值为rlimit(RLIMIT_NOFILE): 进程可打开的文件数量return __alloc_fd(current->files, start, rlimit(RLIMIT_NOFILE), flags);
}// 获取未使用的fd, 这个从0开始搜索
int __get_unused_fd_flags(unsigned flags, unsigned long nofile)
{return __alloc_fd(current->files, 0, nofile, flags);
}// 获取未使用的fd, 这个从0开始搜索, 限制是rlimit(RLIMIT_NOFILE), 
int get_unused_fd_flags(unsigned flags)
{return __get_unused_fd_flags(flags, rlimit(RLIMIT_NOFILE));
}
EXPORT_SYMBOL(get_unused_fd_flags);// 释放未使用的fd
static void __put_unused_fd(struct files_struct *files, unsigned int fd)
{// 获取fdt, 使用files_fdtable必须持有file_lock锁struct fdtable *fdt = files_fdtable(files);// 清除open和full上的位图__clear_open_fd(fd, fdt);// 设置next_fd, 如果小于next的话if (fd < files->next_fd)files->next_fd = fd;
}// 导出接口
void put_unused_fd(unsigned int fd)
{struct files_struct *files = current->files;// 加锁之后直接调用上面的函数spin_lock(&files->file_lock);__put_unused_fd(files, fd);spin_unlock(&files->file_lock);
}
EXPORT_SYMBOL(put_unused_fd);/** 在fd数组安装一个文件指针** vfs里充满了在设置位图和安装文件之间不持有files_lock的地方.* 在任何一点, 我们都很容易受到dup2在我们之间安装一个文件到数组里.* 此时,我们需要检测这种情况, 并且要fput file结构** 它应该永远不发生. 如果我们允许dup2这样做, 糟糕的事将会发生.** 注意: __fd_install()是非常低级的函数; 不要用它, 除非API不好用.* files必须是current->files或者是别人从get_files_struct(current)获取的* 否则将会发生不好的事. 通常你应该使用fd_install()来代替.*/void __fd_install(struct files_struct *files, unsigned int fd,struct file *file)
{struct fdtable *fdt;// rcu锁, 禁用了中断rcu_read_lock_sched();// 如果files正在扩容if (unlikely(files->resize_in_progress)) {// 释放rcu锁rcu_read_unlock_sched();// 锁住file_lock. 因为扩容时会上锁, 所以这里也要上锁spin_lock(&files->file_lock);// 获取新的fdtfdt = files_fdtable(files);// fd应该是空的, 否则就出错了BUG_ON(fdt->fd[fd] != NULL);// 设置file到fd位置rcu_assign_pointer(fdt->fd[fd], file);spin_unlock(&files->file_lock);return;}// 一般情况用, rcu就够了/* 与 expand_fdtable() 里的smp_wmb() 对应 */smp_rmb();// 取出fdtfdt = rcu_dereference_sched(files->fdt);// 必须是NULLBUG_ON(fdt->fd[fd] != NULL);// 设置对应指针rcu_assign_pointer(fdt->fd[fd], file);rcu_read_unlock_sched();
}/** 这个将会消耗文件的引用计数, 所以调用者应该将其视为调用了fput(file)* This consumes the "file" refcount, so callers should treat it* as if they had called fput(file).*/
void fd_install(unsigned int fd, struct file *file)
{__fd_install(current->files, fd, file);
}EXPORT_SYMBOL(fd_install);// 根据fd获取一个文件, 并将fd的位置置空
static struct file *pick_file(struct files_struct *files, unsigned fd)
{struct file *file = NULL;struct fdtable *fdt;// 上锁, 修改fd数组的都要上锁spin_lock(&files->file_lock);// 获取fdtfdt = files_fdtable(files);// 大于max出错if (fd >= fdt->max_fds)goto out_unlock;// 获取文件file = fdt->fd[fd];// 文件为空if (!file)goto out_unlock;// 把fd置空rcu_assign_pointer(fdt->fd[fd], NULL);// 释放fd__put_unused_fd(files, fd);out_unlock:spin_unlock(&files->file_lock);return file;
}/** 与 __alloc_fd()/__fd_install() 的警告相同*/
int __close_fd(struct files_struct *files, unsigned fd)
{struct file *file;// 先pick文件, pick的同时会释放fd和置空数组file = pick_file(files, fd);// 文件为空返回BADFif (!file)return -EBADF;// 关闭文件return filp_close(file, files);
}
EXPORT_SYMBOL(__close_fd); /* 给 ksys_close() 用*//*** __close_range() - 关闭指定范围的文件描述符, close_range syscall** @fd:     要关闭的开始fd* @max_fd: 最后一个fd (包含)** 此函数关闭指定范围内的fd. 从start到max_fd(包含)都会被关闭*/
int __close_range(unsigned fd, unsigned max_fd, unsigned int flags)
{unsigned int cur_max;struct task_struct *me = current;struct files_struct *cur_fds = me->files, *fds = NULL;// flags如果有除CLOSE_RANGE_UNSHARE的标志都会报错,// 这个标志只有测试用例用到if (flags & ~CLOSE_RANGE_UNSHARE)return -EINVAL;// 起点不能大于结尾if (fd > max_fd)return -EINVAL;// 获取当前fd最大值rcu_read_lock();cur_max = files_fdtable(cur_fds)->max_fds;rcu_read_unlock();// 最大的大效fd, 因为fd是从0开始cur_max--;// todo: unshare后面看if (flags & CLOSE_RANGE_UNSHARE) {int ret;unsigned int max_unshare_fds = NR_OPEN_MAX;/** If the requested range is greater than the current maximum,* we're closing everything so only copy all file descriptors* beneath the lowest file descriptor.*/if (max_fd >= cur_max)max_unshare_fds = fd;ret = unshare_fd(CLONE_FILES, max_unshare_fds, &fds);if (ret)return ret;/** We used to share our file descriptor table, and have now* created a private one, make sure we're using it below.*/if (fds)swap(cur_fds, fds);}// 将max_fd规范化max_fd = min(max_fd, cur_max);// 从起点到终点关闭文件while (fd <= max_fd) {struct file *file;// 取出一个文件,并把数组里置空file = pick_file(cur_fds, fd++);if (!file)continue;// 关闭文件filp_close(file, cur_fds);cond_resched();}// 恢复fds, 这个只有testing用到if (fds) {/** We're done closing the files we were supposed to. Time to install* the new file descriptor table and drop the old one.*/task_lock(me);me->files = cur_fds;task_unlock(me);put_files_struct(fds);}return 0;
}/** __close_fd的变体, 会获取文件一个引用** 调用者必须确保filp_close()被调用, 然后fput*/
int __close_fd_get_file(unsigned int fd, struct file **res)
{struct files_struct *files = current->files;struct file *file;struct fdtable *fdt;spin_lock(&files->file_lock);fdt = files_fdtable(files);// fd值无效if (fd >= fdt->max_fds)goto out_unlock;// 取出文件file = fdt->fd[fd];if (!file)goto out_unlock;// 数组置空rcu_assign_pointer(fdt->fd[fd], NULL);// 释放fd__put_unused_fd(files, fd);spin_unlock(&files->file_lock);// 获取文件引用get_file(file);*res = file;return 0;out_unlock:spin_unlock(&files->file_lock);*res = NULL;return -ENOENT;
}void do_close_on_exec(struct files_struct *files)
{unsigned i;struct fdtable *fdt;// 加锁spin_lock(&files->file_lock);for (i = 0; ; i++) {unsigned long set;unsigned fd = i * BITS_PER_LONG;fdt = files_fdtable(files);// fd越界if (fd >= fdt->max_fds)break;// 取出一个longset = fdt->close_on_exec[i];if (!set)continue;// 然后把这个long置0fdt->close_on_exec[i] = 0;// 关闭这个long里的文件for ( ; set ; fd++, set >>= 1) {struct file *file;// 这一位没有刚退出if (!(set & 1))continue;// 取出文件file = fdt->fd[fd];if (!file)continue;// 该位置空rcu_assign_pointer(fdt->fd[fd], NULL);// 释放fd__put_unused_fd(files, fd);// 关闭文件要释放锁spin_unlock(&files->file_lock);// 关闭文件filp_close(file, files);cond_resched();// 调度之后重新加锁spin_lock(&files->file_lock);}}spin_unlock(&files->file_lock);
}// 获取file并增加引用, 全使用的rcu操作
static inline struct file *__fget_files_rcu(struct files_struct *files,unsigned int fd, fmode_t mask, unsigned int refs)
{for (;;) {struct file *file;// 取出fdtstruct fdtable *fdt = rcu_dereference_raw(files->fdt);struct file __rcu **fdentry;// fd越界if (unlikely(fd >= fdt->max_fds))return NULL;// 获取存放file的数组地址, array_index_nospec是把fd规范到max_fdsfdentry = fdt->fd + array_index_nospec(fd, fdt->max_fds);// 取出filefile = rcu_dereference_raw(*fdentry);// 为空直接返回if (unlikely(!file))return NULL;// 有掩码的值, 也返回if (unlikely(file->f_mode & mask))return NULL;/** 我们有了一个文件指针. 然而,因为我们用的是rcu无锁, 可能会与* 已关闭的文件产生竞争.** 有下面2种竞争情况:**  (a) 文件指针已经到0, get_file_rcu_many() 会失败, *	则继续重试*/if (unlikely(!get_file_rcu_many(file, refs)))continue;/**  (b) fdtable或者file entry已经变了.*       注意: 我们不用重新检查fdt->fd指针有没有变, 因为它和*	fdt相关** 如果是这样,我们需要释放引用然后重试*/if (unlikely(rcu_dereference_raw(files->fdt) != fdt) ||unlikely(rcu_dereference_raw(*fdentry) != file)) {fput_many(file, refs);continue;}// 文件正常, 返回之return file;}
}static struct file *__fget_files(struct files_struct *files, unsigned int fd,fmode_t mask, unsigned int refs)
{struct file *file;// 加rcu锁之后获取引用rcu_read_lock();file = __fget_files_rcu(files, fd, mask, refs);rcu_read_unlock();return file;
}// 从当前进程获取fd 文件, 并增加refs指针
static inline struct file *__fget(unsigned int fd, fmode_t mask,unsigned int refs)
{return __fget_files(current->files, fd, mask, refs);
}// 掩码值传的是FMODE_PATH
struct file *fget_many(unsigned int fd, unsigned int refs)
{return __fget(fd, FMODE_PATH, refs);
}// 只获取file引用一次
struct file *fget(unsigned int fd)
{return __fget(fd, FMODE_PATH, 1);
}
EXPORT_SYMBOL(fget);// 只获取file引用一次, mode是0
struct file *fget_raw(unsigned int fd)
{return __fget(fd, 0, 1);
}
EXPORT_SYMBOL(fget_raw);// 从指定进程获取fd对应的文件
struct file *fget_task(struct task_struct *task, unsigned int fd)
{struct file *file = NULL;// 锁住task并获取文件, mode是0, 引用是1task_lock(task);if (task->files)file = __fget_files(task->files, fd, 0, 1);task_unlock(task);return file;
}/** 轻量级文件查找 - 如果文件没有共享,则不会增加引用计数** 你可以用它代替fget, 如果你满足下面条件:* 1) 你必须在退出系统调用前调用fput_light, 并且把控制权交给用户空间(例如: 你不能在返回用户空间之后还保留file *) * 2) 你不能在fget_light和fput_light之间调用filp_close(file*)* 3) 你不能在fget_light和fput_light之间clone当前进程** 返回值是文件的值和调用fput_light需要的flag*/
static unsigned long __fget_light(unsigned int fd, fmode_t mask)
{struct files_struct *files = current->files;struct file *file;if (atomic_read(&files->count) == 1) {// 文件数量为1, 表示files只在当前进程使用, 没有与其他人共享// 直接调用fcheck就行file = __fcheck_files(files, fd);// 文件为空if (!file || unlikely(file->f_mode & mask))return 0;// 返回文件的值return (unsigned long)file;} else {// files与其他进程共享file = __fget(fd, mask, 1);if (!file)return 0;// 在文件里还要加个标志return FDPUT_FPUT | (unsigned long)file;}
}// mask是FMODE_PATH, 表示文件不能带有这种标志
unsigned long __fdget(unsigned int fd)
{return __fget_light(fd, FMODE_PATH);
}
EXPORT_SYMBOL(__fdget);// mask是0, 表示可以获取所有类型的文件
unsigned long __fdget_raw(unsigned int fd)
{return __fget_light(fd, 0);
}unsigned long __fdget_pos(unsigned int fd)
{// 获取文件unsigned long v = __fdget(fd);// 取出真正的文件值struct file *file = (struct file *)(v & ~3);// 若文件模式有FMODE_ATOMIC_POSif (file && (file->f_mode & FMODE_ATOMIC_POS)) {// 文件引用数量大于1, 则需要加pos锁if (file_count(file) > 1) {// 给fput的标志, 要解pos锁v |= FDPUT_POS_UNLOCK;mutex_lock(&file->f_pos_lock);}}return v;
}// 解锁pos锁
void __f_unlock_pos(struct file *f)
{mutex_unlock(&f->f_pos_lock);
}/** 我们只在有线程或者可能与其他进程共享file时才锁f_pos.* 在所有的情况里我们将增加文件计数(通过fdget或fork完成).*/void set_close_on_exec(unsigned int fd, int flag)
{struct files_struct *files = current->files;struct fdtable *fdt;spin_lock(&files->file_lock);// 获取fdtfdt = files_fdtable(files);// flag: 1设置, 0取消, 这里面只是简单的设置了fd相应的位if (flag)__set_close_on_exec(fd, fdt);else__clear_close_on_exec(fd, fdt);spin_unlock(&files->file_lock);
}bool get_close_on_exec(unsigned int fd)
{struct files_struct *files = current->files;struct fdtable *fdt;bool res;// 读fdt时, 都要加rcu锁rcu_read_lock();fdt = files_fdtable(files);// 获取fd对的执行时关闭状态res = close_on_exec(fd, fdt);rcu_read_unlock();return res;
}static int do_dup2(struct files_struct *files,struct file *file, unsigned fd, unsigned flags)
__releases(&files->file_lock)
{struct file *tofree;struct fdtable *fdt;/** 我们需要检测尝试通过dup2过度分配但是还没完成的fd.* 注意: OpenBSD 在他们的fget里避免了它, 以一些额外的工作为代价, 他们在获取fd之后,* 立即插入文件, 并标记为larval如果需要更多的工作. 确保fget对待larval文件为不在位* 可能很有趣, 但是当fget里的额外工作是轻微的, 隐式的加锁和open里等量的工作相关路径在* vfs里不是这样的.FreeBSD在同样的情况下会失败返回-EBADF, NetBSD会死锁.* 这些都超出了POSIX和SUS的范围, 他们都没有考虑共享fdtable, 并且如果没有共享, 这些情况* 就不会出现.*/fdt = files_fdtable(files);// 获取fd上的文件, 如果fd上有文件会关闭它tofree = fdt->fd[fd];// 关闭的文件是空, 但是fd是打开的, 则返回busyif (!tofree && fd_is_open(fd, fdt))goto Ebusy;// 增加文件引用get_file(file);// 设置fd为file指针rcu_assign_pointer(fdt->fd[fd], file);// 设置fd打开__set_open_fd(fd, fdt);// 关闭或打开fd的执行时关闭if (flags & O_CLOEXEC)__set_close_on_exec(fd, fdt);else__clear_close_on_exec(fd, fdt);spin_unlock(&files->file_lock);// 如果需要关闭, 则关闭旧文件if (tofree)filp_close(tofree, files);return fd;Ebusy:spin_unlock(&files->file_lock);return -EBUSY;
}int replace_fd(unsigned fd, struct file *file, unsigned flags)
{int err;struct files_struct *files = current->files;// 如果文件为空, 说明需要把fd上的文件清除,// 则关闭fd上的文件, 返回if (!file)return __close_fd(files, fd);// fd超过了进程允许打开的文件数if (fd >= rlimit(RLIMIT_NOFILE))return -EBADF;spin_lock(&files->file_lock);// 先检测是否需要扩容err = expand_files(files, fd);if (unlikely(err < 0))goto out_unlock;// 调dup2return do_dup2(files, file, fd, flags);out_unlock:spin_unlock(&files->file_lock);return err;
}/*** __receive_fd() - 安装收到的文件到fdtable** @fd: 要安装的fd (如果是负数, 一个新的fd将会被分配)* @file: 从其他进程收到的file结构* @ufd: 用户空间的指针, 用来写入新的fd, 返回给用户* @o_flags: 应用到新fd的文件上的 O_* 标志** 安装一个收到的文件到fdtable, 进行适当的检查和引用计数更新* 可选的, 如果 ufd 不为空, 会将新的fd写入其中** 这个函数自己会处理传入文件的引用计数** 返回新安装的fd, 或者负的错误号*/
int __receive_fd(int fd, struct file *file, int __user *ufd, unsigned int o_flags)
{int new_fd;int error;// 安全检查error = security_file_receive(file);if (error)return error;// 如果fd小于0, 则分配一个新的fdif (fd < 0) {new_fd = get_unused_fd_flags(o_flags);// 分配fd失败直接返回if (new_fd < 0)return new_fd;} else {new_fd = fd;}// 如果ufd不为空, 则把newfd写入到ufd里if (ufd) {error = put_user(new_fd, ufd);// 出错, 如果是新分配的fd, 则释放后返回if (error) {if (fd < 0)put_unused_fd(new_fd);return error;}}if (fd < 0) { // fd < 0, 说明是新分配的fd, 则直接安装, 并增加文件引用fd_install(new_fd, get_file(file));} else {// 否则替换newfd上的文件error = replace_fd(new_fd, file, o_flags);if (error)return error;}// 如果file是socket, 则增加引用计数__receive_sock(file);return new_fd;
}static int ksys_dup3(unsigned int oldfd, unsigned int newfd, int flags)
{int err = -EBADF;struct file *file;struct files_struct *files = current->files;// flags只能指定O_CLOEXEC标志if ((flags & ~O_CLOEXEC) != 0)return -EINVAL;// 两个fd不能一样if (unlikely(oldfd == newfd))return -EINVAL;// newfd不能超过进程的限制if (newfd >= rlimit(RLIMIT_NOFILE))return -EBADF;spin_lock(&files->file_lock);// 新fd可能需要扩容err = expand_files(files, newfd);// 获取oldfd的文件file = fcheck(oldfd);// fd上没有文件if (unlikely(!file))goto Ebadf;// 其他错误if (unlikely(err < 0)) {// 超过文件最大值if (err == -EMFILE)goto Ebadf;goto out_unlock;}// 把该oldfd的文件安装在newfd上return do_dup2(files, file, newfd, flags);Ebadf:err = -EBADF;
out_unlock:spin_unlock(&files->file_lock);return err;
}// 同dup2, 可以指定标志
SYSCALL_DEFINE3(dup3, unsigned int, oldfd, unsigned int, newfd, int, flags)
{return ksys_dup3(oldfd, newfd, flags);
}static inline struct file *fcheck_files(struct files_struct *files, unsigned int fd)
{// 调用这个函数必须要rcu读锁, 并且锁住file_lockRCU_LOCKDEP_WARN(!rcu_read_lock_held() &&!lockdep_is_held(&files->file_lock),"suspicious rcu_dereference_check() usage");return __fcheck_files(files, fd);
}// newfd与oldfd指向同一文件, 如果newfd已经打开, 则会把它先关闭
SYSCALL_DEFINE2(dup2, unsigned int, oldfd, unsigned int, newfd)
{// 新老fd相同也是允许的if (unlikely(newfd == oldfd)) {struct files_struct *files = current->files;int retval = oldfd;rcu_read_lock();// 老文件为NULL, 返回错误if (!fcheck_files(files, oldfd))retval = -EBADF;rcu_read_unlock();return retval;}// 调dup3, flag是0return ksys_dup3(oldfd, newfd, 0);
}// 分配一个新的fd, 新fd也指向fildes的文件
SYSCALL_DEFINE1(dup, unsigned int, fildes)
{int ret = -EBADF;// 获取fildes的文件引用struct file *file = fget_raw(fildes);// 若文件存在if (file) {// 获取一个没用的fdret = get_unused_fd_flags(0);if (ret >= 0)// 把file安装到fd的位置fd_install(ret, file);else// 获取fd出错, 释放文件fput(file);}return ret;
}// dup时指定了fd的起点
int f_dupfd(unsigned int from, struct file *file, unsigned flags)
{int err;// 不能大于最大允许值if (from >= rlimit(RLIMIT_NOFILE))return -EINVAL;// 分配一个fderr = alloc_fd(from, flags);// 分配成功, 增加文件计数并安装if (err >= 0) {get_file(file);fd_install(err, file);}return err;
}/*
* 遍历files里的文件
* n: 遍历起点
* f: 回调函数
* p: 回传给函数的数据
*/
int iterate_fd(struct files_struct *files, unsigned n,int (*f)(const void *, struct file *, unsigned),const void *p)
{struct fdtable *fdt;int res = 0;// files为空if (!files)return 0;spin_lock(&files->file_lock);// 从n开始遍历fdt里的所有fdfor (fdt = files_fdtable(files); n < fdt->max_fds; n++) {struct file *file;// 获取filefile = rcu_dereference_check_fdtable(files, fdt->fd[n]);if (!file)continue;// 调用回调函数res = f(p, file, n);// 返回错误退出if (res)break;}spin_unlock(&files->file_lock);return res;
}
EXPORT_SYMBOL(iterate_fd);