Commit 598bae70 authored by Tang Chen's avatar Tang Chen Committed by Rafael J. Wysocki
Browse files

earlycpio.c: Fix the confusing comment of find_cpio_data(). 



The comments of find_cpio_data() says:

  * @offset: When a matching file is found, this is the offset to the
  *          beginning of the cpio. ......

But according to the code,

  dptr = PTR_ALIGN(p + ch[C_NAMESIZE], 4);
  nptr = PTR_ALIGN(dptr + ch[C_FILESIZE], 4);
  ....
  *offset = (long)nptr - (long)data;	/* data is the cpio file */

@offset is the offset of the next file, not the matching file itself.
This is confused and may cause unnecessary waste of time to debug.
So fix it.

As Tejun Heo suggested, rename @offset to @nextoff which is more clear
to users. And also adjust the new comments.

Signed-off-by: default avatarTang Chen <tangchen@cn.fujitsu.com>
Reviewed-by: default avatarZhang Yanfei <zhangyanfei@cn.fujitsu.com>
Reviewed-by: default avatarTejun Heo <tj@kernel.org>
Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent d7b2c3d8

lib/earlycpio.c

+14 −13
Original line number Diff line number Diff line
@@ -52,9 +52,10 @@ enum cpio_fields { 
 * @path:       The directory to search for, including a slash at the end

 * @data:       Pointer to the the cpio archive or a header inside

 * @len:        Remaining length of the cpio based on data pointer

 * @offset: When a matching file is found, this is the offset to the

 *          beginning of the cpio. It can be used to iterate through

 *          the cpio to find all files inside of a directory path

 * @nextoff:    When a matching file is found, this is the offset from the

 *              beginning of the cpio to the beginning of the next file, not the

 *              matching file itself. It can be used to iterate through the cpio

 *              to find all files inside of a directory path.

 *

 * @return:     struct cpio_data containing the address, length and

 *              filename (with the directory path cut off) of the found file.
@@ -64,7 +65,7 @@ enum cpio_fields { 
 */



struct cpio_data find_cpio_data(const char *path, void *data,

					  size_t len,  long *offset)

				size_t len,  long *nextoff)

{

	const size_t cpio_header_len = 8*C_NFIELDS - 2;

	struct cpio_data cd = { NULL, 0, "" };
@@ -124,7 +125,7 @@ struct cpio_data find_cpio_data(const char *path, void *data, 
		if ((ch[C_MODE] & 0170000) == 0100000 &&

		    ch[C_NAMESIZE] >= mypathsize &&

		    !memcmp(p, path, mypathsize)) {

			*offset = (long)nptr - (long)data;

			*nextoff = (long)nptr - (long)data;

			if (ch[C_NAMESIZE] - mypathsize >= MAX_CPIO_FILE_NAME) {

				pr_warn(

				"File %s exceeding MAX_CPIO_FILE_NAME [%d]\n",

CRA Git | Maintained and supported by SUSTech CRA and CCSE