Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MISRA C compliance #861

Closed
hwang37 opened this issue Aug 6, 2018 · 2 comments
Closed

MISRA C compliance #861

hwang37 opened this issue Aug 6, 2018 · 2 comments
Labels
area: hypervisor priority: high status: Assigned Assigned type: feature New feature
Projects
Roadmap
Milestone
v0.5

Comments

@hwang37
Copy link
Contributor

hwang37 commented Aug 6, 2018 •
edited
Loading

ACRN code should support MISRA C compliance coding style.
Note: MISRA-C is a standard guideline for Safety Critical Software.
@hwang37 hwang37 added the type: feature New feature label Aug 6, 2018
@hwang37 hwang37 added this to the v0.5 milestone Aug 6, 2018
@hwang37
Copy link
Contributor Author

hwang37 commented Aug 6, 2018 •
edited by Mingyuan18
Loading

[External_System_ID] ACRN-2129

@hwang37 hwang37 added area: hypervisor priority: high status: open The issue is working in progress labels Aug 7, 2018
@hwang37 hwang37 added this to v1.0 in Roadmap Aug 8, 2018
@junjunshan1 junjunshan1 mentioned this issue Aug 14, 2018
Merged
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Aug 15, 2018
@shiqingg
hv: vuart: fix 'Shifting value too far'
d87ca15 
MISRA-C requires that shift operation cannot exceed the word length.

What this patch does:
- Fix the bug in 'vuart_init'
  The register 'dll' and 'dlh' should be uint8_t rather than char.
  'dll' is the lower 8-bit of divisor.
  'dlh' is the higher 8-bit of divisor.
  So, the shift value should be 8U rather than 16U.
- Fix other data type issues regarding to the registers in 'struct
  vuart'
  The registers should be unsigned variables.

v1 -> v2:
 * Use a local variable 'uint8_t value_u8 = (uint8_t)value' to avoid
   mutiple times type conversion
 * Use '(uint8_t)divisor' rather than '(uint8_t)(divisor & 0xFFU)' to
   get the lower 8 bit of 'divisor'
   Direct type conversion is safe and simple per Xiangyang's suggestion.

Tracked-On: projectacrn#861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
Reviewed-by: Junjie Mao <junjie.mao@intel.com>
@shiqingg shiqingg mentioned this issue Aug 15, 2018
Merged
lijinxia pushed a commit that referenced this issue Aug 16, 2018
@shiqingg @lijinxia
hv: vuart: fix 'Shifting value too far'
3df3c9f 
MISRA-C requires that shift operation cannot exceed the word length.

What this patch does:
- Fix the bug in 'vuart_init'
  The register 'dll' and 'dlh' should be uint8_t rather than char.
  'dll' is the lower 8-bit of divisor.
  'dlh' is the higher 8-bit of divisor.
  So, the shift value should be 8U rather than 16U.
- Fix other data type issues regarding to the registers in 'struct
  vuart'
  The registers should be unsigned variables.

v1 -> v2:
 * Use a local variable 'uint8_t value_u8 = (uint8_t)value' to avoid
   mutiple times type conversion
 * Use '(uint8_t)divisor' rather than '(uint8_t)(divisor & 0xFFU)' to
   get the lower 8 bit of 'divisor'
   Direct type conversion is safe and simple per Xiangyang's suggestion.

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
Reviewed-by: Junjie Mao <junjie.mao@intel.com>
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Aug 17, 2018
@shiqingg
hv: vuart: fix the data type violations
3dedaf1 
- Fix the data type violations based on MISRA-C requirements
- Add '-fsigned-char' in Makefile to let the compiler treats 'char' be
   signed, like 'signed char'.
  Otherwise, the static checker treats 'char', 'signed char' and 'unsigned
   char' as three different types.
- Fix some minor coding style issues, such as TAB issues, line over 80
   characters issues and comments style

v1 -> v2:
 * fix the violation regarding to 'fifo_getchar'

Tracked-On: projectacrn#861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
Reviewed-by: Junjie Mao <junjie.mao@intel.com>
@shiqingg shiqingg mentioned this issue Aug 17, 2018
Merged
lijinxia pushed a commit that referenced this issue Aug 17, 2018
@shiqingg @lijinxia
hv: vuart: fix the data type violations
40745d9 
- Fix the data type violations based on MISRA-C requirements
- Add '-fsigned-char' in Makefile to let the compiler treats 'char' be
   signed, like 'signed char'.
  Otherwise, the static checker treats 'char', 'signed char' and 'unsigned
   char' as three different types.
- Fix some minor coding style issues, such as TAB issues, line over 80
   characters issues and comments style

v1 -> v2:
 * fix the violation regarding to 'fifo_getchar'

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
Reviewed-by: Junjie Mao <junjie.mao@intel.com>
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Aug 21, 2018
@shiqingg
hv: treewide: fix 'Function prototype/defn param type mismatch'
4f672e9 
Fix the parameter type mismatch between API declaration and definition.

Tracked-On: projectacrn#861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
Acked-by: Anthony Xu <anthony.xu@intel.com>
@shiqingg shiqingg mentioned this issue Aug 21, 2018
Merged
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Aug 21, 2018
@shiqingg
hv: treewide: fix 'Empty parameter list to procedure/function'
d02c1ed 
Use func(void) rather than func() for the function declaration and
definition based on MISRAC requirement.

Tracked-On: projectacrn#861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
@shiqingg shiqingg mentioned this issue Aug 21, 2018
Merged
lijinxia pushed a commit that referenced this issue Aug 21, 2018
@shiqingg @lijinxia
hv: treewide: fix 'Function prototype/defn param type mismatch'
7a4dcfc 
Fix the parameter type mismatch between API declaration and definition.

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
Acked-by: Anthony Xu <anthony.xu@intel.com>
lijinxia pushed a commit that referenced this issue Aug 21, 2018
@shiqingg @lijinxia
hv: treewide: fix 'Empty parameter list to procedure/function'
1017d91 
Use func(void) rather than func() for the function declaration and
definition based on MISRAC requirement.

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Aug 21, 2018
@shiqingg
hv: vmx: fix 'Array has no bounds specified'
623f2e3 
MISRAC requires that the array size should be declared explicitly.

This patch fixes the issues caused by vm0_boot_context.

Fix pattern is like below:
   extern char start_of_ROM, end_of_ROM, start_of_FLASH;
   memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - &
start_of_ROM);

Tracked-On: projectacrn#861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
@shiqingg shiqingg mentioned this issue Aug 21, 2018
Merged
lijinxia pushed a commit that referenced this issue Aug 21, 2018
@shiqingg @lijinxia
hv: vmx: fix 'Array has no bounds specified'
8924f6d 
MISRAC requires that the array size should be declared explicitly.

This patch fixes the issues caused by vm0_boot_context.

Fix pattern is like below:
   extern char start_of_ROM, end_of_ROM, start_of_FLASH;
   memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - &
start_of_ROM);

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Aug 22, 2018
@shiqingg
hv: fix 'No definition in system for prototyped procedure'
b52bca6 
Remove the functions without definition.

Tracked-On: projectacrn#861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
@shiqingg shiqingg mentioned this issue Aug 22, 2018
Merged
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Aug 22, 2018
@shiqingg
hv: code clean up regarding to % and / operations
bfa2eaa 
- Clean up some code regarding to % and / operations since bit
  operations are faster.
        x % 64U ---> x & 0x3fU
        x % 32U ---> x & 0x1fU
        x % 16U ---> x & 0xfU
        x % 8U  ---> x & 0x7U
        x % 4U  ---> x & 0x3U
        x % 2U  ---> x & 0x1U

        x / 64U ---> x >> 6U
        x / 32U ---> x >> 5U
        x / 16U ---> x >> 4U
        x / 8U  ---> x >> 3U
        x / 4U  ---> x >> 2U
        x / 2U  ---> x >> 1U
- Minor changes regarding to coding styles

Tracked-On: projectacrn#861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
@shiqingg shiqingg mentioned this issue Aug 22, 2018
Merged
lijinxia pushed a commit that referenced this issue Aug 22, 2018
@shiqingg @lijinxia
hv: fix 'No definition in system for prototyped procedure'
3e598eb 
Remove the functions without definition.

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
lijinxia pushed a commit that referenced this issue Aug 22, 2018
@shiqingg @lijinxia
hv: code clean up regarding to % and / operations
42aaf5d 
- Clean up some code regarding to % and / operations since bit
  operations are faster.
        x % 64U ---> x & 0x3fU
        x % 32U ---> x & 0x1fU
        x % 16U ---> x & 0xfU
        x % 8U  ---> x & 0x7U
        x % 4U  ---> x & 0x3U
        x % 2U  ---> x & 0x1U

        x / 64U ---> x >> 6U
        x / 32U ---> x >> 5U
        x / 16U ---> x >> 4U
        x / 8U  ---> x >> 3U
        x / 4U  ---> x >> 2U
        x / 2U  ---> x >> 1U
- Minor changes regarding to coding styles

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Aug 24, 2018
@shiqingg
hv: fix MISRA-C issuses related to space or newline
65e327a 
This patch fixes the following issues:
- No newline after semi colon.
- No space after semi colon in for expression.
- No space between if, while, for and expresn.

Tracked-On: projectacrn#861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
yakuizhao pushed a commit to yakuizhao/acrn-kernel that referenced this issue Nov 25, 2019
@mingqiangchi @yakuizhao
kernel: Sync the common header file
e84f6a3 
Change the type from uint8_t to uint32_t for interrupt pin

Tracked-On: projectacrn/acrn-hypervisor#861

Change-Id: Ifcd64388a99c810fa30f0270b087c4c6e3d1af07
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
Reviewed-by: Zhao Yakui <yakui.zhao@intel.com>
Tracked-On: PKT-1696
yakuizhao pushed a commit to yakuizhao/acrn-kernel that referenced this issue Nov 28, 2019
@yonghuah @yakuizhao
vhm: add ioctl for set/clear IRQ line
6af151c 
  ASSERT/DEASSERT/PULSE IRQ line ioctl commands
  will be deprecated.

Tracked-On: projectacrn/acrn-hypervisor#861
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Reviewed-by: Fei Li <fei1.li@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
yakuizhao pushed a commit to yakuizhao/acrn-kernel that referenced this issue Nov 28, 2019
@mingqiangchi @yakuizhao
kernel: Sync the common header file
cb5a670 
Change the type from uint8_t to uint32_t for interrupt pin

Tracked-On: projectacrn/acrn-hypervisor#861

Change-Id: Ifcd64388a99c810fa30f0270b087c4c6e3d1af07
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
Reviewed-by: Zhao Yakui <yakui.zhao@intel.com>
Tracked-On: PKT-1696
sys-oak pushed a commit to intel/mainline-tracking that referenced this issue Dec 6, 2019
@yonghuah @bpankajl
vhm: add ioctl for set/clear IRQ line
1815333 
  ASSERT/DEASSERT/PULSE IRQ line ioctl commands
  will be deprecated.

Tracked-On: projectacrn/acrn-hypervisor#861
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Reviewed-by: Fei Li <fei1.li@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
sys-oak pushed a commit to intel/mainline-tracking that referenced this issue Dec 6, 2019
@mingqiangchi @bpankajl
kernel: Sync the common header file
76a49fb 
Change the type from uint8_t to uint32_t for interrupt pin

Tracked-On: projectacrn/acrn-hypervisor#861

Change-Id: Ifcd64388a99c810fa30f0270b087c4c6e3d1af07
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
Reviewed-by: Zhao Yakui <yakui.zhao@intel.com>
Tracked-On: PKT-1696
finomeng pushed a commit to intel/linux-stable-xenomai that referenced this issue Mar 5, 2020
@yonghuah @finomeng
vhm: add ioctl for set/clear IRQ line
2d763c1 
  ASSERT/DEASSERT/PULSE IRQ line ioctl commands
  will be deprecated.

Tracked-On: projectacrn/acrn-hypervisor#861
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Reviewed-by: Fei Li <fei1.li@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
finomeng pushed a commit to intel/linux-stable-xenomai that referenced this issue Mar 5, 2020
@yonghuah @finomeng
kernel: remove deprecated VHM IOCTLs
539a1f8 
below IOCTLs are wrapped into IC_SET_IRQLINE:

 - IC_ASSERT_IRQLINE
 - IC_DEASSERT_IRQLINE
 - IC_PULSE_IRQLINE

Tracked-On: projectacrn/acrn-hypervisor#861
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Acked-by: Anthony Xu <anthony.xu@intel.com>
finomeng pushed a commit to intel/linux-stable-xenomai that referenced this issue Mar 5, 2020
@mingqiangchi @finomeng
kernel: Sync the common header file
4ddaab0 
Change the type from uint8_t to uint32_t for interrupt pin

Tracked-On: projectacrn/acrn-hypervisor#861

Change-Id: Ifcd64388a99c810fa30f0270b087c4c6e3d1af07
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
Reviewed-by: Zhao Yakui <yakui.zhao@intel.com>
Tracked-On: PKT-1696
mingqiangchi added a commit to mingqiangchi/acrn-hypervisor that referenced this issue Mar 10, 2020
@mingqiangchi
hv:rename several variables and api for ioapic
a041633 
rename:
  ioapic_get_gsi_irq_addr --> gsi_to_ioapic_base
  ioapic_addr -->ioapic_base

Tracked-On: projectacrn#861
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
@mingqiangchi mingqiangchi mentioned this issue Mar 10, 2020
Merged
dongyaozu pushed a commit that referenced this issue Mar 11, 2020
@mingqiangchi @dongyaozu
hv:rename several variables and api for ioapic
790614e 
rename:
  ioapic_get_gsi_irq_addr --> gsi_to_ioapic_base
  ioapic_addr -->ioapic_base

Tracked-On: #861
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
@ghost ghost mentioned this issue Mar 30, 2020
Closed
yonghuah added a commit to yonghuah/acrn-hypervisor that referenced this issue Apr 16, 2020
@yonghuah
hv: wrap a function to initialize pCPU for second phase
c9f4af1 
 This patch wrapps a common function to initialize physical
 CPU for the second phase to reduce redundant code.

Tracked-On: projectacrn#861
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
@yonghuah yonghuah mentioned this issue Apr 16, 2020
Merged
wenlingz pushed a commit that referenced this issue Apr 16, 2020
@yonghuah @wenlingz
hv: wrap a function to initialize pCPU for second phase
84eaf94 
 This patch wrapps a common function to initialize physical
 CPU for the second phase to reduce redundant code.

Tracked-On: #861
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Nov 27, 2020
@shiqingg
hv: coding style clean-up related to Boolean
3a4b5ad 
While following two styles are both correct, the 2nd one is simpler.
	bool is_level_triggered;
	1. if (is_level_triggered == true) {...}
	2. if (is_level_triggered) {...}

This patch cleans up the style in hypervisor.

Tracked-On: projectacrn#861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
@shiqingg shiqingg mentioned this issue Nov 27, 2020
Merged
wenlingz pushed a commit that referenced this issue Nov 28, 2020
@shiqingg @wenlingz
hv: coding style clean-up related to Boolean
6f10bd0 
While following two styles are both correct, the 2nd one is simpler.
	bool is_level_triggered;
	1. if (is_level_triggered == true) {...}
	2. if (is_level_triggered) {...}

This patch cleans up the style in hypervisor.

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
@NanlinXie
Copy link
Contributor

Closed with no regression issues.

shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Jul 2, 2024
@shiqingg
release: fix the compilation error in release mode
fb383fc 
Commit `512c98fd7 hv: trace: show cpu usage of vms in pcpu sharing case`
causes the compilation error in release mode:
  hypervisor/common/schedule.c:190: undefined reference to `TRACE_16STR'

This patch fixes this issue.

Tracked-On: projectacrn#861

Signed-off-by: Gao, Shiqing <shiqing.gao@intel.com>
@shiqingg shiqingg mentioned this issue Jul 2, 2024
Merged
acrnsi-robot pushed a commit that referenced this issue Jul 3, 2024
@shiqingg @acrnsi-robot
release: fix the compilation error in release mode
f398b9c 
Commit `512c98fd7 hv: trace: show cpu usage of vms in pcpu sharing case`
causes the compilation error in release mode:
  hypervisor/common/schedule.c:190: undefined reference to `TRACE_16STR'

This patch fixes this issue.

Tracked-On: #861

Signed-off-by: Gao, Shiqing <shiqing.gao@intel.com>
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Jul 3, 2024
@shiqingg
hv: reloc: enclose elf64_r_type() with #ifdef CONFIG_RELOC
d637a3b 
elf64_r_type() is only invoked when CONFIG_RELOC is defined.
This patch encloses its definition with `#ifdef CONFIG_RELOC`,
otherwise, it is dead code.

Tracked-On: projectacrn#861

Signed-off-by: Gao, Shiqing <shiqing.gao@intel.com>
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Jul 3, 2024
@shiqingg
hv: vtd: fix use of uninitialized variable in dmar_free_irte
7ee5814 
This patch fixes the following error:
  error: variable 'sid' is used uninitialized whenever 'if' condition is true
  [-Werror,-Wsometimes-uninitialized]

Tracked-On: projectacrn#861

Signed-off-by: Gao, Shiqing <shiqing.gao@intel.com>
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Jul 3, 2024
@shiqingg
hv: vrtc: tag rtc_halted with the __unused attribute
726f905 
rtc_halted() is not invoked anywhere in the code.
This patch fixes below error by tagging this function with the
`__unused` attribute.
  error: unused function 'rtc_halted' [-Werror,-Wunused-function]

Tracked-On: projectacrn#861

Signed-off-by: Gao, Shiqing <shiqing.gao@intel.com>
shiqingg added a commit to shiqingg/acrn-hypervisor that referenced this issue Jul 3, 2024
@shiqingg
hv: vrtc: remove the unused function rtc_halted()
75ab5d9 
rtc_halted() is not invoked anywhere in the code.
This patch removes this unused function to fix below error.
  error: unused function 'rtc_halted' [-Werror,-Wunused-function]

Tracked-On: projectacrn#861

Signed-off-by: Gao, Shiqing <shiqing.gao@intel.com>
acrnsi-robot pushed a commit that referenced this issue Jul 3, 2024
@shiqingg @acrnsi-robot
hv: reloc: enclose elf64_r_type() with #ifdef CONFIG_RELOC
2aed0c7 
elf64_r_type() is only invoked when CONFIG_RELOC is defined.
This patch encloses its definition with `#ifdef CONFIG_RELOC`,
otherwise, it is dead code.

Tracked-On: #861

Signed-off-by: Gao, Shiqing <shiqing.gao@intel.com>
acrnsi-robot pushed a commit that referenced this issue Jul 3, 2024
@shiqingg @acrnsi-robot
hv: vtd: fix use of uninitialized variable in dmar_free_irte
0bcf469 
This patch fixes the following error:
  error: variable 'sid' is used uninitialized whenever 'if' condition is true
  [-Werror,-Wsometimes-uninitialized]

Tracked-On: #861

Signed-off-by: Gao, Shiqing <shiqing.gao@intel.com>
acrnsi-robot pushed a commit that referenced this issue Jul 3, 2024
@shiqingg @acrnsi-robot
hv: vrtc: remove the unused function rtc_halted()
cc90135 
rtc_halted() is not invoked anywhere in the code.
This patch removes this unused function to fix below error.
  error: unused function 'rtc_halted' [-Werror,-Wunused-function]

Tracked-On: #861

Signed-off-by: Gao, Shiqing <shiqing.gao@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: hypervisor priority: high status: Assigned Assigned type: feature New feature
Projects
Roadmap
  
v1.0
Milestone
v0.5
Development

No branches or pull requests
3 participants
@hwang37 @NanlinXie @Mingyuan18