112855Sgabeblack@google.com/*****************************************************************************
212855Sgabeblack@google.com
312855Sgabeblack@google.com  Licensed to Accellera Systems Initiative Inc. (Accellera) under one or
412855Sgabeblack@google.com  more contributor license agreements.  See the NOTICE file distributed
512855Sgabeblack@google.com  with this work for additional information regarding copyright ownership.
612855Sgabeblack@google.com  Accellera licenses this file to you under the Apache License, Version 2.0
712855Sgabeblack@google.com  (the "License"); you may not use this file except in compliance with the
812855Sgabeblack@google.com  License.  You may obtain a copy of the License at
912855Sgabeblack@google.com
1012855Sgabeblack@google.com    http://www.apache.org/licenses/LICENSE-2.0
1112855Sgabeblack@google.com
1212855Sgabeblack@google.com  Unless required by applicable law or agreed to in writing, software
1312855Sgabeblack@google.com  distributed under the License is distributed on an "AS IS" BASIS,
1412855Sgabeblack@google.com  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
1512855Sgabeblack@google.com  implied.  See the License for the specific language governing
1612855Sgabeblack@google.com  permissions and limitations under the License.
1712855Sgabeblack@google.com
1812855Sgabeblack@google.com *****************************************************************************/
1912855Sgabeblack@google.com
2012855Sgabeblack@google.com/*****************************************************************************
2112855Sgabeblack@google.com
2212855Sgabeblack@google.com  stack_alignment.cpp -- This example shows the crash of an fxsave instruction
2312855Sgabeblack@google.com                         in the sc_thread stack environment, but not in the
2412855Sgabeblack@google.com                         original linux process stack, which is correctly
2512855Sgabeblack@google.com                         aligned on first function.
2612855Sgabeblack@google.com
2712855Sgabeblack@google.com  Please note that this test probably runs OK on a faulty implementation in
2812855Sgabeblack@google.com  64-bit in general (depending on your libc implementation), but will crash
2912855Sgabeblack@google.com  for sure in 32-bit.
3012855Sgabeblack@google.com
3112855Sgabeblack@google.com  Original Author: Eric Paire, STMicroelectronics
3212855Sgabeblack@google.com
3312855Sgabeblack@google.com *****************************************************************************/
3412855Sgabeblack@google.com
3512855Sgabeblack@google.com/*****************************************************************************
3612855Sgabeblack@google.com
3712855Sgabeblack@google.com  MODIFICATION LOG - modifiers, enter your name, affiliation, date and
3812855Sgabeblack@google.com  changes you are making here.
3912855Sgabeblack@google.com
4012855Sgabeblack@google.com      Name, Affiliation, Date:
4112855Sgabeblack@google.com  Description of Modification:
4212855Sgabeblack@google.com
4312855Sgabeblack@google.com *****************************************************************************/
4412855Sgabeblack@google.com
4512855Sgabeblack@google.com#include "systemc.h"
4612855Sgabeblack@google.com
4712855Sgabeblack@google.com/*
4812855Sgabeblack@google.com * This program exhibits a bug in the management by QT of the stack of each
4912855Sgabeblack@google.com * SystemC process. At least on i686 & x86_64, GCC makes the assumption that
5012855Sgabeblack@google.com * the stack is aligned on a 16-byte boundary on each C/C++ function entry.
5112855Sgabeblack@google.com * This convention allows GCC to respects constraints of automatic (stack)
5212855Sgabeblack@google.com * variable alignment, using the __attribute)__ ((align(X))) GCC extension.
5312855Sgabeblack@google.com *
5412855Sgabeblack@google.com * The X is known to be 16 for i686 & x86_64, as this is the largest alignment
5512855Sgabeblack@google.com * required by instructions operands, actually used by fxsave instruction.
5612855Sgabeblack@google.com *
5712855Sgabeblack@google.com * The attached code shows up the problem by crashing when fxsave is executed
5812855Sgabeblack@google.com * in a SystemC thread, and executing correctly the *same* code on the initial
5912855Sgabeblack@google.com * process stack, as initialized by the libc runtime.
6012855Sgabeblack@google.com *
6112855Sgabeblack@google.com * This misbehavior does not occur systematically for x86_64 (no crash,
6212855Sgabeblack@google.com * or crash difficult to reproduce with standard malloc()), but often does
6312855Sgabeblack@google.com * with i686. Notice that the instruction with the right alignment is shown
6412855Sgabeblack@google.com * when using the myfpxregs address which is aligned on 16-byte boundary.
6512855Sgabeblack@google.com */
6612855Sgabeblack@google.com
6712855Sgabeblack@google.com#if defined(__x86_64__)
6812855Sgabeblack@google.com#  define FXSAVE "fxsaveq"
6912855Sgabeblack@google.com#else
7012855Sgabeblack@google.com#  define FXSAVE "fxsave"
7112855Sgabeblack@google.com#endif
7212855Sgabeblack@google.com
7312855Sgabeblack@google.com#if defined(__GNUC__)
7412855Sgabeblack@google.com#  define ALIGNED_ARRAY( Type, Name, Size, Align ) \
7512855Sgabeblack@google.com	  Type Name[Size] __attribute__((aligned(Align)))
7612855Sgabeblack@google.com#elif defined(_MSC_VER)
7712855Sgabeblack@google.com#  define ALIGNED_ARRAY( Type, Name, Size, Align ) \
7812855Sgabeblack@google.com      __declspec(align(Align)) Type Name[Size]
7912855Sgabeblack@google.com#endif
8012855Sgabeblack@google.com
8112855Sgabeblack@google.com#if defined(__GNUC__) && ( defined(__x86_64__) || defined(__i386__) )
8212855Sgabeblack@google.com#  define ASM( Assembly ) __asm__ __volatile__( Assembly )
8312855Sgabeblack@google.com#else
8412855Sgabeblack@google.com#  define ASM( Assembly ) /* not implemented */
8512855Sgabeblack@google.com#endif
8612855Sgabeblack@google.com
8712855Sgabeblack@google.com// Class
8812855Sgabeblack@google.comSC_MODULE(C)
8912855Sgabeblack@google.com{
9012855Sgabeblack@google.compublic:
9112855Sgabeblack@google.com    SC_CTOR(C) {
9212855Sgabeblack@google.com        SC_THREAD(run);
9312855Sgabeblack@google.com    }
9412855Sgabeblack@google.com    void run(void)
9512855Sgabeblack@google.com    {
9612855Sgabeblack@google.com        ALIGNED_ARRAY( char, fpxregs64, 512+15, 16 );
9712855Sgabeblack@google.com
9812855Sgabeblack@google.com        cout << "Inside C::run() " << endl;
9912855Sgabeblack@google.com
10012855Sgabeblack@google.com        // manually enforce alignment (volatile to avoid optmizations)
10112855Sgabeblack@google.com        char * volatile myfpxregs = fpxregs64;
10212855Sgabeblack@google.com        while ((uintptr_t)myfpxregs & 0xF)
10312855Sgabeblack@google.com            myfpxregs++;
10412855Sgabeblack@google.com
10512855Sgabeblack@google.com        // the "real" requirement: enforced alignment works
10612855Sgabeblack@google.com        sc_assert( !((uintptr_t)fpxregs64 & 0xF) );
10712855Sgabeblack@google.com        sc_assert( !((uintptr_t)myfpxregs & 0xF) );
10812855Sgabeblack@google.com        sc_assert( myfpxregs == fpxregs64 );
10912855Sgabeblack@google.com
11012855Sgabeblack@google.com        // test assembly on supported platforms
11112855Sgabeblack@google.com        ASM( FXSAVE " (%0)" :: "r"(myfpxregs) );
11212855Sgabeblack@google.com        cout << "Between C::run() " << endl;
11312855Sgabeblack@google.com        ASM( FXSAVE " %0" : "=m"(fpxregs64) );
11412855Sgabeblack@google.com
11512855Sgabeblack@google.com        cout << "Out of C::run() " << endl;
11612855Sgabeblack@google.com    }
11712855Sgabeblack@google.com};
11812855Sgabeblack@google.com
11912855Sgabeblack@google.comint sc_main(int , char** ) {
12012855Sgabeblack@google.com  C the_C("C");
12112855Sgabeblack@google.com
12212855Sgabeblack@google.com  ALIGNED_ARRAY( char, fpxregs64, 512, 16 );
12312855Sgabeblack@google.com
12412855Sgabeblack@google.com  cout << "Inside sc_main() " << endl;
12512855Sgabeblack@google.com  ASM( FXSAVE " %0" : "=m"(fpxregs64) );
12612855Sgabeblack@google.com  sc_start(1, SC_NS);
12712855Sgabeblack@google.com  cout << "Out of sc_main() " << endl;
12812855Sgabeblack@google.com  return 0;
12912855Sgabeblack@google.com}
130