[edk2-devel] [PATCH v1 1/2] BaseTools: Fix crash in ECC when parsing incorrect header

[PierreGondois]

From: Sami Mujawar <sami.mujawar at arm.com>

The ECC tool crashes if a C file has an incorrect file header
format.

The file ArmPkg\Library\ArmMmuLib\AArch64\ArmMmuPeiLibConstructor.c
has a file header in the incorrect format. It uses # to mark the
header comments instead of enclosing the file header in /* */. This
may have been a result of an INF file header being copied to a C
file.

A separate patch fixes the C file but ECC tool should
not crash if a file with an incorrect header is found.

Therefore, update the ECC tool to prevent it from crashing if an
incorrect file header is found. With this change the ECC tool will
report the incorrect header issue without crashing.

Signed-off-by: Sami Mujawar <sami.mujawar at arm.com>
---
The changes can be seen at: https://github.com/PierreARM/edk2/commits/1551_Ecc_BaseTools_v1

 BaseTools/Source/Python/Ecc/c.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/BaseTools/Source/Python/Ecc/c.py b/BaseTools/Source/Python/Ecc/c.py
index a30122a45f81..db686df0db25 100644
--- a/BaseTools/Source/Python/Ecc/c.py
+++ b/BaseTools/Source/Python/Ecc/c.py
@@ -2,6 +2,7 @@
 # This file is used to be the c coding style checking of ECC tool
 #
 # Copyright (c) 2009 - 2019, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2020, Arm Limited. All rights reserved.<BR>
 # SPDX-License-Identifier: BSD-2-Clause-Patent
 #

@@ -64,7 +65,9 @@ def GetIdType(Str):
     Type = DataClass.MODEL_UNKNOWN
     Str = Str.replace('#', '# ')
     List = Str.split()
-    if List[1] == 'include':
+    if len(List) < 2:
+        pass
+    elif List[1] == 'include':
         Type = DataClass.MODEL_IDENTIFIER_INCLUDE
     elif List[1] == 'define':
         Type = DataClass.MODEL_IDENTIFIER_MACRO_DEFINE
--
2.17.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#68981): https://edk2.groups.io/g/devel/message/68981
Mute This Topic: https://groups.io/mt/79005705/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-