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
|
/** @file
PCDAutoGenAction class.
This class is to manage how to generate the PCD information into Autogen.c and
Autogen.h.
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
package org.tianocore.build.pcd.action;
import java.io.File;
import java.util.List;
import java.util.UUID;
import org.tianocore.build.global.GlobalData;
import org.tianocore.build.pcd.entity.MemoryDatabaseManager;
import org.tianocore.build.pcd.entity.Token;
import org.tianocore.build.pcd.entity.UsageInstance;
import org.tianocore.build.pcd.exception.BuildActionException;
import org.tianocore.build.pcd.exception.EntityException;
/** This class is to manage how to generate the PCD information into Autogen.c and
Autogen.h.
**/
public class PCDAutoGenAction extends BuildAction {
///
/// The reference of DBManager in GlobalData class.
///
private MemoryDatabaseManager dbManager;
///
/// The name of module which is analysised currently.
///
private String moduleName;
///
/// The Guid of module which is analyzed currently.
///
private UUID moduleGuid;
///
/// The name of package whose module is analysized currently.
///
private String packageName;
///
/// The Guid of package whose module is analyszed curretnly.
///
private UUID packageGuid;
///
/// The arch of current module
///
private String arch;
///
/// The version of current module
///
private String version;
///
/// Wheter current module is PCD emulated driver. It is only for
/// emulated PCD driver and will be kept until PCD IMAGE tool ready.
///
private boolean isEmulatedPCDDriver;
///
/// Whether current autogen is for building library used by current module.
///
private boolean isBuildUsedLibrary;
///
/// The generated string for header file.
///
private String hAutoGenString;
///
/// The generated string for C code file.
///
private String cAutoGenString;
/**
Set parameter ModuleName
@param moduleName the module name parameter.
**/
public void setModuleName(String moduleName) {
this.moduleName = moduleName;
}
public void setModuleGuid(UUID moduleGuid) {
this.moduleGuid = moduleGuid;
}
public void setPackageName(String packageName) {
this.packageName = packageName;
}
public void setPackageGuid(UUID packageGuid) {
this.packageGuid = packageGuid;
}
public void setArch(String arch) {
this.arch = arch;
}
public void setVersion(String version) {
this.version = version;
}
/**
Set parameter isEmulatedPCDDriver
@param isEmulatedPCDDriver whether this module is PeiEmulatedPCD driver
**/
public void setIsEmulatedPCDDriver(boolean isEmulatedPCDDriver) {
this.isEmulatedPCDDriver = isEmulatedPCDDriver;
}
public void setIsBuildUsedLibrary(boolean isBuildUsedLibrary) {
this.isBuildUsedLibrary = isBuildUsedLibrary;
}
/**
Get the output of generated string for header file.
@return the string of header file for PCD
**/
public String OutputH() {
return hAutoGenString;
}
/**
Get the output of generated string for C Code file.
@return the string of C code file for PCD
**/
public String OutputC() {
return cAutoGenString;
}
/**
Construct function
This function mainly initialize some member variable.
@param moduleName Parameter of this action class.
@param isEmulatedPCDDriver Parameter of this action class.
**/
public PCDAutoGenAction(String moduleName,
UUID moduleGuid,
String packageName,
UUID packageGuid,
String arch,
String version,
boolean isEmulatedPCDDriver,
boolean isBuildUsedLibrary) {
dbManager = null;
hAutoGenString = "";
cAutoGenString = "";
setIsEmulatedPCDDriver(isEmulatedPCDDriver);
setModuleName(moduleName);
setModuleGuid(moduleGuid);
setPackageName(packageName);
setPackageGuid(packageGuid);
setArch(arch);
setVersion(version);
setIsBuildUsedLibrary(isBuildUsedLibrary);
}
/**
check the parameter for action class.
@throws BuildActionException Bad parameter.
**/
void checkParameter() throws BuildActionException {
if(!isEmulatedPCDDriver &&(moduleName == null)) {
throw new BuildActionException("Wrong module name parameter for PCDAutoGenAction tool!");
}
if(!isEmulatedPCDDriver && moduleName.length() == 0) {
throw new BuildActionException("Wrong module name parameter for PCDAutoGenAction tool!");
}
}
/**
Core execution function for this action class.
All PCD information of this module comes from memory dabase. The collection
work should be done before this action execution.
Currently, we should generated all PCD information(maybe all dynamic) as array
in Pei emulated driver for simulating PCD runtime database.
@throws BuildActionException Failed to execute this aciton class.
**/
void performAction() throws BuildActionException {
ActionMessage.debug(this,
"Starting PCDAutoGenAction to generate autogen.h and autogen.c!...");
//
// Check the PCD memory database manager is valid.
//
if(GlobalData.getPCDMemoryDBManager() == null) {
throw new BuildActionException("Memory database has not been initlizated!");
}
dbManager = GlobalData.getPCDMemoryDBManager();
if(dbManager.getDBSize() == 0) {
return;
}
ActionMessage.debug(this,
"PCD memory database contains " + dbManager.getDBSize() + " PCD tokens");
generateAutogenForModule();
}
/**
Generate the autogen string for a common module.
All PCD information of this module comes from memory dabase. The collection
work should be done before this action execution.
**/
private void generateAutogenForModule()
{
int index;
List<UsageInstance> usageInstanceArray;
if (!isBuildUsedLibrary) {
usageInstanceArray = dbManager.getUsageInstanceArrayByModuleName(moduleName,
moduleGuid,
packageName,
packageGuid,
arch,
version);
dbManager.UsageInstanceContext = usageInstanceArray;
dbManager.CurrentModuleName = moduleName;
} else {
usageInstanceArray = dbManager.UsageInstanceContext;
//
// For building MDE package, although all module are library, but PCD entries of
// these library should be used to autogen.
//
if (usageInstanceArray == null) {
usageInstanceArray = dbManager.getUsageInstanceArrayByModuleName(moduleName,
moduleGuid,
packageName,
packageGuid,
arch,
version);
}
}
if(usageInstanceArray.size() != 0) {
//
// Add "#include 'PcdLib.h'" for Header file
//
hAutoGenString = "#include <MdePkg/Include/Library/PcdLib.h>\r\n";
}
for(index = 0; index < usageInstanceArray.size(); index ++) {
ActionMessage.debug(this,
"Module " + moduleName + "'s PCD [" + Integer.toHexString(index) +
"]: " + usageInstanceArray.get(index).parentToken.cName);
try {
usageInstanceArray.get(index).generateAutoGen(isBuildUsedLibrary);
hAutoGenString += usageInstanceArray.get(index).getHAutogenStr() + "\r\n";
cAutoGenString += usageInstanceArray.get(index).getCAutogenStr() + "\r\n";
} catch(EntityException exp) {
throw new BuildActionException(exp.getMessage());
}
}
//
// Work around code, In furture following code should be modified that get
// these information from Uplevel Autogen tools.
//
if (moduleName.equalsIgnoreCase("PcdPeim")) {
hAutoGenString += dbManager.PcdPeimHString;
cAutoGenString += dbManager.PcdPeimCString;
} else if (moduleName.equalsIgnoreCase("PcdDxe")) {
hAutoGenString += dbManager.PcdDxeHString;
cAutoGenString += dbManager.PcdDxeCString;
}
ActionMessage.debug(this,
"Module " + moduleName + "'s PCD header file:\r\n" + hAutoGenString + "\r\n"
);
ActionMessage.debug(this,
"Module " + moduleName + "'s PCD C file:\r\n" + cAutoGenString + "\r\n"
);
}
/**
Generate unreference token definition string for PCD emulated string.
Maybe some PCD token definition in FPD but not used by any module or library, we
should also generate token definition in autoge.h/autogen.c, because maybe some
driver loaded in shell will use this PCD.
@param token The token who want be generated autogen string.
**/
private void generateUnReferencePcdAutogenString(Token token) {
hAutoGenString += String.format("#define _PCD_TOKEN_%s 0x%016x\r\n",
token.cName, token.tokenNumber);
switch (token.pcdType) {
case FEATURE_FLAG:
hAutoGenString += String.format(
"#define _PCD_VALUE_%s %s\r\n",
token.cName,
token.datum.toString()
);
hAutoGenString += String.format(
"extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n",
token.cName
);
cAutoGenString += String.format(
"GLOBAL_REMOVE_IF_UNREFERENCED const BOOLEAN _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",
token.cName,
token.cName
);
hAutoGenString += String.format(
"#define _PCD_MODE_%s_%s _PCD_VALUE_%s\r\n",
Token.GetAutogenDefinedatumTypeString(token.datumType),
token.cName,
token.cName
);
break;
case FIXED_AT_BUILD:
hAutoGenString += String.format(
"#define _PCD_VALUE_%s %s\r\n",
token.cName,
token.datum.toString()
);
hAutoGenString += String.format(
"extern const %s _gPcd_FixedAtBuild_%s;\r\n",
Token.getAutogendatumTypeString(token.datumType),
token.cName
);
cAutoGenString += String.format(
"GLOBAL_REMOVE_IF_UNREFERENCED const %s _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",
Token.getAutogendatumTypeString(token.datumType),
token.cName,
token.cName
);
hAutoGenString += String.format(
"#define _PCD_MODE_%s_%s _PCD_VALUE_%s\r\n",
Token.GetAutogenDefinedatumTypeString(token.datumType),
token.cName,
token.cName
);
break;
case PATCHABLE_IN_MODULE:
hAutoGenString += String.format(
"#define _PCD_VALUE_%s %s\r\n",
token.cName,
token.datum.toString()
);
hAutoGenString += String.format(
"extern %s _gPcd_BinaryPatch_%s;\r\n",
Token.getAutogendatumTypeString(token.datumType),
token.cName
);
cAutoGenString += String.format(
"GLOBAL_REMOVE_IF_UNREFERENCED %s _gPcd_BinaryPatch_%s = _PCD_VALUE_%s;\r\n",
Token.getAutogendatumTypeString(token.datumType),
token.cName,
token.cName
);
hAutoGenString += String.format(
"#define _PCD_MODE_%s_%s _gPcd_BinaryPatch_%s\r\n",
Token.GetAutogenDefinedatumTypeString(token.datumType),
token.cName,
token.cName
);
break;
case DYNAMIC:
hAutoGenString += String.format(
"#define _PCD_MODE_%s_%s LibPcdGet%s(_PCD_TOKEN_%s)\r\n",
Token.GetAutogenDefinedatumTypeString(token.datumType),
token.cName,
Token.getAutogenLibrarydatumTypeString(token.datumType),
token.cName
);
break;
case DYNAMIC_EX:
break;
default:
ActionMessage.warning(this,
"The PCD_TYPE setted by platform is unknown"
);
}
hAutoGenString += "\r\n";
cAutoGenString += "\r\n";
}
/**
Test case function
@param argv paramter from command line
**/
public static void main(String argv[]) {
String WorkSpace = "M:/ForPcd/edk2";
String logFilePath = WorkSpace + "/MdePkg/MdePkg.fpd";
//
// At first, CollectPCDAction should be invoked to collect
// all PCD information from SPD, MSA, FPD.
//
CollectPCDAction collectionAction = new CollectPCDAction();
GlobalData.initInfo("Tools" + File.separator + "Conf" + File.separator + "FrameworkDatabase.db",
WorkSpace);
try {
collectionAction.perform(WorkSpace,
logFilePath,
ActionMessage.MAX_MESSAGE_LEVEL);
} catch(Exception e) {
e.printStackTrace();
}
//
// Then execute the PCDAuotoGenAction to get generated Autogen.h and Autogen.c
//
PCDAutoGenAction autogenAction = new PCDAutoGenAction("BaseLib",
null,
null,
null,
null,
null,
false,
false
);
autogenAction.execute();
System.out.println(autogenAction.OutputH());
System.out.println("WQWQWQWQWQ");
System.out.println(autogenAction.OutputC());
System.out.println (autogenAction.hAutoGenString);
System.out.println (autogenAction.cAutoGenString);
}
}
|