proc_file.h 文件参考

浏览源代码.

函数
struct ProcDirEntry *	OpenProcFile (const char *fileName, int flags,...)
	open a proc node 更多...
int	ReadProcFile (struct ProcDirEntry *pde, void *buf, size_t len)
	read a proc node 更多...
int	WriteProcFile (struct ProcDirEntry *pde, const void *buf, size_t len)
	write a proc node 更多...
loff_t	LseekProcFile (struct ProcDirEntry *pde, loff_t offset, int whence)
	File migration 更多...
int	LseekDirProcFile (struct ProcDirEntry *pde, off_t *pos, int whence)
	directory migration 更多...
int	CloseProcFile (struct ProcDirEntry *pde)
	close a proc node 更多...
struct ProcDirEntry *	GetProcRootEntry (void)
int	ProcOpen (struct ProcFile *procFile)
	打开 pro 更多...

函数说明

CloseProcFile()

int CloseProcFile

(

struct ProcDirEntry *

pde

)

close a proc node

Description:

This API is used to close the node by pde

注意

• None.

参数

pde	[IN] Type #struct ProcDirEntry * pointer of the node structure to be closed

返回值

#-1	close failed
#0	close successfully

Dependency:

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

参见

proc_open

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

{
    int result = 0;
 
    if (pde == NULL) {
        return -EPERM;
    }
    pde->pf->fPos = 0;
    atomic_set(&pde->count, 1);
    if (S_ISDIR(pde->mode)) {
        pde->pdirCurrent = pde->subdir;
    }
 
    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;
 
    if (pde->parent == NULL) {
        FreeProcEntry(pde);
    }
    return result;
}

函数调用图:

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

GetProcRootEntry()

struct ProcDirEntry * GetProcRootEntry

(

void

)

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

{
    return &g_procRootDirEntry;
}

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

LseekDirProcFile()

int LseekDirProcFile	(	struct ProcDirEntry *	pde,
		off_t *	pos,
		int	whence
	)

directory migration

Description:

This API is used to set the proc directory migration

注意

• Only allow SEEK_SET to zero.

参数

pde	[IN] Type #struct ProcDirEntry * pointer of the node structure to be deviated
pos	[IN] Type #off_t * the number of deviation
whence	[IN] Type int the begin of deviation

返回值

#EINVAL	deviation failed
#ENOERR	deviation successfully

Dependency:

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

参见

proc_open

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

{
    /* Only allow SEEK_SET to zero */
    if ((whence != SEEK_SET) || (*pos != 0)) {
        return EINVAL;
    }
    pde->pdirCurrent = pde->subdir;
    pde->pf->fPos = 0;
    return ENOERR;
}

LseekProcFile()

loff_t LseekProcFile	(	struct ProcDirEntry *	pde,
		loff_t	offset,
		int	whence
	)

File migration

Description:

This API is used to set the proc file migration

注意

• None.

参数

pde	[IN] Type #struct ProcDirEntry * pointer of the node structure to be deviation
offset	[IN] Type #loff_t the number of deviation
whence	[IN] Type int the begin of deviation

返回值

#<0	deviation failed
#>=0	deviation successfully

Dependency:

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

参见

proc_open

File migration

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

{
    if (pde == NULL || pde->pf == NULL) {
        return PROC_ERROR;
    }
 
    struct ProcFile *procFile = pde->pf;
 
    loff_t result = -EINVAL;
 
    switch (whence) {
        case SEEK_CUR:
            result = procFile->fPos + offset;
            break;
 
        case SEEK_SET:
            result = offset;
            break;
 
        default:
            break;
    }
 
    if (result >= 0) {
        procFile->fPos = result;
    }
 
    return result;
}

OpenProcFile()

struct ProcDirEntry * OpenProcFile	(	const char *	fileName,
		int	flags,
			...
	)

open a proc node

Description:

This API is used to open the node by 'fileName' and flags,

注意

• None.

参数

fileName	[IN] Type #const char * the fileName of the node to be opened
flags	[IN] Type int the flags of open's node

返回值

#NULL	open failed
#NOT	NULL open successfully

Dependency:

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

参见

proc_close

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

{
    unsigned int intSave;
    struct ProcDirEntry *pn = ProcFindEntry(fileName);
    if (pn == NULL) {
        return NULL;
    }
 
    SCHEDULER_LOCK(intSave);
    if (S_ISREG(pn->mode) && (pn->count != 1)) {
        SCHEDULER_UNLOCK(intSave);
        return NULL;
    }
 
    pn->flags = (unsigned int)(pn->flags) | (unsigned int)flags;
    atomic_set(&pn->count, PROC_INUSE);
    SCHEDULER_UNLOCK(intSave);
    if (ProcOpen(pn->pf) != OK) {
        return NULL;
    }
    if (S_ISREG(pn->mode) && (pn->procFileOps != NULL) && (pn->procFileOps->open != NULL)) {
        (void)pn->procFileOps->open((struct Vnode *)pn, pn->pf);
    }
    if (S_ISDIR(pn->mode)) {
        pn->pdirCurrent = pn->subdir;
        pn->pf->fPos = 0;
    }
 
    return pn;
}

函数调用图:

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

ProcOpen()

int ProcOpen

(

struct ProcFile *

procFile

)

打开 pro

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

{
    if (procFile == NULL) {
        return PROC_ERROR;
    }
    if (procFile->sbuf != NULL) {
        return OK;
    }
 
    struct SeqBuf *buf = LosBufCreat();//创建一个 seq buf
    if (buf == NULL) {
        return PROC_ERROR;
    }
    procFile->sbuf = buf;
    return OK;
}

函数调用图:

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

ReadProcFile()

int ReadProcFile	(	struct ProcDirEntry *	pde,
		void *	buf,
		size_t	len
	)

read a proc node

Description:

This API is used to read the node by pde

注意

• None.

参数

pde	[IN] Type #struct ProcDirEntry * pointer of the node structure to be read
buf	[IN] Type void * user-provided to save the data
len	[IN] Type size_t the length of want to read

返回值

#-1	read failed
#>0	Number of bytes read success

Dependency:

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

参见

proc_open

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

{
    int result = -EPERM;
 
    if (pde == NULL) {
        return result;
    }
    if (S_ISREG(pde->mode)) {
        if ((pde->procFileOps != NULL) && (pde->procFileOps->read != NULL)) {
            result = ProcRead(pde, (char *)buf, len);
        }
    } else if (S_ISDIR(pde->mode)) {
        result = GetNextDir(pde, buf, len);
    }
    return result;
}

函数调用图:

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

WriteProcFile()

int WriteProcFile	(	struct ProcDirEntry *	pde,
		const void *	buf,
		size_t	len
	)

write a proc node

Description:

This API is used to write the node by pde

注意

• None.

参数

pde	[IN] Type #struct ProcDirEntry * pointer of the node structure to be written
buf	[IN] Type #const void * data to write
len	[IN] Type size_t length of data to write

返回值

#-1	write failed
#>0	Number of bytes write successfully

Dependency:

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

参见

proc_open

write a proc node

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

{
    int result = -EPERM;
 
    if (pde == NULL) {
        return result;
    }
 
    if (S_ISDIR(pde->mode)) {
        return -EISDIR;
    }
 
    spin_lock(&procfsLock);
    if ((pde->procFileOps != NULL) && (pde->procFileOps->write != NULL)) {
        result = pde->procFileOps->write(pde->pf, (const char *)buf, len, &(pde->pf->fPos));
    }
    spin_unlock(&procfsLock);
 
    return result;
}

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