init

hc

2024-03-22 a0752693d998599af469473b8dc239ef973a012f

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
/** @file 
  This header file describes a library that contains functions to save and 
  restore unit test internal state, in case the test needs to pause and resume 
  (eg. a reboot-based test). 
 
  Copyright (c) Microsoft Corporation.<BR> 
  Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR> 
  SPDX-License-Identifier: BSD-2-Clause-Patent 
 
**/ 
 
#ifndef _UNIT_TEST_PERSISTENCE_LIB_H_ 
#define _UNIT_TEST_PERSISTENCE_LIB_H_ 
 
#include <UnitTestFrameworkTypes.h> 
 
#define UNIT_TEST_PERSISTENCE_LIB_VERSION   1 
 
/** 
  Determines whether a persistence cache already exists for 
  the given framework. 
 
  @param[in]  FrameworkHandle   A pointer to the framework that is being persisted. 
 
  @retval     TRUE 
  @retval     FALSE   Cache doesn't exist or an error occurred. 
 
**/ 
BOOLEAN 
EFIAPI 
DoesCacheExist ( 
  IN UNIT_TEST_FRAMEWORK_HANDLE  FrameworkHandle 
  ); 
 
/** 
  Will save the data associated with an internal Unit Test Framework 
  state in a manner that can persist a Unit Test Application quit or 
  even a system reboot. 
 
  @param[in]  FrameworkHandle   A pointer to the framework that is being persisted. 
  @param[in]  SaveData          A pointer to the buffer containing the serialized 
                                framework internal state. 
 
  @retval     EFI_SUCCESS   Data is persisted and the test can be safely quit. 
  @retval     Others        Data is not persisted and test cannot be resumed upon exit. 
 
**/ 
EFI_STATUS 
EFIAPI 
SaveUnitTestCache ( 
  IN UNIT_TEST_FRAMEWORK_HANDLE  FrameworkHandle, 
  IN UNIT_TEST_SAVE_HEADER       *SaveData 
  ); 
 
/** 
  Will retrieve any cached state associated with the given framework. 
  Will allocate a buffer to hold the loaded data. 
 
  @param[in]  FrameworkHandle   A pointer to the framework that is being persisted. 
  @param[in]  SaveData          A pointer pointer that will be updated with the address 
                                of the loaded data buffer. 
 
  @retval     EFI_SUCCESS       Data has been loaded successfully and SaveData is updated 
                                with a pointer to the buffer. 
  @retval     Others            An error has occurred and no data has been loaded. SaveData 
                                is set to NULL. 
 
**/ 
EFI_STATUS 
EFIAPI 
LoadUnitTestCache ( 
  IN  UNIT_TEST_FRAMEWORK_HANDLE  FrameworkHandle, 
  OUT UNIT_TEST_SAVE_HEADER       **SaveData 
  ); 
 
#endif