proc_vfs.c 文件参考

浏览源代码.

函数
static struct ProcDirEntry *	VnodeToEntry (struct Vnode *node)
	通过节点获取私有内存对象,注意要充分理解 node->data 的作用,那是个可以通天的神奇变量. 更多...
static struct Vnode *	EntryToVnode (struct ProcDirEntry *entry)
	创建节点,通过实体对象转成vnode节点,如此达到统一管理的目的. 更多...
static int	EntryMatch (const char *name, int len, const struct ProcDirEntry *pn)
	实体匹配,通过名称匹配 更多...
int	VfsProcfsTruncate (struct Vnode *pVnode, off_t len)
int	VfsProcfsCreate (struct Vnode *parent, const char *name, int mode, struct Vnode **vnode)
	创建vnode节点,并绑定私有内容项 更多...
int	VfsProcfsRead (struct file *filep, char *buffer, size_t buflen)
int	VfsProcfsWrite (struct file *filep, const char *buffer, size_t buflen)
int	VfsProcfsLookup (struct Vnode *parent, const char *name, int len, struct Vnode **vpp)
int	VfsProcfsMount (struct Mount *mnt, struct Vnode *device, const void *data)
	挂s载实现,找个vnode节点挂上去 更多...
int	VfsProcfsUnmount (void *handle, struct Vnode **blkdriver)
int	VfsProcfsStat (struct Vnode *node, struct stat *buf)
int	VfsProcfsReaddir (struct Vnode *node, struct fs_dirent_s *dir)
int	VfsProcfsOpendir (struct Vnode *node, struct fs_dirent_s *dir)
	proc 打开目录 更多...
int	VfsProcfsOpen (struct file *filep)
	proc 打开文件 更多...
int	VfsProcfsClose (struct file *filep)
int	VfsProcfsStatfs (struct Mount *mnt, struct statfs *buf)
	统计信息接口,简单实现 更多...
int	VfsProcfsClosedir (struct Vnode *vp, struct fs_dirent_s *dir)
	FSMAP_ENTRY (procfs_fsmap, "procfs", procfs_operations, FALSE, FALSE)

变量
static struct VnodeOps	g_procfsVops
static struct file_operations_vfs	g_procfsFops
	proc 文件系统 更多...
const struct MountOps	procfs_operations
	proc 对 MountOps 接口实现 更多...

函数说明

EntryMatch()

static int EntryMatch ( const char *  name, int  len, const struct ProcDirEntry *  pn  )

static

实体匹配,通过名称匹配

在文件 proc_vfs.c 第 85 行定义.

{
    if (len != pn->nameLen) {
        return 0;
    }
    return !strncmp(name, pn->name, len);
}

这是这个函数的调用关系图:

EntryToVnode()

static struct Vnode * EntryToVnode ( struct ProcDirEntry *  entry )

static

创建节点,通过实体对象转成vnode节点,如此达到统一管理的目的.

在文件 proc_vfs.c 第 71 行定义.

{
    struct Vnode *node = NULL;
 
    (void)VnodeAlloc(&g_procfsVops, &node);//申请一个 vnode节点,并设置节点操作
    node->fop = &g_procfsFops;//设置文件操作系列函数
    node->data = entry;//绑定实体
    node->type = entry->type;//实体类型 (文件|目录)
    node->uid = entry->uid; //用户ID
    node->gid = entry->gid; //组ID
    node->mode = entry->mode;//读/写/执行模式
    return node;
}

函数调用图:

这是这个函数的调用关系图:

FSMAP_ENTRY()

FSMAP_ENTRY	(	procfs_fsmap	,
		"procfs"	,
		procfs_operations	,
		FALSE	,
		FALSE
	)

VfsProcfsClose()

int VfsProcfsClose

(

struct file *

filep

)

在文件 proc_vfs.c 第 325 行定义.

{
    int result = 0;
    if (filep == NULL) {
        return -EINVAL;
    }
    struct Vnode *node = filep->f_vnode;
    struct ProcDirEntry *pde = VnodeToEntry(node);
    pde->pf->fPos = 0;
    if ((pde->procFileOps != NULL) && (pde->procFileOps->release != NULL)) {
        result = pde->procFileOps->release((struct Vnode *)pde, pde->pf);
    }
    LosBufRelease(pde->pf->sbuf);
    pde->pf->sbuf = NULL;
 
    return result;
}

函数调用图:

VfsProcfsClosedir()

int VfsProcfsClosedir	(	struct Vnode *	vp,
		struct fs_dirent_s *	dir
	)

在文件 proc_vfs.c 第 351 行定义.

{
    return LOS_OK;
}

VfsProcfsCreate()

int VfsProcfsCreate	(	struct Vnode *	parent,
		const char *	name,
		int	mode,
		struct Vnode **	vnode
	)

创建vnode节点,并绑定私有内容项

在文件 proc_vfs.c 第 98 行定义.

{
    int ret;
    struct Vnode *vp = NULL;
    struct ProcDirEntry *curEntry = NULL;
 
    struct ProcDirEntry *parentEntry = VnodeToEntry(parent);
    if (parentEntry == NULL) {
        return -ENODATA;
    }
 
    ret = VnodeAlloc(&g_procfsVops, &vp);
    if (ret != 0) {
        return -ENOMEM;
    }
 
    curEntry = ProcCreate(name, mode, parentEntry, NULL);
    if (curEntry == NULL) {
        VnodeFree(vp);
        return -ENODATA;
    }
 
    vp->data = curEntry;
    vp->type = curEntry->type;
    if (vp->type == VNODE_TYPE_DIR) {
        vp->mode = S_IFDIR | PROCFS_DEFAULT_MODE;
    } else {
        vp->mode = S_IFREG | PROCFS_DEFAULT_MODE;
    }
 
    vp->vop = parent->vop;
    vp->fop = parent->fop;
    vp->parent = parent;
    vp->originMount = parent->originMount;
 
    *vnode = vp;
 
    return LOS_OK;
}

函数调用图:

VfsProcfsLookup()

int VfsProcfsLookup	(	struct Vnode *	parent,
		const char *	name,
		int	len,
		struct Vnode **	vpp
	)

在文件 proc_vfs.c 第 168 行定义.

{
    if (parent == NULL || name == NULL || len <= 0 || vpp == NULL) {
        return -EINVAL;
    }
    struct ProcDirEntry *entry = VnodeToEntry(parent);
    if (entry == NULL) {
        return -ENODATA;
    }
    entry = entry->subdir;
    while (1) {
        if (entry == NULL) {
            return -ENOENT;
        }
        if (EntryMatch(name, len, entry)) {
            break;
        }
        entry = entry->next;
    }
 
    *vpp = EntryToVnode(entry);
    if ((*vpp) == NULL) {
        return -ENOMEM;
    }
    (*vpp)->originMount = parent->originMount;//继承挂载信息
    (*vpp)->parent = parent;
    return LOS_OK;
}

函数调用图:

VfsProcfsMount()

int VfsProcfsMount	(	struct Mount *	mnt,
		struct Vnode *	device,
		const void *	data
	)

挂s载实现,找个vnode节点挂上去

在文件 proc_vfs.c 第 197 行定义.

{
    struct Vnode *vp = NULL;
    int ret;
 
    spin_lock_init(&procfsLock);
    procfsInit = true;      //已初始化 /proc 模块
 
    ret = VnodeAlloc(&g_procfsVops, &vp);//分配一个节点
    if (ret != 0) {
        return -ENOMEM;
    }
 
    struct ProcDirEntry *root = GetProcRootEntry();
    vp->data = root;
    vp->originMount = mnt;//绑定mount
    vp->fop = &g_procfsFops;//指定文件系统
    mnt->data = NULL;
    mnt->vnodeCovered = vp;
    vp->type = root->type;
    if (vp->type == VNODE_TYPE_DIR) {//目录节点
        vp->mode = S_IFDIR | PROCFS_DEFAULT_MODE;//贴上目录标签
    } else {
        vp->mode = S_IFREG | PROCFS_DEFAULT_MODE;//贴上文件标签
    }
 
    return LOS_OK;
}

函数调用图:

VfsProcfsOpen()

int VfsProcfsOpen

(

struct file *

filep

)

proc 打开文件

在文件 proc_vfs.c 第 304 行定义.

{
    if (filep == NULL) {
        return -EINVAL;
    }
    struct Vnode *node = filep->f_vnode;//找到vnode节点
    struct ProcDirEntry *pde = VnodeToEntry(node);//拿到私有数据(内存对象)
    if (ProcOpen(pde->pf) != OK) {
        return -ENOMEM;
    }
    if (S_ISREG(pde->mode) && (pde->procFileOps != NULL) && (pde->procFileOps->open != NULL)) {
        (void)pde->procFileOps->open((struct Vnode *)pde, pde->pf);
    }
    if (S_ISDIR(pde->mode)) {
        pde->pdirCurrent = pde->subdir;
        pde->pf->fPos = 0;
    }
    filep->f_priv = (void *)pde;
    return LOS_OK;
}

函数调用图:

VfsProcfsOpendir()

int VfsProcfsOpendir	(	struct Vnode *	node,
		struct fs_dirent_s *	dir
	)

proc 打开目录

在文件 proc_vfs.c 第 292 行定义.

{
    struct ProcDirEntry *pde = VnodeToEntry(node);
    if (pde == NULL) {
        return -EINVAL;
    }
    pde->pdirCurrent = pde->subdir;
    pde->pf->fPos = 0;
 
    return LOS_OK;
}

函数调用图:

VfsProcfsRead()

int VfsProcfsRead	(	struct file *	filep,
		char *	buffer,
		size_t	buflen
	)

在文件 proc_vfs.c 第 138 行定义.

{
    ssize_t size;
    struct ProcDirEntry *entry = NULL;
    if ((filep == NULL) || (filep->f_vnode == NULL) || (buffer == NULL)) {
        return -EINVAL;
    }
 
    entry = VnodeToEntry(filep->f_vnode);
    size = (ssize_t)ReadProcFile(entry, (void *)buffer, buflen);
    filep->f_pos = entry->pf->fPos;
 
    return size;
}

函数调用图:

VfsProcfsReaddir()

int VfsProcfsReaddir	(	struct Vnode *	node,
		struct fs_dirent_s *	dir
	)

在文件 proc_vfs.c 第 243 行定义.

{
    int result;
    char *buffer = NULL;
    int buflen = NAME_MAX;
    unsigned int min_size;
    unsigned int dst_name_size;
    struct ProcDirEntry *pde = NULL;
    int i = 0;
 
    if (dir == NULL) {
        return -EINVAL;
    }
    if (node->type != VNODE_TYPE_DIR) {
        return -ENOTDIR;
    }
    pde = VnodeToEntry(node);
 
    while (i < dir->read_cnt) {
        buffer = (char *)zalloc(sizeof(char) * NAME_MAX);
        if (buffer == NULL) {
            PRINT_ERR("malloc failed\n");
            return -ENOMEM;
        }
 
        result = ReadProcFile(pde, (void *)buffer, buflen);
        if (result != ENOERR) {
            free(buffer);
            break;
        }
        dst_name_size = sizeof(dir->fd_dir[i].d_name);
        min_size = (dst_name_size < NAME_MAX) ? dst_name_size : NAME_MAX;
        result = strncpy_s(dir->fd_dir[i].d_name, dst_name_size, buffer, min_size);
        if (result != EOK) {
            free(buffer);
            return -ENAMETOOLONG;
        }
        dir->fd_dir[i].d_name[dst_name_size - 1] = '\0';
        dir->fd_position++;
        dir->fd_dir[i].d_off = dir->fd_position;
        dir->fd_dir[i].d_reclen = (uint16_t)sizeof(struct dirent);
 
        i++;
        free(buffer);
    }
 
    return i;
}

函数调用图:

VfsProcfsStat()

int VfsProcfsStat	(	struct Vnode *	node,
		struct stat *	buf
	)

在文件 proc_vfs.c 第 233 行定义.

{
    struct ProcDirEntry *entry = VnodeToEntry(node);
 
    (void)memset_s(buf, sizeof(struct stat), 0, sizeof(struct stat));
    buf->st_mode = entry->mode;
 
    return LOS_OK;
}

函数调用图:

VfsProcfsStatfs()

int VfsProcfsStatfs	(	struct Mount *	mnt,
		struct statfs *	buf
	)

统计信息接口,简单实现

在文件 proc_vfs.c 第 343 行定义.

{
    (void)memset_s(buf, sizeof(struct statfs), 0, sizeof(struct statfs));
    buf->f_type = PROCFS_MAGIC;
 
    return LOS_OK;
}

VfsProcfsTruncate()

int VfsProcfsTruncate	(	struct Vnode *	pVnode,
		off_t	len
	)

在文件 proc_vfs.c 第 93 行定义.

{
    return 0;
}

VfsProcfsUnmount()

int VfsProcfsUnmount	(	void *	handle,
		struct Vnode **	blkdriver
	)

在文件 proc_vfs.c 第 226 行定义.

{
    (void)handle;
    (void)blkdriver;
    return -EPERM;
}

VfsProcfsWrite()

int VfsProcfsWrite	(	struct file *	filep,
		const char *	buffer,
		size_t	buflen
	)

在文件 proc_vfs.c 第 153 行定义.

{
    ssize_t size;
    struct ProcDirEntry *entry = NULL;
    if ((filep == NULL) || (filep->f_vnode == NULL) || (buffer == NULL)) {
        return -EINVAL;
    }
 
    entry = VnodeToEntry(filep->f_vnode);
    size = (ssize_t)WriteProcFile(entry, (void *)buffer, buflen);
    filep->f_pos = entry->pf->fPos;
 
    return size;
}

函数调用图:

VnodeToEntry()

static struct ProcDirEntry * VnodeToEntry ( struct Vnode *  node )

static

通过节点获取私有内存对象,注意要充分理解 node->data 的作用,那是个可以通天的神奇变量.

在文件 proc_vfs.c 第 66 行定义.

{
    return (struct ProcDirEntry *)(node->data);
}

这是这个函数的调用关系图:

变量说明

g_procfsFops

static struct file_operations_vfs g_procfsFops

static

初始值:

= {
    .read = VfsProcfsRead,  
    .write = VfsProcfsWrite,
    .open = VfsProcfsOpen,  
    .close = VfsProcfsClose 
}

proc 文件系统

在文件 proc_vfs.c 第 63 行定义.

g_procfsVops

static struct VnodeOps g_procfsVops

static

初始值:

= { 
    .Lookup = VfsProcfsLookup,
    .Getattr = VfsProcfsStat,
    .Readdir = VfsProcfsReaddir,
    .Opendir = VfsProcfsOpendir,
    .Closedir = VfsProcfsClosedir,
    .Truncate = VfsProcfsTruncate
}

鸿蒙的/proc目录是一种文件系统，即proc文件系统。与其它常见的文件系统不同的是，/proc是一种伪文件系统（也即虚拟文件系统），
存储的是当前内核运行状态的一系列特殊文件，用户可以通过这些文件查看有关系统硬件及当前正在运行进程的信息，
甚至可以通过更改其中某些文件来改变内核的运行状态。

基于/proc文件系统如上所述的特殊性，其内的文件也常被称作虚拟文件，并具有一些独特的特点。
例如，其中有些文件虽然使用查看命令查看时会返回大量信息，但文件本身的大小却会显示为0字节。
此外，这些特殊文件中大多数文件的时间及日期属性通常为当前系统时间和日期，这跟它们随时会被刷新（存储于RAM中）有关。

为了查看及使用上的方便，这些文件通常会按照相关性进行分类存储于不同的目录甚至子目录中，
如/proc/mounts 目录中存储的就是当前系统上所有装载点的相关信息，

大多数虚拟文件可以使用文件查看命令如cat、more或者less进行查看，有些文件信息表述的内容可以一目了然，
 * 

在文件 proc_vfs.c 第 62 行定义.

procfs_operations

const struct MountOps procfs_operations

初始值:

= {
    .Mount = VfsProcfsMount,
    .Unmount = NULL,
    .Statfs = VfsProcfsStatfs,
}

proc 对 MountOps 接口实现

在文件 proc_vfs.c 第 356 行定义.