From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 0A5FD81EF0 for ; Wed, 16 Nov 2016 11:21:19 -0800 (PST) Received: from int-mx11.intmail.prod.int.phx2.redhat.com (int-mx11.intmail.prod.int.phx2.redhat.com [10.5.11.24]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 9111B1B09; Wed, 16 Nov 2016 19:21:23 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-116-80.phx2.redhat.com [10.3.116.80]) by int-mx11.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id uAGJLLsI019730; Wed, 16 Nov 2016 14:21:21 -0500 To: "Kinney, Michael D" , "Fan, Jeff" , "edk2-devel@ml01.01.org" References: <20161115140809.5292-1-jeff.fan@intel.com> <605a5187-5b91-e0f8-5560-8a02ddad5057@redhat.com> Cc: Paolo Bonzini , "Yao, Jiewen" , "Tian, Feng" From: Laszlo Ersek Message-ID: <87503cca-0496-e78c-cc94-c27c1417901e@redhat.com> Date: Wed, 16 Nov 2016 20:21:20 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.4.0 MIME-Version: 1.0 In-Reply-To: X-Scanned-By: MIMEDefang 2.68 on 10.5.11.24 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.28]); Wed, 16 Nov 2016 19:21:23 +0000 (UTC) Subject: Re: [PATCH v2 0/2] Add volatile for mNumberToFinish X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 16 Nov 2016 19:21:19 -0000 Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: 7bit On 11/16/16 19:18, Kinney, Michael D wrote: > Laszlo, > > Thanks for the details from and ANSI C spec. > > For this compiler issue, are there more details on the > assembly code generated by the GCC 5.4 compiler in the > failing mode? Unfortunately, I have little first-hand experience with this kind of failure, I've just read different accounts of it. Perhaps Paolo can comment -- my experience with contacting GCC maintainers directly hasn't been stellar. > I also see Liming's observation that the internal > implementation of the SynchronizationLib adds volatile > in some internal worker functions. Other implementation > artifacts include the use of a read/write memory barrier > to prevent the optimizing compiler from optimizing > across a boundary. These read/write barriers are used > in the spin lock functions, but not the Interlocked*() > functions. > > I want to make sure we have studied the code generation > to see if the issue is related to volatile or a read/write > memory barrier. It could be adding volatile forced the > compiler to internally add read/write barrier. In my understanding, MemoryFence() [MdePkg/Library/BaseLib/X64/GccInline.c] is just a compiler-level barrier, not a processor level barrier. __asm__ __volatile__ ("":::"memory"); Processor level barriers shouldn't be a problem here; as far as I recall from the SDM from a few days ago, the XCHG instruction "engages the CPU's locking protocol even without the LOCK prefix", plus I see an explicit LOCK in InternalSyncDecrement() [MdePkg/Library/BaseSynchronizationLib/X64/GccInline.c] for example. I'm pretty sure the compiler opimized away the access because it saw no intervening access (it doesn't know about the code running on other CPUs). I think "volatile" and MemoryFence() -- with the latter telling GCC that all memory should be considered clobbered -- should fix the issue just the same, in this situation. > Also, given the implementation I see in the SynchronizationLib > I am not sure the cast to (UINT32 *) is required in the > proposed patch. Do we get compiler warnings/errors if those > casts are not included? Yes. Passing an argument to a function whose prototype is visible invokes type conversion just like in assignment: 6.5.2.2 Function calls 7 If the expression that denotes the called function has a type that does include a prototype, the arguments are implicitly converted, as if by assignment, to the types of the corresponding parameters, taking the type of each parameter to be the unqualified version of its declared type. [...] (IMPORTANT: the de-qualification mentioned above refers to the pointer object itself, not to the pointed-to object! It just means if you have a function parameter "const long x", and pass the argument 5 (which has type int), then it is converted to "long", and not "const long".) So, passing a (volatile UINT32 *) argument to a (UINT32 *) parameter is the same as the similar assignment volatile UINT32 *x; UINT32 *y; y = x; Then, regarding assignment, we have 6.5.16.1 Simple assignment Constraints 1 One of the following shall hold: [...] - both operands are pointers to qualified or unqualified versions of compatible types, and the type pointed to by the left has all the qualifiers of the type pointed to by the right; [...] Finally we have diagnostics, 5.1.1.3 Diagnostics 1 A conforming implementation shall produce at least one diagnostic message (identified in an implementation-defined manner) if a preprocessing translation unit or translation unit contains a violation of any syntax rule or constraint, even if the behavior is also explicitly specified as undefined or implementation-defined. [...] In summary, without adding the explicit cast, we break the constraint on simple assignment, which requires the compiler to emit a diagnostic message. (In turn if we add the explicit cast, we break other requirements, as discussed in my other email -- and here we should investigate whether we care about breaking that exact rule.) > The second topic is what the SynchronizationLib API interfaces > should have been from the beginning. In retrospect, I think > they should have been defined with volatile pointers. I agree! > The spin > lock APIs do use volatile pointers, but that is embedded in the > typedef for SPIN_LOCK, so it is not as obvious. Thanks Laszlo >> -----Original Message----- >> From: Laszlo Ersek [mailto:lersek@redhat.com] >> Sent: Tuesday, November 15, 2016 8:10 AM >> To: Fan, Jeff ; edk2-devel@ml01.01.org >> Cc: Paolo Bonzini ; Yao, Jiewen ; Tian, >> Feng ; Kinney, Michael D >> Subject: Re: [PATCH v2 0/2] Add volatile for mNumberToFinish >> >> Jeff, >> >> On 11/15/16 15:08, Jeff Fan wrote: >>> v2: >>> Add patch #1 per Laszlo's comments >>> at https://lists.01.org/pipermail/edk2-devel/2016-November/004697.html >>> >>> About the comments updated SynchronizationLib to add volatile for >>> input parameter, I will send in another serial patches. >>> >>> Cc: Paolo Bonzini >>> Cc: Laszlo Ersek >>> Cc: Jiewen Yao >>> Cc: Feng Tian >>> Cc: Michael D Kinney >>> Contributed-under: TianoCore Contribution Agreement 1.0 >>> Signed-off-by: Jeff Fan >>> >>> Jeff Fan (2): >>> UefiCpuPkg/PiSmmCpuDxeSmm: Add volatile for parameter NumberToFinish >>> UefiCpuPkg/PiSmmCpuDxeSmm: Add volatile for mNumberToFinish >>> >>> UefiCpuPkg/PiSmmCpuDxeSmm/CpuS3.c | 4 ++-- >>> UefiCpuPkg/PiSmmCpuDxeSmm/Ia32/SmmFuncsArch.c | 4 ++-- >>> UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h | 2 +- >>> UefiCpuPkg/PiSmmCpuDxeSmm/X64/SmmFuncsArch.c | 2 +- >>> 4 files changed, 6 insertions(+), 6 deletions(-) >>> >> >> if you want to keep GCC5.4 from optimizing away the access, the >> synchronization object itself, and all pointers to it must remain >> volatile. Wherever you cast away the volatile qualifier, for example in >> a function call, GCC can break code on the next level, even if you don't >> actually access the object through that pointer (i.e., if you cast the >> pointer back to volatile just in time for the access). >> >> So, the safe way to go about this is to change function prototypes from >> callee towards callers -- first change the callee (because both volatile >> and non-volatile can be accepted as volatile), then change the caller >> (make sure what you pass in is volatile, and propagate it outwards). >> >> It is also okay to convert the original volatile pointer to UINTN, and >> to pass it to assembly code like that, or to convert it back to a >> volatile pointer from UINTN before use. >> >> From the C99 standard: >> >> 6.3 Conversions >> 6.3.2.3 Pointers >> >> 2 For any qualifier q, a pointer to a non-q-qualified type may be >> converted to a pointer to the q-qualified version of the type; the >> values stored in the original and converted pointers shall compare >> equal. >> >> 5 An integer may be converted to any pointer type. Except as >> previously specified, the result is implementation-defined, might >> not be correctly aligned, might not point to an entity of the >> referenced type, and might be a trap representation. >> >> 6 Any pointer type may be converted to an integer type. Except as >> previously specified, the result is implementation-defined. If the >> result cannot be represented in the integer type, the behavior is >> undefined. The result need not be in the range of values of any >> integer type. >> >> 6.7.3 Type qualifiers, paragraph 5: >> >> If an attempt is made to modify an object defined with a >> const-qualified type through use of an lvalue with >> non-const-qualified type, the behavior is undefined. If an attempt >> is made to refer to an object defined with a volatile-qualified >> type through use of an lvalue with non-volatile-qualified type, the >> behavior is undefined. >> >> In summary: >> >> - casting away "volatile" even just temporarily (without actual >> accesses) may give gcc license to break the code (6.3.2.3 p2) >> >> - accessing without volatile is known to break the code (6.7.3 p5) >> >> - you can always cast from non-volatile to volatile (6.3.2.3 p2), >> but not the other way around! >> >> - you can cast from (volatile VOID *) to UINTN and back as much as >> you want (6.3.2.3 p5 p6), because our execution environment makes >> that safe ("implementation-defined") >> >> We might want to play loose with 6.3.2.3 p2 -- that is, cast away >> volatile from the pointer only temporarily, and cast it back just before >> accessing the object through the pointer --, but that could be unsafe in >> the long term. The *really* safe method is to cast it to UINTN, and then >> back the same way. >> >> Yes, this would affect functions like SwitchStack() too -- the Context1 >> and Context2 parameters would have to change their types to UINTN. >> >> I think what we should discuss at this point is whether we'd like to >> care about 6.3.2.3 p2; that is, whether we consider casting away >> volatile temporarily. >> >> The direction I've been experiencing with GCC is that its optimization >> methods are becoming more aggressive. For some optimizations, there are >> flags that disable them; I'm not sure they provide a specific flag for >> preventing GCC from exploiting violations of 6.3.2.3 p2. >> >> Thanks >> Laszlo