[edk2-devel] [Patch 1/1] BaseTools/Ecc: Fix an issue of path separator compatibility

[Bob Feng]

Laszlo,

1) there is no special reason not using os.sep, I sent out a new patch to use it.

Liming,

2) If this patch can be included in this stable tag, that will great.  From the Bugzilla, I see this issue will block patch merging.

Thanks,
Bob

-----Original Message-----
From: Laszlo Ersek <lersek at redhat.com> 
Sent: Tuesday, September 1, 2020 4:06 PM
To: devel at edk2.groups.io; Feng, Bob C <bob.c.feng at intel.com>
Cc: Liming Gao <gaoliming at byosoft.com.cn>; Chen, Christine <yuwei.chen at intel.com>; Zhang, Shenglei <shenglei.zhang at intel.com>
Subject: Re: [edk2-devel] [Patch 1/1] BaseTools/Ecc: Fix an issue of path separator compatibility

On 08/31/20 18:14, Bob Feng wrote:
> From: "Bob Feng" <bob.c.feng at intel.com>
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=2904
> 
> The path separator is different in Windows and Linux, the original 
> code does not handle this difference. This patch is to fix this issue.
> 
> Signed-off-by: Bob Feng <bob.c.feng at intel.com>
> Cc: Liming Gao <gaoliming at byosoft.com.cn>
> Cc: Yuwei Chen <yuwei.chen at intel.com>
> Cc: Shenglei Zhang <shenglei.zhang at intel.com>
> ---
>  BaseTools/Source/Python/Ecc/Check.py | 11 +++++++----
>  1 file changed, 7 insertions(+), 4 deletions(-)
> 
> diff --git a/BaseTools/Source/Python/Ecc/Check.py 
> b/BaseTools/Source/Python/Ecc/Check.py
> index 0fdc7e35c18a..ca24c8acffeb 100644
> --- a/BaseTools/Source/Python/Ecc/Check.py
> +++ b/BaseTools/Source/Python/Ecc/Check.py
> @@ -13,10 +13,11 @@ from Ecc.EccToolError import *  from 
> Ecc.MetaDataParser import ParseHeaderCommentSection  from Ecc import 
> EccGlobalData  from Ecc import c  from Common.LongFilePathSupport 
> import OpenLongFilePath as open  from Common.MultipleWorkspace import 
> MultipleWorkspace as mws
> +import platform
>  
>  ## Check
>  #
>  # This class is to define checkpoints used by ECC tool  # @@ -1099,17 
> +1100,18 @@ class Check(object):
>              InfPathSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)
>              InfPathList = []
>              for Item in InfPathSet:
>                  if Item[0] not in InfPathList:
>                      InfPathList.append(Item[0])
> +            pathsep = """'\\'""" if platform.system() == 'Windows' else """'/'"""
>              SqlCommand = """
>                           select ID, Path, FullPath from File where upper(FullPath) not in
> -                            (select upper(A.Path) || '\\' || upper(B.Value1) from File as A, INF as B
> +                            (select upper(A.Path) || %s || 
> + upper(B.Value1) from File as A, INF as B
>                              where A.ID in (select BelongsToFile from INF where Model = %s group by BelongsToFile) and
>                              B.BelongsToFile = A.ID and B.Model = %s)
>                              and (Model = %s or Model = %s)
> -                        """ % (MODEL_EFI_SOURCE_FILE, MODEL_EFI_SOURCE_FILE, MODEL_FILE_C, MODEL_FILE_H)
> +                        """ % (pathsep, MODEL_EFI_SOURCE_FILE, 
> + MODEL_EFI_SOURCE_FILE, MODEL_FILE_C, MODEL_FILE_H)
>              RecordSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)
>              for Record in RecordSet:
>                  Path = Record[1]
>                  Path = Path.upper().replace('\X64', '').replace('\IA32', '').replace('\EBC', '').replace('\IPF', '').replace('\ARM', '')
>                  if Path in InfPathList:
> @@ -1122,21 +1124,22 @@ class Check(object):
>              EdkLogger.quiet("Checking for pcd type in c code function usage ...")
>              SqlCommand = """
>                           select ID, Model, Value1, Value2, BelongsToFile from INF where Model > %s and Model < %s
>                           """ % (MODEL_PCD, MODEL_META_DATA_HEADER)
>              PcdSet = EccGlobalData.gDb.TblInf.Exec(SqlCommand)
> +            pathsep = """'\\'""" if platform.system() == 'Windows' else """'/'"""
>              for Pcd in PcdSet:
>                  Model = Pcd[1]
>                  PcdName = Pcd[2]
>                  if Pcd[3]:
>                      PcdName = Pcd[3]
>                  BelongsToFile = Pcd[4]
>                  SqlCommand = """
>                               select ID from File where FullPath in
> -                            (select B.Path || '\\' || A.Value1 from INF as A, File as B where A.Model = %s and A.BelongsToFile = %s
> +                            (select B.Path || %s || A.Value1 from INF 
> + as A, File as B where A.Model = %s and A.BelongsToFile = %s
>                               and B.ID = %s and (B.Model = %s or B.Model = %s))
> -                             """ % (MODEL_EFI_SOURCE_FILE, BelongsToFile, BelongsToFile, MODEL_FILE_C, MODEL_FILE_H)
> +                             """ % (pathsep, MODEL_EFI_SOURCE_FILE, 
> + BelongsToFile, BelongsToFile, MODEL_FILE_C, MODEL_FILE_H)
>                  TableSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)
>                  for Tbl in TableSet:
>                      TblName = 'Identifier' + str(Tbl[0])
>                      SqlCommand = """
>                                   select Name, ID from %s where value 
> like '%s' and Model = %s
> 

(1) any reason for not using os.sep (aka os.path.sep) instead?

(2) do you intend this patch for the stable tag?

Thanks
Laszlo


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#64888): https://edk2.groups.io/g/devel/message/64888
Mute This Topic: https://groups.io/mt/76537216/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-