github-mirror/lkmpg
2
0
Fork 0
mirror of https://github.com/sysprog21/lkmpg.git synced 2025-01-18 21:02:50 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Modify the descritions of seq_file and flowchart

Browse Source 
7.4 The seq_file is missing the behavior that occurs when it
directly returns NULL after the start step.

Also, in the flowchart, the first decision where `return is NULL`
is `Yes` points to nothing, which is not defined in ISO 5807.

ISO 5807 section 10.3.1.2 states logic path of a decision,
"Each exit from a symbol be accompanied by the appropriate
condition values to show the logic path which it represents,
so that the conditions and the associated references are identified."

The behavior of pointing to nothing does not have associated
references and does not indicate the relation of this logic path.

Refs:
	1. The Liunx Kernel Module Programming Guide
	   7.4 Manage /proc file with seq_file
	2. ISO-5807-1985
This commit is contained in:
jouae 2024-07-02 23:47:43 +08:00
parent 1d3943a72b
commit 7a6dd1f582
No known key found for this signature in database
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lkmpg.tex
View File

@ -1234,7 +1234,7 @@ It is based on sequence, which is composed of 3 functions: \cpp|start()|, \cpp|n
The \cpp|seq_file| API starts a sequence when a user read the \verb|/proc| file.
A sequence begins with the call of the function \cpp|start()|.
If the return is a non \cpp|NULL| value, the function \cpp|next()| is called.
If the return is a non \cpp|NULL| value, the function \cpp|next()| is called; otherwise, otherwise, the \cpp|stop()| function is called directly.
This function is an iterator, the goal is to go through all the data.
Each time \cpp|next()| is called, the function \cpp|show()| is also called.
It writes data values in the buffer read by the user.
@ -1251,13 +1251,12 @@ You can see a scheme of this in the Figure~\ref{img:seqfile}.
\begin{tikzpicture}[node distance=2cm, thick]
\node (start) [startstop] {start() treatment};
\node (branch1) [decision, below of=start, yshift=-1cm] {return is NULL?};
\node (emptynode) [right of=branch1, xshift=2cm] {Yes};
\node (next) [process, below of=branch1, yshift=-1cm] {next() treatment};
\node (branch2) [decision, below of=next, yshift=-1cm] {return is NULL?};
\node (stop) [startstop, below of=branch2, yshift=-1cm] {stop() treatment};
\draw [->] (start) -- (branch1);
\draw [->] (branch1) -- node[anchor=east] {} (emptynode);
\draw [->] (branch1.east) to [out=135, in=-135, bend left=45] node [right] {Yes} (stop.east);
\draw [->] (branch1) -- node[left=2em, anchor=south] {No} (next);
\draw [->] (next) -- (branch2);
\draw [->] (branch2.west) to [out=135, in=-135, bend left=45] node [left] {No} (next.west);