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
|
// IBM_PROLOG_BEGIN_TAG
// This is an automatically generated prolog.
//
// $Source: src/usr/initservice/baseinitsvc/initservice.H $
//
// IBM CONFIDENTIAL
//
// COPYRIGHT International Business Machines Corp. 2011
//
// p1
//
// Object Code Only (OCO) source materials
// Licensed Internal Code Source Materials
// IBM HostBoot Licensed Internal Code
//
// The source code for this program is not published or other-
// wise divested of its trade secrets, irrespective of what has
// been deposited with the U.S. Copyright Office.
//
// Origin: 30
//
// IBM_PROLOG_END
#ifndef __BASEINITSVC_INITSERVICE_H
#define __BASEINITSVC_INITSERVICE_H
/**
* @file initservice.H
*
* Base image Initialization Service
* - Manage high-level host boot IPL flow
* - Perform can-continue processing
* - Perform automatic and manual Istep execution
* - Handle flow errors as appropriate.
*
*/
/******************************************************************************/
// Includes
/******************************************************************************/
#include <stdint.h>
#include <util/singleton.H>
#include <sys/vfs.h> // VFS_MODULE_NAME_MAX
#include <trace/interface.H>
#include <errl/errlentry.H>
#include <initservice/initsvcreasoncodes.H>
#include <initservice/taskargs.H>
#include <initservice/initsvcstructs.H>
#include <vmmconst.h>
namespace INITSERVICE
{
/******************************************************************************/
// Globals/Constants
/******************************************************************************/
/******************************************************************************/
// Typedef/Enumerations
/******************************************************************************/
/******************************************************************************/
// InitService Class
/******************************************************************************/
/**
* @class InitService
*
* Singleton Class
* This class is launched by _start() (see initservicetaskentry.C),
* which is launched by the kernel (init_main.C).
*
* Once started, it handles the rest of HostBoot Initialization.
*
*/
class InitService
{
public:
friend class InitServiceTest;
/**
* @brief Get singleton instance of this class.
*
* @return the (one and only) instance of InitService
*/
static InitService& getTheInstance();
/**
* @brief Provide an entry function into the class, called from _start()
*
* @param[in] i_args pointer to any arguments passed in from
* _start() and by extension the kernel,
* currently this is always NULL .
*
* @return nothing
*
*/
void init( void *i_args);
/**
* @brief Start a task using the taskname string in the TaskInfo struct.
*
* taskname string will be something like "libtargeting.so", which
* is the name of the compiled and linked targetting module.
* The module is expected to have implemented a extern "C"
* function called "void _start(void *args)" which is considered
* to be the "task entry point". When _start is called, its
* parameter will be set to point to a TaskArgs struct which
* can be used to pass information back and forth. See the
* comments in TaskArgs.H for more info.
* See initsvctasks.H and the unit tests for some examples of
* how this is used.
*
*
* @param[in] i_ptask pointer to a TaskInfo struct
* @param[in,out] io_pargs pointer to a TaskArgs struct, or NULL
* On input, TaskArgs struct will have
* command, returncode, and errlog fields
* cleared. task can fill in these values
* on return.
*
* @return pointer to errorlog
* @retval NULL if success, filled in errorlog handle for failure
*
* @note startTask() can also be used to launch an asynchronous task
* by calling it with i_pargs set to NULL. This will disable
* the barrier check.
*
*/
errlHndl_t startTask( const TaskInfo *i_ptask,
TaskArgs::TaskArgs *io_pargs ) const;
/**
* @brief Execute an function
*
* @param[in] i_ptask - pointer to an TaskInfo struct
* @param[in,out] i_pargs - pointer to a TaskArgs struct
* On input, TaskArgs struct will have
* command, returncode, and errlog fields
* cleared. Task can fill in these values
* on return.
*
* @return pointer to errorlog
* @retval NULL if success, filled out errorlog if failure
*/
errlHndl_t executeFn( const TaskInfo *i_ptask,
TaskArgs *i_pargs ) const;
/**
* @brief set progress code for task.
* This is supposed to make a system call to post the error to
* SP and will also write a SCOM reg
*
* @TODO need progress code categories defined.
*
* @param[in] i_progresscode - 64-bit progress code.
*
* @return nothing
*
*/
void setProgressCode( uint64_t i_progresscode ) const;
/**
* @brief dispatch Task depending on what type of task it is,
* etc.
*
* @param[in] i_ptask - pointer to a TaskInfo struct, which should
* contain all the info to run the task.
* @param[in,out] io_pargs - pointer to a TaskArgs struct. It is
* possible that this will not be used at all.
*
* @return pointer to errlog
* @retval returns NULL, or a pointer to a filled out errorlog
*/
errlHndl_t dispatchTask( const TaskInfo *i_ptask,
TaskArgs *io_pargs ) const;
/**
* @brief Registry a block/range of vitual memory to be handled during a
* shutdown.
*
* @param[in] i_vaddr - Base virtual address
* @param[in] i_size - Size of virtual memory from base address
* @param[in] i_priority - Order to handle given block(0-Lowest Priority)
*
* @return Nothing
*/
void registerBlock(void* i_vaddr, uint64_t i_size, BlockPriority i_priority);
/**
* @brief Perform necessary steps, such as FLUSHing, to registered blocks.
*
* @param[in] i_status - Shutdown status to be passed along on shutdown
*
* @return Nothing
*/
void doShutdown(uint64_t i_status);
protected:
/**
* @brief Constructor for the InitService object.
*/
InitService();
/**
* @brief Destructor for the InitService object.
*/
~InitService();
private:
/**
* @note Disable copy constructor and assignment operator
*/
InitService(const InitService& i_right);
InitService& operator=(const InitService& i_right);
/**
* @struct regBlock_t
* @brief Attributes stored for virtual memory ranges that must be handled
* during a shutdown.
*/
struct regBlock_t
{
//Base virtual address
void* vaddr;
//Size of virtual memory from base address
uint64_t size;
//Priority order in which to handle the given block
uint64_t priority;
/**
* @brief Constructor to initialize a registered block object
*/
regBlock_t(void* i_vaddr, uint64_t i_size, uint64_t i_priority) :
vaddr(i_vaddr), size(i_size), priority(i_priority) {}
};
//Store a list of registered blocks
std::vector<regBlock_t*> iv_regBlock;
}; // class InitService
} // namespace INITSERVICE
#endif
|
