proc_fs.h 文件参考

浏览源代码.

结构体
struct	ProcFileOperations
	真正最后能操作pro file的接口,proc本质是个内存文件系统, vfs - > ProcFileOperations 更多...
struct	ProcDirEntry
	proc 目录/文件项, @notethinking 直接叫 ProcEntry不香吗 ? 操作 /proc的 真正结构体 更多...
struct	ProcFile
	Proc文件结构体,对标 FILE 结构体 更多...
struct	ProcStat
struct	ProcData

类型定义
typedef unsigned short	fmode_t

函数
struct ProcDirEntry *	CreateProcEntry (const char *name, mode_t mode, struct ProcDirEntry *parent)
	create a proc node 更多...
void	RemoveProcEntry (const char *name, struct ProcDirEntry *parent)
	remove a proc node 更多...
struct ProcDirEntry *	ProcMkdir (const char *name, struct ProcDirEntry *parent)
	create a proc directory node 更多...
struct ProcDirEntry *	ProcCreate (const char *name, mode_t mode, struct ProcDirEntry *parent, const struct ProcFileOperations *procFops)
	create a proc node 更多...
void	ProcFsInit (void)
	init proc fs 更多...

类型定义说明

fmode_t

typedef unsigned short fmode_t

在文件 proc_fs.h 第 53 行定义.

函数说明

CreateProcEntry()

struct ProcDirEntry * CreateProcEntry	(	const char *	name,
		mode_t	mode,
		struct ProcDirEntry *	parent
	)

create a proc node

Interface for modules using proc below internal proc moudule;

Description:

This API is used to create the node by 'name' and parent vnode

注意

• This interface should be called after system initialization.
• The parameter name should be a valid string.

参数

name	[IN] Type #const char * The name of the node to be created.
mode	[IN] Type mode_t the mode of create's node.
parent	[IN] Type #struct ProcDirEntry * the parent node of the node to be created, if pass NULL, default parent node is "/proc".

返回值

#NULL	Create failed.
#ProcDirEntry*	Create successfully.

Dependency:

• proc_fs.h: the header file that contains the API declaration.

参见

create a proc node

在文件 proc_file.c 第 364 行定义.

{
    struct ProcDirEntry *pde = NULL;
 
    if (S_ISDIR(mode)) {//目录模式 0
        pde = ProcCreateDir(parent, name, NULL, mode);//无驱动程序
    } else {
        pde = ProcCreateFile(parent, name, NULL, mode);//无驱动程序
    }
    return pde;
}

函数调用图:

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

ProcCreate()

struct ProcDirEntry * ProcCreate	(	const char *	name,
		mode_t	mode,
		struct ProcDirEntry *	parent,
		const struct ProcFileOperations *	procFops
	)

create a proc node

Description:

This API is used to create the node by 'name' and parent vnode, And assignment operation function

注意

• This interface should be called after system initialization.
• The parameter name should be a valid string.

参数

name	[IN] Type #const char * The name of the node to be created.
mode	[IN] Type mode_t the mode of create's node.
parent	[IN] Type #struct ProcDirEntry * the parent node of the node to be created.
procFops	[IN] Type #const struct ProcFileOperations * operation function of the node.

返回值

#NULL	Create failed.
#ProcDirEntry*	Create successfully.

Dependency:

• proc_fs.h: the header file that contains the API declaration.

参见

在文件 proc_file.c 第 457 行定义.

{
    return ProcCreateData(name, mode, parent, procFileOps, NULL);
}

函数调用图:

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

ProcFsInit()

void ProcFsInit

(

void

)

init proc fs

Description:

This API is used to init proc fs.

注意

• None.

参数

NONE

返回值

NONE

Dependency:

• proc_fs.h: the header file that contains the API declaration.

参见

ProcFsInit

在文件 proc_init.c 第 43 行定义.

{
    int ret;
 
    ret = mkdir(PROCFS_MOUNT_POINT, PROCFS_DEFAULT_MODE);//创建 "/proc"
    if (ret < 0) {
        PRINT_ERR("failed to mkdir %s, errno = %d\n", PROCFS_MOUNT_POINT, get_errno());
        return;
    }
    //装载文件系统
    ret = mount(NULL, PROCFS_MOUNT_POINT, "procfs", 0, NULL);//将null 挂到 /proc 上
    if (ret) {
        PRINT_ERR("mount procfs err %d\n", ret);
        return;
    }
 
    ProcMountsInit();//初始化 /proc/mounts
#if defined(LOSCFG_SHELL_CMD_DEBUG) && defined(LOSCFG_KERNEL_VM)
    ProcVmmInit();//初始化 /proc/vmm
#endif
    ProcProcessInit();//初始化 /proc/process
    ProcUptimeInit();//初始化 /proc/uptime
    ProcFsCacheInit();
    ProcFdInit();
#ifdef LOSCFG_KERNEL_PM
    ProcPmInit();
#endif
}

函数调用图:

ProcMkdir()

struct ProcDirEntry * ProcMkdir	(	const char *	name,
		struct ProcDirEntry *	parent
	)

create a proc directory node

Description:

This API is used to create the directory node by 'name' and parent vnode

注意

• This interface should be called after system initialization.
• The parameter name should be a valid string.

参数

name	[IN] Type #const char * The name of the node directory to be created.
parent	[IN] Type #struct ProcDirEntry * the parent node of the directory node to be created, if pass NULL, default parent node is "/proc".

返回值

#NULL	Create failed.
#ProcDirEntry*	Create successfully.

Dependency:

• proc_fs.h: the header file that contains the API declaration.

参见

在文件 proc_file.c 第 439 行定义.

{
    return ProcCreateDir(parent, name, NULL, 0);
}

函数调用图:

RemoveProcEntry()

void RemoveProcEntry	(	const char *	name,
		struct ProcDirEntry *	parent
	)

remove a proc node

Description:

This API is used to remove the node by 'name' and parent vnode

注意

• This interface should be called after system initialization.
• The parameter name should be a valid string.

参数

name	[IN] Type #const char * The name of the node to be removed.
parent	[IN] Type #struct ProcDirEntry * the parent node of the node to be remove.

Dependency:

• proc_fs.h: the header file that contains the API declaration.

参见

在文件 proc_file.c 第 405 行定义.

{
    struct ProcDirEntry *pn = NULL;
    const char *lastName = name;
 
    if ((name == NULL) || (strlen(name) == 0) || (procfsInit == false)) {
        return;
    }
 
    if (CheckProcName(name, &parent, &lastName) != 0) {
        return;
    }
 
    spin_lock(&procfsLock);
 
    pn = ProcFindNode(parent, lastName);
    if (pn == NULL) {
        PRINT_ERR("Error:name '%s' not found!\n", name);
        spin_unlock(&procfsLock);
        return;
    }
    ProcDetachNode(pn);
 
    spin_unlock(&procfsLock);
 
    RemoveProcEntryTravalsal(pn->subdir);
    ProcFreeEntry(pn);
}

函数调用图: