ktest_tc_mm_ctrlbuf.c 25.9 KB
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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
/*****************************************************************************
 *  Copyright Statement:
 *  --------------------
 *  This software is protected by Copyright and the information contained
 *  herein is confidential. The software may not be copied and the information
 *  contained herein may not be used or disclosed except with the written
 *  permission of MediaTek Inc. (C) 2005
 *
 *  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 *  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
 *  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
 *  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
 *  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
 *  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
 *  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
 *  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
 *  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
 *  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
 *
 *  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
 *  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 *  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
 *  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
 *  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 *
 *  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
 *  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
 *  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
 *  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
 *  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
 *
 *****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 *   ktest_tc_mm_ctrlbuf.c
 *
 * Project:
 * --------
 *   Maui_Software
 *
 * Description:
 * ------------
 *   The file implements MediaTek KAL (Kernel Abstraction Layer) auto test task
 *   functions.
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 *
 *
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================*/

/* this file is valid only when __KTEST__ has been defined. */
#ifdef __KTEST__
 
#include "ktest_common.h"
#include "app_buff_alloc.h"
#include "stack_buff_pool.h"
#include "Ctrl_buff_pool.h"

kal_uint32 max_consume_record[RPS_CREATED_CTRL_BUFF_POOLS];
kal_uint32 fake;

/******************************************************************************
 * external KAL APIs that will be used in this module.
 *****************************************************************************/
extern void* kal_sys_mem_alloc( kal_uint32 size );
extern void kal_sys_mem_free( void* mem_ptr );
extern void* kal_debug_mem_alloc( kal_uint32 size );
extern void kal_debug_mem_free( void* mem_ptr );

/******************************************************************************
 * Name:
 *     ktest_mem_poolid_corruption
 * Functionality:
 *     test control buffer pool id corruption fata error.
 * Results:
 *     if a fatal error with code KAL_ERROR_BUFFMNGR_ISVALID_FAILED occurs,
 *     report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32  ktest_mem_poolid_corruption( kal_uint32 argc, void *argv )
{
    void *buff_ptr;
    void *update_ptr = NULL;
    kal_uint32 corrupted_pool_id = 0x55555555;

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_ISVALID_FAILED;

    buff_ptr = get_ctrl_buffer( 8 );

    /* corrupt the pool id. */
    update_ptr = (kal_char *) KAL_GET_POOLID_PTR_IN_BUFF_HEADER( buff_ptr );
    kal_mem_cpy( (void *) update_ptr, (void *) &corrupted_pool_id,
                 sizeof( kal_poolid ) );

    /* should fatal error and report the result in the fatal error handler.*/
    free_ctrl_buffer( buff_ptr );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
}

/******************************************************************************
 * Name:
 *     ktest_mem_leakage
 * Functionality:
 *     test control buffer memory leakage fatal error.
 * Results:
 *     if a fatal error with code KAL_ERROR_BUFFMNGR_GETBUFF_FAILED occurs,
 *     report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_leakage( kal_uint32 argc, void *argv )
{
    void *buff_ptr;

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_GETBUFF_NOT_AVAILABLE;

    /* make a memory leakage issue. */
    do
    {
        buff_ptr = get_ctrl_buffer( 8 );
    } while( buff_ptr != NULL );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
}


/******************************************************************************
 * Name:
 *     ktest_mem_pool_info_corruption
 * Functionality:
 *     test control buffer memory structure ctrl_buff_pool_info_g ASSERT happen.
 * Results:
 *     if a fatal error with code KAL_ERROR_BUFFMNGR_GETBUFF_FAILED with
 *     sub error code KAL_ERROR_KAL_SUB_ERROR_CODE2 occurs, report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32  ktest_mem_pool_info_corruption( kal_uint32 argc, void *argv )
{
    void *buff_ptr;
    kal_int32 pool_indx = 0;

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_GETBUFF_POOL_NOT_EXIST;

    /* corrupte ctrl_buff_pool_info_g. */
    while( pool_indx < RPS_CREATED_CTRL_BUFF_POOLS )
    {
        ctrl_buff_pool_info_g[pool_indx++].pool_id = NULL;
    }

    buff_ptr = get_ctrl_buffer( 8 );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
}

/******************************************************************************
 * Name:
 *     ktest_mem_allocate_size_check
 * Functionality:
 *     test user error input 0 size buffer request, ASSERT will happen.
 * Results:
 *     if an ASSERT with exception buff_size > 0 occurs, report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_allocate_size_check( kal_uint32 argc, void *argv )
{
    void *buff_ptr;

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE =KAL_ERROR_BUFFMNGR_GETBUFF_FAILED;

    /* make a memory leakage issue. */
    buff_ptr = get_ctrl_buffer( 0 );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID,NULL );
}

/******************************************************************************
 * Name:
 *     ktest_mem_allocate_size_check2
 * Functionality:
 *     test user request size beyond pool max size, ASSERT will happen.
 * Results:
 *     if an ASSERT exception pool_indx < RPS_CREATED_CTRL_BUFF_POOLS occurs,
 *     report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_allocate_size_check2( kal_uint32 argc, void *argv )
{
    void *buff_ptr;

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_GETBUFF_POOLINDX_OUT_OF_RANGE;

    /* try to alloate a bigger one. */
    buff_ptr = get_ctrl_buffer( 0xFFFFFFFF );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
}

/******************************************************************************
 * Name:
 *     ktest_mem_allocate_header_corrupt_detect
 * Functionality:
 *     test control buffer header corruption when allocating fatal error.
 * Results:
 *     if a fatal error with code KAL_ERROR_BUFFMNGR_HEADER_FAILED_GET occurs,
 *     report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_allocate_header_corrupt_detect( kal_uint32 argc, void *argv )
{
    void *buff_ptr;
    kal_uint32 *header;

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_HEADER_FAILED_GET;

    /* make a header corruption issue when allocate. */
    buff_ptr = get_ctrl_buffer( 8 );
    free_ctrl_buffer( buff_ptr );

    header = (kal_uint32 *) ( (kal_uint8 *) buff_ptr - KAL_BUFF_HEADER_SIZE );
    *header = 0x55555555;

    do
    {
        buff_ptr = get_ctrl_buffer( 8 );
    } while( buff_ptr != NULL );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
}

/******************************************************************************
 * Name:
 *     ktest_mem_allocate_footer_corrupt_detect
 * Functionality:
 *     test control buffer footer corruption when allocating fatal error.
 * Results:
 *     if a fatal error with code KAL_ERROR_BUFFMNGR_FOOTER_FAILED_GET occurs,
 *     report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_allocate_footer_corrupt_detect( kal_uint32 argc, void *argv )
{
    void *buff_ptr;
    kal_uint8 *footer;
    kal_uint8 i;
    void *tmp_ptr;
    kal_internal_poolid pool_id_ptr;

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_FOOTER_FAILED_GET;

    /* make a footer corruption issue when allocate. */
    buff_ptr = get_ctrl_buffer( 8 );
    free_ctrl_buffer( buff_ptr );

    tmp_ptr = KAL_GET_POOLID_PTR_IN_BUFF_HEADER( buff_ptr );
    kal_mem_cpy( (void *) &pool_id_ptr, (void *) tmp_ptr, sizeof( kal_poolid ) );

    footer = (kal_uint8 *)( (kal_uint8 *) buff_ptr + pool_id_ptr->buff_size );

    for( i = 0; i < 4; i++ )
    {
        *footer = 0x55;
        footer += 1;
    }

    do
    {
        buff_ptr = get_ctrl_buffer( 8 );
    } while( buff_ptr != NULL );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
}

/******************************************************************************
 * Name:
 *     ktest_mem_free_header_corrupt_detect
 * Functionality:
 *     test control buffer header corruption when free fatal error.
 * Results:
 *     if a fatal error with code KAL_ERROR_BUFFMNGR_HEADER_FAILED_GET occurs,
 *     report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_free_header_corrupt_detect( kal_uint32 argc, void *argv )
{
    void *buff_ptr;
    kal_uint8 *header;
    kal_uint8 i;

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_HEADER_FAILED;

    /* make a header corrupt issue when allocate. */
    buff_ptr = get_ctrl_buffer( 8 );
    header = (kal_uint8 *) ( (kal_uint8 *) buff_ptr - KAL_BUFF_HEADER_SIZE );
    for( i=0; i<4; i++ )
    {
        *header = 0x55;
        header += 1;
    }

    free_ctrl_buffer( buff_ptr );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
}

/******************************************************************************
 * Name:
 *     ktest_mem_free_footer_corrupt_detect
 * Functionality:
 *     test control buffer footer corruption when free fatal error.
 * Results:
 *     if a fatal error with code KAL_ERROR_BUFFMNGR_STAMP_FAILED occurs,
 *     report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_free_footer_corrupt_detect( kal_uint32 argc, void *argv )
{
    void *buff_ptr;
    void *tmp_ptr;
    kal_internal_poolid pool_id_ptr;
    kal_uint8 *footer;
    kal_uint8 i;
    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_FOOTER_FAILED;

    /* make a memory leakage issue. */
    buff_ptr = get_ctrl_buffer( 8 );
    tmp_ptr = KAL_GET_POOLID_PTR_IN_BUFF_HEADER( buff_ptr );
    kal_mem_cpy( (void *) &pool_id_ptr, (void *) tmp_ptr, sizeof( kal_poolid ) );
    footer = (kal_uint8 *) ( (kal_uint8 *) buff_ptr + pool_id_ptr->buff_size );
    for( i=0; i<4; i++ )
    {
        *footer = 0x55;
        footer += 1;
    }
    free_ctrl_buffer( buff_ptr );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
}


/******************************************************************************
 * Name:
 *     ktest_mem_free_buff_arg_error
 * Functionality:
 *     test control buffer free input argument is NULL fatal error.
 * Results:
 *     if a fatal error with code KAL_ERROR_BUFFMNGR_RELEASEBUFF_FAILED occurs,
 *     report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_free_buff_arg_error( kal_uint32 argc, void *argv )
{
    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_RELEASEBUFF_NILPTR;

    /* make an error free issue. */
    free_ctrl_buffer( NULL );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
}

/******************************************************************************
 * Name:
 *     ktest_mem_double_free_error
 * Functionality:
 *     test control buffer double free error fatal error.
 * Results:
 *     if a fatal error with code KAL_ERROR_BUFFMNGR_RELEASEBUFF_FAILED occurs,
 *     report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_double_free_error( kal_uint32 argc, void *argv )
{
    void *buff_ptr;

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_RELEASEBUFF_INTERNAL_FAILED;

    /* make a double free issue. */
    buff_ptr = get_ctrl_buffer( 8 );
    free_ctrl_buffer( buff_ptr );
    free_ctrl_buffer( buff_ptr );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
}

/******************************************************************************
 * Name:
 *     ktest_mem_free_usr_footer_error
 * Functionality:
 *     test control buffer usr footer corruption when free fatal error.
 * Results:
 *     if a fatal error with code KAL_ERROR_BUFFMNGR_FOOTER_FAILED_GET occurs,
 *     report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_free_usr_footer_error( kal_uint32 argc, void *argv )
{
    void *i = NULL;
    kal_uint8 count = 0;
    void *temp = NULL;

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_EXT_FOOTER_FAILED;

#if defined( DEBUG_KAL ) && defined( DEBUG_BUF2 )
    /* make a memory leakage issue. */
    i = get_ctrl_buffer( 2 );
    temp = (char *) i + 2;
    for( count = 0; count <4; count++ )
    {
        *(char *) temp = 0x55;
        temp = (char *) temp + 1;
    }

    free_ctrl_buffer( i );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
#else
    /* if DEBUG_BUF2 is not defined, then pass this test case. */
    ktest_report( KTEST_PASS, KTEST_TCID,
                  "DEBUG_KAL or DEBUG_BUF2 not defined, by pass." );
#endif
}

/******************************************************************************
 * Name:
 *     ktest_mem_free_buff_arg_error2
 * Functionality:
 *     test control buffer input argument error(not NULL) when free.
 * Results:
 *     if a fatal error with code KAL_ERROR_BUFFMNGR_ISVALID_FAILED occurs,
 *     report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_free_buff_arg_error2( kal_uint32 argc, void *argv )
{
    void *i = &fake;

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_ISVALID_FAILED;

    /* make a memory leakage issue. */
    free_ctrl_buffer( i );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
}

/******************************************************************************
 * Name:
 *     ktest_mem_free_buff_arg_error3
 * Functionality:
 *     test control buffer address range check.
 * Results:
 *     if a fatal error with code KAL_ERROR_BUFFMNGR_ISVALID_FAILED occurs,
 *     report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_free_buff_arg_error3( kal_uint32 argc, void *argv )
{
    void *i;
    kal_uint32 virtual[2];

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_ISVALID_FAILED;

    /* make a memory leakage issue. */
    i = get_ctrl_buffer( 8 );
    virtual[0] = 0xF1F1F1F1;
    free_ctrl_buffer( &(virtual[1]) );

    /* report FAIL if no fatal error occurs. */
    ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
}

/******************************************************************************
 * the test case below assumes at lease 5 buffer.
 *****************************************************************************/
#define KTEST_CTRL_BUFF_QUERY_NUM 5

/******************************************************************************
 * Name:
 *     ktest_mem_ctrl_buff_query
 * Functionality:
 *     test basic functionality of kal_query_ctrlbuf_max_consumption.
 * Results:
 *     if the query is the same as we expected, report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_ctrl_buff_query( kal_uint32 argc, void *argv )
{
    kal_uint32 record[RPS_CREATED_CTRL_BUFF_POOLS];
    kal_uint8 i;
    kal_uint8 j;
    void * mark[RPS_CREATED_CTRL_BUFF_POOLS][KTEST_CTRL_BUFF_QUERY_NUM];

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_ISVALID_FAILED;

    /* make a memory leakage issue. */
    if( !kal_query_ctrlbuf_max_consumption( record ) )
    {
        ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
    }

    for( i=0; i < RPS_CREATED_CTRL_BUFF_POOLS; i++ )
    {
        if( ctrl_buff_pool_info_g[i].pool_id != 0 )
        {
            for( j = 0; j < KTEST_CTRL_BUFF_QUERY_NUM; j++ )
                mark[i][j] = get_ctrl_buffer( ctrl_buff_pool_info_g[i].size );
        }
    }

    if( !kal_query_ctrlbuf_max_consumption( max_consume_record ) )
    {
        ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
    }

    for( i = 0;
         i < RPS_CREATED_CTRL_BUFF_POOLS && ctrl_buff_pool_info_g[i].pool_id != 0;
         i++ )
    {
        if( max_consume_record[i] - record[i] != KTEST_CTRL_BUFF_QUERY_NUM )
        {
            ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
        }
    }

    for( i = 0; i < RPS_CREATED_CTRL_BUFF_POOLS; i++ )
    {
        if( ctrl_buff_pool_info_g[i].pool_id != 0 )
        {
            for( j = 0; j < KTEST_CTRL_BUFF_QUERY_NUM; j++ )
            {
                free_ctrl_buffer( mark[i][j] );
            }
        }
    }

    if( !kal_query_ctrlbuf_max_consumption( max_consume_record ) )
    {
        ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
    }

    for( i = 0;
         i < RPS_CREATED_CTRL_BUFF_POOLS && ctrl_buff_pool_info_g[i].pool_id != 0;
         i++ )
    {
        if( max_consume_record[i] - record[i] != KTEST_CTRL_BUFF_QUERY_NUM )
        {
            ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
        }
    }

    ktest_report( KTEST_PASS, KTEST_TCID, NULL );
}

/******************************************************************************
 * Name:
 *     ktest_mem_system_mem_query
 * Functionality:
 *     test basic functionality of kal_sys_mem_query_freesize.
 * Results:
 *     if no error occurs, report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_system_mem_query( kal_uint32 argc, void *argv )
{
    void* record;
    kal_uint32 i = 4;
    kal_uint32 mark;
    kal_uint32 j;

    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_ISVALID_FAILED;

    /* make a memory leakage issue. */
    j = kal_sys_mem_query_freesize();
    mark = j;

    while( 1 )
    {
        if( mark > i )
        {
            record = kal_sys_mem_alloc( i );
            mark = kal_sys_mem_query_freesize();

            if( mark != (j - i) )
            {
                ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
            }
            else
            {
                j = mark;
                i = i<<1;
            }
        }
        else
        {
            break;
        }
    }

    ktest_report( KTEST_PASS, KTEST_TCID, NULL );
}

/******************************************************************************
 * Name:
 *     ktest_mem_debug_mem_query
 * Functionality:
 *     test basic functionality of kal_debug_mem_query_freesize.
 * Results:
 *     if no error occurs, report PASS.
 *     else, report FAIL.
 *****************************************************************************/
kal_int32 ktest_mem_debug_mem_query( kal_uint32 argc, void *argv )
{
    void* record;
    kal_uint32 i = 4;
    kal_uint32 mark;
    kal_uint32 j;
    KTEST_TCID = KTEST_FUNCTION_NAME;
    KTEST_EXPECT_ERR_CODE = KAL_ERROR_BUFFMNGR_ISVALID_FAILED;

    /* make a memory leakage issue. */
    j = kal_debug_mem_query_freesize();
    mark = j;

    while( 1 )
    {
        if( mark > i )
        {
            record = kal_debug_mem_alloc( i );
            mark = kal_debug_mem_query_freesize();
            if( mark != (j - i) )
            {
                ktest_report( KTEST_FAIL, KTEST_TCID, NULL );
            }
            else
            {
                j = mark;
                i = i<<1;
            }
        }
        else
        {
            break;
        }
    }

    ktest_report( KTEST_PASS, KTEST_TCID, NULL );
}

/******************************************************************************
 * test case table of ctrl_buff module in post-schedule stage.
 * note that the test case wrapped with FIX_OSCAR_FAIL will only be tested on
 *           target, but will be ignored on OSCAR.
 *****************************************************************************/
const ktest_tc_struct ktest_tc_mm_ctrlbuf_tbl[] =
{
    {ktest_mem_poolid_corruption, 0, NULL},
    {ktest_mem_leakage, 0, NULL},
    {ktest_mem_pool_info_corruption, 0, NULL},
    {ktest_mem_allocate_size_check, 0, NULL},
    {ktest_mem_allocate_size_check2, 0, NULL},
    {ktest_mem_allocate_header_corrupt_detect, 0, NULL},
    {ktest_mem_allocate_footer_corrupt_detect, 0, NULL},
    {ktest_mem_free_header_corrupt_detect, 0, NULL},
    {ktest_mem_free_footer_corrupt_detect, 0, NULL},
    {ktest_mem_free_usr_footer_error, 0, NULL},
    {ktest_mem_double_free_error, 0, NULL},
    {ktest_mem_free_buff_arg_error, 0, NULL},
    {ktest_mem_free_buff_arg_error2, 0, NULL},
    {ktest_mem_free_buff_arg_error3, 0, NULL},
    {ktest_mem_ctrl_buff_query, 0, NULL},
    {ktest_mem_system_mem_query, 0, NULL},
    {ktest_mem_debug_mem_query, 0, NULL}
};

/******************************************************************************
 * test case table of ctrl_buff module in pre-schedule stage.
 * note that the test case wrapped with FIX_OSCAR_FAIL will only be tested on
 *           target, but will be ignored on OSCAR.
 *****************************************************************************/
const ktest_tc_struct ktest_pre_tc_mm_ctrlbuf_tbl[] =
{
    {ktest_fake_test, 0, NULL},
};

/******************************************************************************
 * Name:
 *     ktest_tc_mm_ctrlbuf_num
 * Functionality:
 *     caculate there are how many test cases of ctrl_buff module in
 *     post-schedule stage.
 * Parameters:
 *     void.
 * Returns:
 *     the total number of all test cases of ctrl_buff module in post-schedule
 *     stage.
 *****************************************************************************/
kal_uint32 ktest_tc_mm_ctrlbuf_num( void )
{
    return sizeof( ktest_tc_mm_ctrlbuf_tbl ) / sizeof( ktest_tc_struct );
}

/******************************************************************************
 * Name:
 *     ktest_pre_tc_mm_ctrlbuf_num
 * Functionality:
 *     caculate there are how many test cases of ctrl_buff module in
 *     pre-schedule stage.
 * Parameters:
 *     void.
 * Returns:
 *     the total number of all test cases of ctrl_buff module in pre-schedule
 *     stage.
 *****************************************************************************/
kal_uint32 ktest_pre_tc_mm_ctrlbuf_num( void )
{
    return sizeof( ktest_pre_tc_mm_ctrlbuf_tbl ) / sizeof( ktest_tc_struct );
}

/******************************************************************************
 * Name:
 *     ktest_mm_ctrlbuf_init
 * Functionality:
 *     the initialize function of ctrl_buff module.
 * Parameters:
 *     mod: id of ctrl_buff module.
 * Returns:
 *     void.
 * Note:
 *     this is the initialization function of ctrl_buff module, and we should
 *     call it in ktest_testcase_register, so as to register the ctrl_buff
 *     module into KTEST.
 *****************************************************************************/
void ktest_mm_ctrlbuf_init( kal_uint32 mod )
{
    tc_all_tbls[mod] = ktest_tc_mm_ctrlbuf_tbl;
    pre_tc_all_tbls[mod] = ktest_pre_tc_mm_ctrlbuf_tbl;

    tc_modules_num[mod] = ktest_tc_mm_ctrlbuf_num();
    pre_tc_modules_num[mod] = ktest_pre_tc_mm_ctrlbuf_num();
}

#endif /*__KTEST__*/