Skip to content

Commit e0d14b7

Browse files
deb-intelwenlingz
authored andcommitted
Doc: Grammatical edits to the 1.4 Release Notes.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
1 parent d8bd508 commit e0d14b7

File tree

1 file changed

+32
-33
lines changed

1 file changed

+32
-33
lines changed

doc/release_notes/release_notes_1.4.rst

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ ACRN v1.4 (Oct 2019)
55

66
We are pleased to announce the release of ACRN version 1.4.
77

8-
ACRN is a flexible, lightweight reference hypervisor, built with
9-
real-time and safety-criticality in mind, optimized to streamline embedded
8+
ACRN is a flexible, lightweight reference hypervisor that is built with
9+
real-time and safety-criticality in mind. It is optimized to streamline embedded
1010
development through an open source platform. Check out the :ref:`introduction` for more information.
1111
All project ACRN source code is maintained in the https://github.com/projectacrn/acrn-hypervisor
1212
repository and includes folders for the ACRN hypervisor, the ACRN device
@@ -22,67 +22,66 @@ or use Git clone and checkout commands::
2222
The project's online technical documentation is also tagged to correspond
2323
with a specific release: generated v1.4 documents can be found at https://projectacrn.github.io/1.4/.
2424
Documentation for the latest (master) branch is found at https://projectacrn.github.io/latest/.
25-
ACRN v1.4 requires Clear Linux* OS version 31520. Please follow the
25+
ACRN v1.4 requires Clear Linux* OS version 31520. Follow the
2626
instructions in the :ref:`rt_industry_setup`.
2727

2828
Version 1.4 major features
2929
**************************
3030

3131
What's New in v1.4
3232
==================
33-
* ACRN is now conformant to Microsoft(r) Hypervisor Top Level Functional Specification(TLFS).
34-
* Added basic CPU sharing capabilities.
35-
* Improved WaaG (Windows as a guest) stability and performance.
36-
* Improved Realtime performance of RTVM (preempt-RT kernel based).
33+
* ACRN now conforms to the Microsoft* Hypervisor Top-Level Functional Specification (TLFS).
34+
* Basic CPU sharing capabilities have been added.
35+
* WaaG (Windows as a guest) stability and performance has been improved.
36+
* Realtime performance of the RTVM (preempt-RT kernel-based) has been improved.
3737

3838
Document updates
3939
================
40-
We have many new `reference documents available <https://projectacrn.github.io>`_, including:
40+
Many new `reference documents <https://projectacrn.github.io>`_ are available, including:
4141

42-
* [to be update once pr merge]:enable-s5
42+
* :ref:`enable-s5`
4343
* :ref:`enable_laag_secure_boot`
4444
* :ref:`How-to-enable-secure-boot-for-windows`
45-
* [to be update once pr merge]:asa
45+
* :ref:`asa`
4646

4747
Security Vulnerabilities
4848
************************
4949

50-
We recommend all developers upgrade to this v1.4 release, which addresses these security
51-
issues discovered in earlier releases:
50+
We recommend that all developers upgrade to this v1.4 release, which
51+
addresses the following security issues that were discovered in previous releases:
5252

53-
AP Trampoline Is Accessible to Service VM
54-
This vulnerability is triggered when validating the memory isolation between
55-
VM and hypervisor. AP Trampoline code exists in LOW_RAM region in hypervisor but is
56-
potentially accessible to service VM. This could be used by an attacker to mount DoS
57-
attacks on the hypervisor if service VM is compromised.
53+
AP Trampoline Is Accessible to the Service VM
54+
This vulnerability is triggered when validating the memory isolation between the VM and hypervisor. The AP Trampoline code exists in the LOW_RAM region in the hypervisor but is
55+
potentially accessible to the Service VM. This could be used by an attacker to mount DoS
56+
attacks on the hypervisor if the Service VM is compromised.
5857

59-
Improper Usage Of ``LIST_FOREACH()`` macro
60-
Testing discovered that the MACRO ``LIST_FOREACH()`` was incorrectly used for some cases
61-
which may induce a "wild pointer" and cause ACRN Device Model crash. An attacker
62-
could use this issue to cause a denial of service (DoS).
58+
Improper Usage Of the ``LIST_FOREACH()`` Macro
59+
Testing discovered that the MACRO ``LIST_FOREACH()`` was incorrectly used in some cases
60+
which could induce a "wild pointer" and cause the ACRN Device Model to crash. Attackers
61+
can potentially use this issue to cause denial of service (DoS) attacks.
6362

6463
Hypervisor Crashed When Fuzzing HC_SET_CALLBACK_VECTOR
65-
This vulnerability was reported by Fuzzing tool for debug version of ACRN. When software fails
64+
This vulnerability was reported by the Fuzzing tool for the debug version of ACRN. When the software fails
6665
to validate input properly, an attacker is able to craft the input in a form that is
6766
not expected by the rest of the application. This can lead to parts of the system
68-
receiving unintended input, which may result in altered control flow, arbitrary control
67+
receiving unintended inputs, which may result in an altered control flow, arbitrary control
6968
of a resource, or arbitrary code execution.
7069

7170
FILE Pointer Is Not Closed After Using
72-
This vulnerability was reported by Fuzzing tool. Leaving the file unclosed will cause
73-
leaking file descriptor and may cause unexpected errors in Device Model program.
71+
This vulnerability was reported by the Fuzzing tool. Leaving the file unclosed will cause a
72+
leaking file descriptor and may cause unexpected errors in the Device Model program.
7473

7574
Descriptor of Directory Stream Is Referenced After Release
76-
This vulnerability was reported by Fuzzing tool. A successful call to ``closedir(DIR *dirp)``
75+
This vulnerability was reported by the Fuzzing tool. A successful call to ``closedir(DIR *dirp)``
7776
also closes the underlying file descriptor associated with ``dirp``. Access to the released
7877
descriptor may point to some arbitrary memory location or cause undefined behavior.
7978

80-
Mutex Is Potentially Kept in Locked State Forever
81-
This vulnerability was reported by Fuzzing tool. pthread_mutex_lock/unlock pairing was not
79+
Mutex Is Potentially Kept in a Locked State Forever
80+
This vulnerability was reported by the Fuzzing tool. Here, ``pthread_mutex_lock/unlock`` pairing was not
8281
always done. Leaving a mutex in a locked state forever can cause program deadlock,
8382
depending on the usage scenario.
8483

85-
We recommend all developers upgrade to ACRN release v1.4.
84+
We recommend that all developers upgrade to ACRN release v1.4.
8685

8786
New Features Details
8887
********************
@@ -120,7 +119,7 @@ Fixed Issues Details
120119
- :acrn-issue:`3708` - [Auto][Daily][OVMF] RTVM can not launch after poweroff, rtvm can not reboot
121120
- :acrn-issue:`3718` - [KBLNUC][Stability][RTVM]WaaG hang after keep WaaG idle in RTVM Create/Destroy test.
122121
- :acrn-issue:`3729` - [KBLNUC]Cannot auto boot 2 VMs with acrnd
123-
- :acrn-issue:`3751` - [acrn-configuration-tool] The default launch script generated by acrn-config for Preemp-RT
122+
- :acrn-issue:`3751` - [acrn-configuration-tool] The default launch script generated by acrn-config for Preemp-RT
124123
Linux will pass through Ethernet device, which does not match the behavior with devicemodel/samples/nuc/launch_hard_rt.sh
125124
- :acrn-issue:`3754` - [acrn-configuration-tool] WebUI could not select /dev/mmcblk0p1 as UOS rootfs for apl-up2 board, and /dev/mmcblk1p3 for apl-mrb
126125
- :acrn-issue:`3760` - [acrn-configuration-tool]WebUI could not generate configuration patch for a new imported board
@@ -132,14 +131,14 @@ Fixed Issues Details
132131
- :acrn-issue:`3801` - [UP2/KBL][HV][LaaG][Fuzzing]Hypervisor crash when run syz_ic_set_callback_vector.
133132
- :acrn-issue:`3809` - [acrn-configuration-tool]The "uos_type"& items in "passthrough_devices" will disappear when clicking on the drop-down box.
134133
- :acrn-issue:`3811` - [acrn-configuration-tool]Fail to Generate launch_script for a new imported board
135-
- :acrn-issue:`3812` - [acrn-configuration-tool] Generated Launch script is incorrect when select ethernet for apl-mrb with
134+
- :acrn-issue:`3812` - [acrn-configuration-tool] Generated Launch script is incorrect when select ethernet for apl-mrb with
136135
Scenario:SDC+Launch Setting: sdc_launch_1uos_laag/aaag
137136
- :acrn-issue:`3817` - DM: FILE Pointer Is Not Closed After Operations in acrn_load_elf
138137
- :acrn-issue:`3821` - DM: DIR handler is referenced after release in npk.c
139138
- :acrn-issue:`3822` - DM: Potential Buffer Overflow due to Unvalidated Input in vm_monitor_blkrescan()
140139
- :acrn-issue:`3825` - DM: 'request_mutex' is potentially not unlocked in tpm_crb.c
141140
- :acrn-issue:`3827` - Service VM power off need at least one minute when passthru NVMe to RTVM
142-
- :acrn-issue:`3834` - [acrn-configuration-tool] UX enhancement: acrn-config end users hope to have interfaces to commit changes to
141+
- :acrn-issue:`3834` - [acrn-configuration-tool] UX enhancement: acrn-config end users hope to have interfaces to commit changes to
143142
local tree or not after setting scenario/launch scripts
144143
- :acrn-issue:`3840` - [Hybrid][UP2][GVT][LaaG]LaaG has no display with uefi boot mode
145144
- :acrn-issue:`3852` - [acrn-configuration-tool]RTVM cannot launched successfully after have launched vxworks or waag.
@@ -155,7 +154,7 @@ Fixed Issues Details
155154
- :acrn-issue:`3925` - Statically allocate 2 pCPUs for hard RT VM by default
156155
- :acrn-issue:`3932` - [KBL][acrn-configuration-tool]Generated Launch script miss "-m $mem_size" after select passthru_device
157156
- :acrn-issue:`3933` - [KBLNUC][Function][LaaG] can't bootup LaaG
158-
- :acrn-issue:`3937` - [KBL][acrn-configuration-tool][WaaG]Generated Launch script miss boot_audio_option's right_double_quotation_marks
157+
- :acrn-issue:`3937` - [KBL][acrn-configuration-tool][WaaG]Generated Launch script miss boot_audio_option's right_double_quotation_marks
159158
for Board info:nuc7i7dnb + Launch Setting: industry_launch_1uos_waag
160159
- :acrn-issue:`3947` - [ISD][Stability][WaaG] WaaG auto boot failed after systemctl enable acrnd during S5 testing
161160
- :acrn-issue:`3948` - [KBL][acrn-configuration-tool]'keep_gsi' should not set along with waag vm

0 commit comments

Comments
 (0)