summaryrefslogtreecommitdiffstats
path: root/src/usr/fapi2/test/fapi2BasicTryTest.H
blob: cf1bfe0f8d315afa720b1440aeb4b7be47fb0b5c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/fapi2/test/fapi2BasicTryTest.H $                      */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2016                             */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (the "License");        */
/* you may not use this file except in compliance with the License.       */
/* You may obtain a copy of the License at                                */
/*                                                                        */
/*     http://www.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
#include <fapi2.H>
#include <fapi2/plat_hwp_invoker.H>

//--------------------------------------------------------------------------
/// @file  p9_basicTry.C
///
/// @brief This does tests of the FAPI try and FAPI assert MACROs without
///        needing full ReturnCode support.
//--------------------------------------------------------------------------

namespace fapi2
{

class Fapi2BasicTryTest : public CxxTest::TestSuite
{
    private:

    // This is the basic function that allows us to set a return code
    // that we can use for  FAPI_TRY macro testing.
    uint32_t  p9_forceTestUsingRc( uint32_t  i_rc )
    {
        FAPI_INF("p9_forceTestUsingRc  with RC = %d", i_rc );

        return(i_rc);
    }


    // Force a bad RC and see if FAPI_TRY will do the goto exit
    fapi2::ReturnCode  p9_fapi_tryFailure(  )
    {

        FAPI_INF("Go for BAD TEST ");
        FAPI_TRY( p9_forceTestUsingRc(0xFF) );

        // Should never get here since we failed routine above
        // Hence, I want to fail testcase if we do
        FAPI_ERR("Completed BAD TEST --Should never get here");
        fapi2::current_err = 0xDEAD;
        return fapi2::current_err;

    fapi_try_exit:
        // We failed as expected
        FAPI_INF( "Had RC %d but will exit cleanly",
                  (uint64_t)(fapi2::current_err) );
        fapi2::current_err = 0;

        return fapi2::current_err;
    }


    // Force the FAPI_ASSERT to fail and verify it will goto exit
    fapi2::ReturnCode  p9_fapi_assertFailure(  )
    {


        uint32_t  l_var1 = 5, l_var2 = 25;
        FAPI_INF("Running ASSERT test that will fail");
        FAPI_ASSERT( l_var1 == l_var2,
                    fapi2::FAPI2_SAMPLE(),
                    "Verify ASSERT that WILL ASSERT" );

        // Shouldn't get here so fail if we do
        FAPI_ERR("Completed BAD TEST with ASSERT -- Should never get here");
        fapi2::current_err = 0xABAD;
        return fapi2::current_err;

    fapi_try_exit:
        // We detected the fail which is expected
        FAPI_INF( "FAILURE as expected though: %d",
                  (uint64_t)(fapi2::current_err) );
        fapi2::current_err = 0;

        return fapi2::current_err;
    }

    // FAPI_TRY with good RC so we should run thru all code.
    // If it doesn't work, we should have non-zero RC which
    // forces testcase failure.
    fapi2::ReturnCode  p9_fapi_trySuccess(  )
    {
        fapi2::current_err = 0xFFFF;

        FAPI_INF("Go for GOOD TEST ");
        FAPI_TRY( p9_forceTestUsingRc(0) );
        FAPI_INF("Completed GOOD TEST with CURRENT_ERROR: %d",
                (uint64_t)(fapi2::current_err) );
        fapi2::current_err = 0;

    fapi_try_exit:
        FAPI_INF("Exiting with %d",   (uint64_t)(fapi2::current_err) );

        return fapi2::current_err;
    }


    // FAPI_ASSERT should succeed and run thru all code.
    // If it doesn't work, we should have non-zero RC which
    // forces testcase failure.
    fapi2::ReturnCode  p9_fapi_assertSuccess(  )
    {
        fapi2::current_err = 0xFFFF;

        uint32_t  l_var1 = 5, l_var2 = 5;
        FAPI_ASSERT( l_var1 == l_var2,
                    fapi2::FAPI2_SAMPLE(),
                    "Verify ASSERT that doesn't assert" );
        FAPI_INF("Completed GOOD TEST with ASSERT");
        fapi2::current_err = 0;


    fapi_try_exit:
        FAPI_INF("SUCCESS Exiting with %d",   (uint64_t)(fapi2::current_err) );

        return fapi2::current_err;
    }

  public:
    //******************************************************************************
    // test_fapi2basicTry
    //******************************************************************************

    void  test_fapi2basicTry()
    {
        int numTests = 0;
        int numFails = 0;
        fapi2::ReturnCode l_rc;
        errlHndl_t l_err = nullptr;

        FAPI_INF("fapi2basicTry starting ... ");

        numTests++;
        FAPI_INVOKE_HWP_RC(l_err,l_rc,p9_fapi_tryFailure);
        if ( true == (bool)l_rc )
        {
            numFails++;
            TS_FAIL(" p9_fapi_tryFailure returned error");
        }
        if( l_err ) { delete l_err; }

        numTests++;
        FAPI_INVOKE_HWP_RC(l_err,l_rc,p9_fapi_assertFailure);
        if ( true == (bool)l_rc )
        {
            numFails++;
            TS_FAIL(" p9_fapi_assertFailure returned error");
        }
        if( l_err ) { delete l_err; }

        numTests++;
        FAPI_INVOKE_HWP_RC(l_err,l_rc,p9_fapi_trySuccess);
        if ( true == (bool)l_rc )
        {
            numFails++;
            TS_FAIL(" p9_fapi_trySuccess returned error");
        }
        if( l_err ) { delete l_err; }

        numTests++;
        FAPI_INVOKE_HWP_RC(l_err,l_rc,p9_fapi_assertSuccess);
        if ( true == (bool)l_rc )
        {
            numFails++;
            TS_FAIL(" p9_fapi_assertSuccess returned error");
        }
        if( l_err ) { delete l_err; }

        FAPI_INF("fapi2basicTry:: Test Complete. %d/%d fails", numFails, numTests);

    } // end main testcase driver

}; // end class

} // end namespace fapi2
OpenPOWER on IntegriCloud