]> git.proxmox.com Git - mirror_edk2.git/blob - Tools/Source/GenBuild/org/tianocore/build/pcd/action/CollectPCDAction.java
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
1) remove some dead code from WinNtBusDriver.c
[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / pcd / action / CollectPCDAction.java
1 /** @file
2 CollectPCDAction class.
3
4 This action class is to collect PCD information from MSA, SPD, FPD xml file.
5 This class will be used for wizard and build tools, So it can *not* inherit
6 from buildAction or wizardAction.
7
8 Copyright (c) 2006, Intel Corporation
9 All rights reserved. This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
13
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16
17 **/
18 package org.tianocore.build.pcd.action;
19
20 import java.io.BufferedReader;
21 import java.io.File;
22 import java.io.FileReader;
23 import java.io.IOException;
24 import java.math.BigInteger;
25 import java.util.ArrayList;
26 import java.util.Comparator;
27 import java.util.HashMap;
28 import java.util.List;
29 import java.util.UUID;
30
31 import org.apache.xmlbeans.XmlException;
32 import org.apache.xmlbeans.XmlObject;
33 import org.tianocore.DynamicPcdBuildDefinitionsDocument.DynamicPcdBuildDefinitions;
34 import org.tianocore.FrameworkModulesDocument;
35 import org.tianocore.FrameworkPlatformDescriptionDocument;
36 import org.tianocore.ModuleSADocument;
37 import org.tianocore.PcdBuildDefinitionDocument.PcdBuildDefinition;
38 import org.tianocore.build.global.GlobalData;
39 import org.tianocore.build.global.SurfaceAreaQuery;
40 import org.tianocore.build.pcd.action.ActionMessage;
41 import org.tianocore.build.pcd.entity.DynamicTokenValue;
42 import org.tianocore.build.pcd.entity.MemoryDatabaseManager;
43 import org.tianocore.build.pcd.entity.SkuInstance;
44 import org.tianocore.build.pcd.entity.Token;
45 import org.tianocore.build.pcd.entity.UsageInstance;
46 import org.tianocore.build.pcd.exception.EntityException;
47 import org.tianocore.ModuleTypeDef;
48
49 class CStructTypeDeclaration {
50 String key;
51 int alignmentSize;
52 String cCode;
53 boolean initTable;
54
55 public CStructTypeDeclaration (String key, int alignmentSize, String cCode, boolean initTable) {
56 this.key = key;
57 this.alignmentSize = alignmentSize;
58 this.cCode = cCode;
59 this.initTable = initTable;
60 }
61 }
62
63 class StringTable {
64 private ArrayList<String> al;
65 private ArrayList<String> alComments;
66 private String phase;
67 int len;
68
69 public StringTable (String phase) {
70 this.phase = phase;
71 al = new ArrayList<String>();
72 alComments = new ArrayList<String>();
73 len = 0;
74 }
75
76 public String getSizeMacro () {
77 return String.format(PcdDatabase.StringTableSizeMacro, phase, getSize());
78 }
79
80 private int getSize () {
81 //
82 // We have at least one Unicode Character in the table.
83 //
84 return len == 0 ? 1 : len;
85 }
86
87 public int getTableLen () {
88 return al.size() == 0 ? 1 : al.size();
89 }
90
91 public String getExistanceMacro () {
92 return String.format(PcdDatabase.StringTableExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE");
93 }
94
95 public void genCodeNew (ArrayList<CStructTypeDeclaration> declaList, HashMap<String, String> instTable) {
96 final String stringTable = "StringTable";
97 final String tab = "\t";
98 final String newLine = "\r\n";
99 final String commaNewLine = ",\r\n";
100
101 CStructTypeDeclaration decl;
102
103 String cDeclCode = "";
104 String cInstCode = "";
105
106 //
107 // If we have a empty StringTable
108 //
109 if (al.size() == 0) {
110 cDeclCode += tab + String.format("UINT16 %s[1]; /* StringTable is Empty */", stringTable) + newLine;
111 decl = new CStructTypeDeclaration (
112 stringTable,
113 2,
114 cDeclCode,
115 true
116 );
117 declaList.add(decl);
118
119 cInstCode = tab + " { 0 } " + String.format("/* %s */", stringTable) + commaNewLine;
120 instTable.put(stringTable, cInstCode);
121 } else {
122
123 //
124 // If there is any String in the StringTable
125 //
126 for (int i = 0; i < al.size(); i++) {
127 String str = al.get(i);
128 String stringTableName;
129
130 if (i == 0) {
131 //
132 // StringTable is a well-known name in the PCD DXE driver
133 //
134 stringTableName = stringTable;
135
136 } else {
137 stringTableName = String.format("%s_%d", stringTable, i);
138 cDeclCode += tab;
139 }
140 cDeclCode += String.format("UINT16 %s[%d]; /* %s */", stringTableName, str.length() + 1, alComments.get(i)) + newLine;
141
142 if (i == 0) {
143 cInstCode = "/* StringTable */" + newLine;
144 }
145 cInstCode += tab + String.format("L\"%s\" /* %s */", al.get(i), alComments.get(i));
146 if (i != al.size() - 1) {
147 cInstCode += commaNewLine;
148 }
149 }
150
151 decl = new CStructTypeDeclaration (
152 stringTable,
153 2,
154 cDeclCode,
155 true
156 );
157 declaList.add(decl);
158
159 instTable.put(stringTable, cInstCode);
160 }
161 }
162
163 public String getTypeDeclaration () {
164
165 String output;
166
167 final String stringTable = "StringTable";
168 final String tab = "\t";
169 final String newLine = ";\r\n";
170
171 output = "/* StringTable */\r\n";
172
173 if (al.size() == 0) {
174 output += tab + String.format("UINT16 %s[1] /* StringTable is Empty */", stringTable) + newLine;
175 }
176
177 for (int i = 0; i < al.size(); i++) {
178 String str = al.get(i);
179
180 if (i == 0) {
181 //
182 // StringTable is a well-known name in the PCD DXE driver
183 //
184 output += tab + String.format("UINT16 %s[%d] /* %s */", stringTable, str.length() + 1, alComments.get(i)) + newLine;
185 } else {
186 output += tab + String.format("UINT16 %s_%d[%d] /* %s */", stringTable, i, str.length() + 1, alComments.get(i)) + newLine;
187 }
188 }
189
190 return output;
191
192 }
193
194 public ArrayList<String> getInstantiation () {
195 ArrayList<String> output = new ArrayList<String>();
196
197 output.add("/* StringTable */");
198
199 if (al.size() == 0) {
200 output.add("{ 0 }");
201 } else {
202 String str;
203
204 for (int i = 0; i < al.size(); i++) {
205 str = String.format("L\"%s\" /* %s */", al.get(i), alComments.get(i));
206 if (i != al.size() - 1) {
207 str += ",";
208 }
209 output.add(str);
210 }
211 }
212
213 return output;
214 }
215
216 public int add (String inputStr, Token token) {
217 int i;
218 int pos;
219
220 String str = inputStr;
221
222 //
223 // The input can be two types:
224 // "L\"Bootmode\"" or "Bootmode".
225 // We drop the L\" and \" for the first type.
226 if (str.startsWith("L\"") && str.endsWith("\"")) {
227 str = str.substring(2, str.length() - 1);
228 }
229 //
230 // Check if StringTable has this String already.
231 // If so, return the current pos.
232 //
233 for (i = 0, pos = 0; i < al.size(); i++) {
234 String s = al.get(i);;
235
236 if (str.equals(s)) {
237 return pos;
238 }
239 pos = s.length() + 1;
240
241 }
242
243 i = len;
244 //
245 // Include the NULL character at the end of String
246 //
247 len += str.length() + 1;
248 al.add(str);
249 alComments.add(token.getPrimaryKeyString());
250
251 return i;
252 }
253 }
254
255 class SizeTable {
256 private ArrayList<Integer> al;
257 private ArrayList<String> alComments;
258 private String phase;
259 private int len;
260
261 public SizeTable (String phase) {
262 this.phase = phase;
263 al = new ArrayList<Integer>();
264 alComments = new ArrayList<String>();
265 len = 0;
266 }
267
268 public void genCodeNew (ArrayList<CStructTypeDeclaration> declaList, HashMap<String, String> instTable, String phase) {
269 final String name = "SizeTable";
270
271 CStructTypeDeclaration decl;
272 String cCode;
273
274 cCode = String.format(PcdDatabase.SizeTableDeclaration, phase);
275 decl = new CStructTypeDeclaration (
276 name,
277 2,
278 cCode,
279 true
280 );
281 declaList.add(decl);
282
283
284 cCode = PcdDatabase.genInstantiationStr(getInstantiation());
285 instTable.put(name, cCode);
286 }
287
288 public String getTypeDeclaration () {
289 return String.format(PcdDatabase.SizeTableDeclaration, phase);
290 }
291
292 public ArrayList<String> getInstantiation () {
293 ArrayList<String> Output = new ArrayList<String>();
294
295 Output.add("/* SizeTable */");
296 Output.add("{");
297 if (al.size() == 0) {
298 Output.add("0");
299 } else {
300 for (int index = 0; index < al.size(); index++) {
301 Integer n = al.get(index);
302 String str = "\t" + n.toString();
303
304 if (index != (al.size() - 1)) {
305 str += ",";
306 }
307
308 str += " /* " + alComments.get(index) + " */";
309 Output.add(str);
310
311 }
312 }
313 Output.add("}");
314
315 return Output;
316 }
317
318 public int add (Token token) {
319 int index = len;
320
321 len++;
322 al.add(token.datumSize);
323 alComments.add(token.getPrimaryKeyString());
324
325 return index;
326 }
327
328 public int getTableLen () {
329 return al.size() == 0 ? 1 : al.size();
330 }
331
332 }
333
334 class GuidTable {
335 private ArrayList<UUID> al;
336 private ArrayList<String> alComments;
337 private String phase;
338 private int len;
339 private int bodyLineNum;
340
341 public GuidTable (String phase) {
342 this.phase = phase;
343 al = new ArrayList<UUID>();
344 alComments = new ArrayList<String>();
345 len = 0;
346 bodyLineNum = 0;
347 }
348
349 public String getSizeMacro () {
350 return String.format(PcdDatabase.GuidTableSizeMacro, phase, getSize());
351 }
352
353 private int getSize () {
354 return (al.size() == 0)? 1 : al.size();
355 }
356
357 public String getExistanceMacro () {
358 return String.format(PcdDatabase.GuidTableExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE");
359 }
360
361 public void genCodeNew (ArrayList<CStructTypeDeclaration> declaList, HashMap<String, String> instTable, String phase) {
362 final String name = "GuidTable";
363
364 CStructTypeDeclaration decl;
365 String cCode = "";
366
367 cCode += String.format(PcdDatabase.GuidTableDeclaration, phase);
368 decl = new CStructTypeDeclaration (
369 name,
370 8,
371 cCode,
372 true
373 );
374 declaList.add(decl);
375
376
377 cCode = PcdDatabase.genInstantiationStr(getInstantiation());
378 instTable.put(name, cCode);
379 }
380
381 public String getTypeDeclaration () {
382 return String.format(PcdDatabase.GuidTableDeclaration, phase);
383 }
384
385 private String getUuidCString (UUID uuid) {
386 String[] guidStrArray;
387
388 guidStrArray =(uuid.toString()).split("-");
389
390 return String.format("{ 0x%s, 0x%s, 0x%s, { 0x%s, 0x%s, 0x%s, 0x%s, 0x%s, 0x%s, 0x%s, 0x%s } }",
391 guidStrArray[0],
392 guidStrArray[1],
393 guidStrArray[2],
394 (guidStrArray[3].substring(0, 2)),
395 (guidStrArray[3].substring(2, 4)),
396 (guidStrArray[4].substring(0, 2)),
397 (guidStrArray[4].substring(2, 4)),
398 (guidStrArray[4].substring(4, 6)),
399 (guidStrArray[4].substring(6, 8)),
400 (guidStrArray[4].substring(8, 10)),
401 (guidStrArray[4].substring(10, 12))
402 );
403 }
404
405 public ArrayList<String> getInstantiation () {
406 ArrayList<String> Output = new ArrayList<String>();
407
408 Output.add("/* GuidTable */");
409 Output.add("{");
410 if (al.size() == 0) {
411 Output.add(getUuidCString(new UUID(0, 0)));
412 }
413
414 for (int i = 0; i < al.size(); i++) {
415 String str = "\t" + getUuidCString(al.get(i));
416
417 str += "/* " + alComments.get(i) + " */";
418 if (i != (al.size() - 1)) {
419 str += ",";
420 }
421 Output.add(str);
422 bodyLineNum++;
423
424 }
425 Output.add("}");
426
427 return Output;
428 }
429
430 public int add (UUID uuid, String name) {
431 //
432 // Check if GuidTable has this entry already.
433 // If so, return the GuidTable index.
434 //
435 for (int i = 0; i < al.size(); i++) {
436 if (al.get(i).equals(uuid)) {
437 return i;
438 }
439 }
440
441 len++;
442 al.add(uuid);
443 alComments.add(name);
444
445 //
446 // Return the previous Table Index
447 //
448 return len - 1;
449 }
450
451 public int getTableLen () {
452 return al.size() == 0 ? 0 : al.size();
453 }
454
455 }
456
457 class SkuIdTable {
458 private ArrayList<Integer[]> al;
459 private ArrayList<String> alComment;
460 private String phase;
461 private int len;
462
463 public SkuIdTable (String phase) {
464 this.phase = phase;
465 al = new ArrayList<Integer[]>();
466 alComment = new ArrayList<String>();
467 len = 0;
468 }
469
470 public String getSizeMacro () {
471 return String.format(PcdDatabase.SkuIdTableSizeMacro, phase, getSize());
472 }
473
474 private int getSize () {
475 return (len == 0)? 1 : len;
476 }
477
478 public String getExistanceMacro () {
479 return String.format(PcdDatabase.SkuTableExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE");
480 }
481
482 public void genCodeNew (ArrayList<CStructTypeDeclaration> declaList, HashMap<String, String> instTable, String phase) {
483 final String name = "SkuIdTable";
484
485 CStructTypeDeclaration decl;
486 String cCode = "";
487
488 cCode += String.format(PcdDatabase.SkuIdTableDeclaration, phase);
489 decl = new CStructTypeDeclaration (
490 name,
491 1,
492 cCode,
493 true
494 );
495 declaList.add(decl);
496
497
498 cCode = PcdDatabase.genInstantiationStr(getInstantiation());
499 instTable.put(name, cCode);
500
501 //
502 // SystemSkuId is in PEI phase PCD Database
503 //
504 if (phase.equalsIgnoreCase("PEI")) {
505 decl = new CStructTypeDeclaration (
506 "SystemSkuId",
507 1,
508 "SKU_ID SystemSkuId;\r\n",
509 true
510 );
511 declaList.add(decl);
512
513 instTable.put("SystemSkuId", "0");
514 }
515
516 }
517
518 public String getTypeDeclaration () {
519 return String.format(PcdDatabase.SkuIdTableDeclaration, phase);
520 }
521
522 public ArrayList<String> getInstantiation () {
523 ArrayList<String> Output = new ArrayList<String> ();
524
525 Output.add("/* SkuIdTable */");
526 Output.add("{");
527
528 if (al.size() == 0) {
529 Output.add("\t0");
530 }
531
532 for (int index = 0; index < al.size(); index++) {
533 String str;
534
535 str = "/* " + alComment.get(index) + "*/ ";
536 str += "/* MaxSku */ ";
537
538
539 Integer[] ia = al.get(index);
540
541 str += "\t" + ia[0].toString() + ", ";
542 for (int index2 = 1; index2 < ia.length; index2++) {
543 str += ia[index2].toString();
544 if (!((index2 == ia.length - 1) && (index == al.size() - 1))) {
545 str += ", ";
546 }
547 }
548
549 Output.add(str);
550
551 }
552
553 Output.add("}");
554
555 return Output;
556 }
557
558 public int add (Token token) {
559
560 int index;
561 int pos;
562
563 //
564 // Check if this SKU_ID Array is already in the table
565 //
566 pos = 0;
567 for (Object o: al) {
568 Integer [] s = (Integer[]) o;
569 boolean different = false;
570 if (s[0] == token.getSkuIdCount()) {
571 for (index = 1; index < s.length; index++) {
572 if (s[index] != token.skuData.get(index-1).id) {
573 different = true;
574 break;
575 }
576 }
577 } else {
578 different = true;
579 }
580 if (different) {
581 pos += s[0] + 1;
582 } else {
583 return pos;
584 }
585 }
586
587 Integer [] skuIds = new Integer[token.skuData.size() + 1];
588 skuIds[0] = new Integer(token.skuData.size());
589 for (index = 1; index < skuIds.length; index++) {
590 skuIds[index] = new Integer(token.skuData.get(index - 1).id);
591 }
592
593 index = len;
594
595 len += skuIds.length;
596 al.add(skuIds);
597 alComment.add(token.getPrimaryKeyString());
598
599 return index;
600 }
601
602 public int getTableLen () {
603 return al.size() == 0 ? 1 : al.size();
604 }
605
606 }
607
608 class LocalTokenNumberTable {
609 private ArrayList<String> al;
610 private ArrayList<String> alComment;
611 private String phase;
612 private int len;
613
614 public LocalTokenNumberTable (String phase) {
615 this.phase = phase;
616 al = new ArrayList<String>();
617 alComment = new ArrayList<String>();
618
619 len = 0;
620 }
621
622 public String getSizeMacro () {
623 return String.format(PcdDatabase.LocalTokenNumberTableSizeMacro, phase, getSize())
624 + String.format(PcdDatabase.LocalTokenNumberSizeMacro, phase, al.size());
625 }
626
627 public int getSize () {
628 return (al.size() == 0)? 1 : al.size();
629 }
630
631 public String getExistanceMacro () {
632 return String.format(PcdDatabase.DatabaseExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE");
633 }
634
635 public void genCodeNew (ArrayList<CStructTypeDeclaration> declaList, HashMap<String, String> instTable, String phase) {
636 final String name = "LocalTokenNumberTable";
637
638 CStructTypeDeclaration decl;
639 String cCode = "";
640
641 cCode += String.format(PcdDatabase.LocalTokenNumberTableDeclaration, phase);
642 decl = new CStructTypeDeclaration (
643 name,
644 4,
645 cCode,
646 true
647 );
648 declaList.add(decl);
649
650 cCode = PcdDatabase.genInstantiationStr(getInstantiation());
651 instTable.put(name, cCode);
652 }
653
654 public String getTypeDeclaration () {
655 return String.format(PcdDatabase.LocalTokenNumberTableDeclaration, phase);
656 }
657
658 public ArrayList<String> getInstantiation () {
659 ArrayList<String> output = new ArrayList<String>();
660
661 output.add("/* LocalTokenNumberTable */");
662 output.add("{");
663
664 if (al.size() == 0) {
665 output.add("0");
666 }
667
668 for (int index = 0; index < al.size(); index++) {
669 String str;
670
671 str = "\t" + (String)al.get(index);
672
673 str += " /* " + alComment.get(index) + " */ ";
674
675
676 if (index != (al.size() - 1)) {
677 str += ",";
678 }
679
680 output.add(str);
681
682 }
683
684 output.add("}");
685
686 return output;
687 }
688
689 public int add (Token token) {
690 int index = len;
691 String str;
692
693 len++;
694
695 str = String.format(PcdDatabase.offsetOfStrTemplate, phase, token.hasDefaultValue() ? "Init" : "Uninit", token.getPrimaryKeyString());
696
697 if (token.isUnicodeStringType()) {
698 str += " | PCD_TYPE_STRING";
699 }
700
701 if (token.isSkuEnable()) {
702 str += " | PCD_TYPE_SKU_ENABLED";
703 }
704
705 if (token.getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.HII_TYPE) {
706 str += " | PCD_TYPE_HII";
707 }
708
709 if (token.getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.VPD_TYPE) {
710 str += " | PCD_TYPE_VPD";
711 }
712
713 al.add(str);
714 alComment.add(token.getPrimaryKeyString());
715
716 return index;
717 }
718 }
719
720 class ExMapTable {
721
722 class ExTriplet {
723 public Integer guidTableIdx;
724 public Long exTokenNumber;
725 public Long localTokenIdx;
726
727 public ExTriplet (int guidTableIdx, long exTokenNumber, long localTokenIdx) {
728 this.guidTableIdx = new Integer(guidTableIdx);
729 this.exTokenNumber = new Long(exTokenNumber);
730 this.localTokenIdx = new Long(localTokenIdx);
731 }
732 }
733
734 private ArrayList<ExTriplet> al;
735 private ArrayList<String> alComment;
736 private String phase;
737 private int len;
738 private int bodyLineNum;
739
740 public ExMapTable (String phase) {
741 this.phase = phase;
742 al = new ArrayList<ExTriplet>();
743 alComment = new ArrayList<String>();
744 bodyLineNum = 0;
745 len = 0;
746 }
747
748 public String getSizeMacro () {
749 return String.format(PcdDatabase.ExMapTableSizeMacro, phase, getTableLen())
750 + String.format(PcdDatabase.ExTokenNumber, phase, al.size());
751 }
752
753 public String getExistanceMacro () {
754 return String.format(PcdDatabase.ExMapTableExistenceMacro, phase, (al.size() == 0)? "TRUE":"FALSE");
755 }
756
757 public void genCodeNew (ArrayList<CStructTypeDeclaration> declaList, HashMap<String, String> instTable, String phase) {
758 final String exMapTableName = "ExMapTable";
759
760 sortTable();
761
762 CStructTypeDeclaration decl;
763 String cCode = "";
764
765 cCode += String.format(PcdDatabase.ExMapTableDeclaration, phase);
766 decl = new CStructTypeDeclaration (
767 exMapTableName,
768 4,
769 cCode,
770 true
771 );
772 declaList.add(decl);
773
774
775 cCode = PcdDatabase.genInstantiationStr(getInstantiation());
776 instTable.put(exMapTableName, cCode);
777 }
778
779 public String getTypeDeclaration () {
780 return String.format(PcdDatabase.ExMapTableDeclaration, phase);
781 }
782
783 public ArrayList<String> getInstantiation () {
784 ArrayList<String> Output = new ArrayList<String>();
785
786 Output.add("/* ExMapTable */");
787 Output.add("{");
788 if (al.size() == 0) {
789 Output.add("\t{0, 0, 0}");
790 }
791
792 int index;
793 for (index = 0; index < al.size(); index++) {
794 String str;
795
796 ExTriplet e = (ExTriplet)al.get(index);
797
798 str = "\t" + "{ " + String.format("0x%08X", e.exTokenNumber) + ", ";
799 str += e.localTokenIdx.toString() + ", ";
800 str += e.guidTableIdx.toString();
801
802 str += "}" + " /* " + alComment.get(index) + " */" ;
803
804 if (index != al.size() - 1) {
805 str += ",";
806 }
807
808 Output.add(str);
809 bodyLineNum++;
810
811 }
812
813 Output.add("}");
814
815 return Output;
816 }
817
818 public int add (int localTokenIdx, long exTokenNum, int guidTableIdx, String name) {
819 int index = len;
820
821 len++;
822 al.add(new ExTriplet(guidTableIdx, exTokenNum, localTokenIdx));
823 alComment.add(name);
824
825 return index;
826 }
827
828 public int getTableLen () {
829 return al.size() == 0 ? 1 : al.size();
830 }
831
832 //
833 // To simplify the algorithm for GetNextToken and GetNextTokenSpace in
834 // PCD PEIM/Driver, we need to sort the ExMapTable according to the
835 // following order:
836 // 1) ExGuid
837 // 2) ExTokenNumber
838 //
839 class ExTripletComp implements Comparator<ExTriplet> {
840 public int compare (ExTriplet a, ExTriplet b) {
841 if (a.guidTableIdx == b.guidTableIdx ) {
842 if (a.exTokenNumber > b.exTokenNumber) {
843 return 1;
844 } else if (a.exTokenNumber > b.exTokenNumber) {
845 return 1;
846 } else {
847 return 0;
848 }
849 }
850
851 return a.guidTableIdx - b.guidTableIdx;
852 }
853 }
854
855 private void sortTable () {
856 java.util.Comparator<ExTriplet> comparator = new ExTripletComp();
857 java.util.Collections.sort(al, comparator);
858 }
859 }
860
861 class PcdDatabase {
862
863 private final static int SkuHeadAlignmentSize = 4;
864 private final String newLine = "\r\n";
865 private final String commaNewLine = ",\r\n";
866 private final String tab = "\t";
867 public final static String ExMapTableDeclaration = "DYNAMICEX_MAPPING ExMapTable[%s_EXMAPPING_TABLE_SIZE];\r\n";
868 public final static String GuidTableDeclaration = "EFI_GUID GuidTable[%s_GUID_TABLE_SIZE];\r\n";
869 public final static String LocalTokenNumberTableDeclaration = "UINT32 LocalTokenNumberTable[%s_LOCAL_TOKEN_NUMBER_TABLE_SIZE];\r\n";
870 public final static String StringTableDeclaration = "UINT16 StringTable[%s_STRING_TABLE_SIZE];\r\n";
871 public final static String SizeTableDeclaration = "UINT16 SizeTable[%s_LOCAL_TOKEN_NUMBER_TABLE_SIZE];\r\n";
872 public final static String SkuIdTableDeclaration = "UINT8 SkuIdTable[%s_SKUID_TABLE_SIZE];\r\n";
873
874
875 public final static String ExMapTableSizeMacro = "#define %s_EXMAPPING_TABLE_SIZE %d\r\n";
876 public final static String ExTokenNumber = "#define %s_EX_TOKEN_NUMBER %d\r\n";
877 public final static String GuidTableSizeMacro = "#define %s_GUID_TABLE_SIZE %d\r\n";
878 public final static String LocalTokenNumberTableSizeMacro = "#define %s_LOCAL_TOKEN_NUMBER_TABLE_SIZE %d\r\n";
879 public final static String LocalTokenNumberSizeMacro = "#define %s_LOCAL_TOKEN_NUMBER %d\r\n";
880 public final static String StringTableSizeMacro = "#define %s_STRING_TABLE_SIZE %d\r\n";
881 public final static String SkuIdTableSizeMacro = "#define %s_SKUID_TABLE_SIZE %d\r\n";
882
883
884 public final static String ExMapTableExistenceMacro = "#define %s_EXMAP_TABLE_EMPTY %s\r\n";
885 public final static String GuidTableExistenceMacro = "#define %s_GUID_TABLE_EMPTY %s\r\n";
886 public final static String DatabaseExistenceMacro = "#define %s_DATABASE_EMPTY %s\r\n";
887 public final static String StringTableExistenceMacro = "#define %s_STRING_TABLE_EMPTY %s\r\n";
888 public final static String SkuTableExistenceMacro = "#define %s_SKUID_TABLE_EMPTY %s\r\n";
889
890 public final static String offsetOfSkuHeadStrTemplate = "offsetof(%s_PCD_DATABASE, %s.%s_SkuDataTable)";
891 public final static String offsetOfVariableEnabledDefault = "offsetof(%s_PCD_DATABASE, %s.%s_VariableDefault_%d)";
892 public final static String offsetOfStrTemplate = "offsetof(%s_PCD_DATABASE, %s.%s)";
893
894 private final static String skuDataTableTemplate = "SkuDataTable";
895
896
897 private StringTable stringTable;
898 private GuidTable guidTable;
899 private LocalTokenNumberTable localTokenNumberTable;
900 private SkuIdTable skuIdTable;
901 private SizeTable sizeTable;
902 private ExMapTable exMapTable;
903
904 private ArrayList<Token> alTokens;
905 private String phase;
906 private int assignedTokenNumber;
907
908 //
909 // Use two class global variable to store
910 // temperary
911 //
912 private String privateGlobalName;
913 private String privateGlobalCCode;
914 //
915 // After Major changes done to the PCD
916 // database generation class PcdDatabase
917 // Please increment the version and please
918 // also update the version number in PCD
919 // service PEIM and DXE driver accordingly.
920 //
921 private final int version = 2;
922
923 private String hString;
924 private String cString;
925
926
927 class AlignmentSizeComp implements Comparator<Token> {
928 public int compare (Token a, Token b) {
929 return getAlignmentSize(b)
930 - getAlignmentSize(a);
931 }
932 }
933
934 public PcdDatabase (ArrayList<Token> alTokens, String exePhase, int startLen) {
935 phase = exePhase;
936
937 stringTable = new StringTable(phase);
938 guidTable = new GuidTable(phase);
939 localTokenNumberTable = new LocalTokenNumberTable(phase);
940 skuIdTable = new SkuIdTable(phase);
941 sizeTable = new SizeTable(phase);
942 exMapTable = new ExMapTable(phase);
943
944 assignedTokenNumber = startLen + 1;
945 this.alTokens = alTokens;
946 }
947
948 private void getNonExAndExTokens (ArrayList<Token> alTokens, List<Token> nexTokens, List<Token> exTokens) {
949 for (int i = 0; i < alTokens.size(); i++) {
950 Token t = (Token)alTokens.get(i);
951 if (t.isDynamicEx()) {
952 exTokens.add(t);
953 } else {
954 nexTokens.add(t);
955 }
956 }
957
958 return;
959 }
960
961 private void getTwoGroupsOfTokens (ArrayList<Token> alTokens, List<Token> initTokens, List<Token> uninitTokens) {
962 for (int i = 0; i < alTokens.size(); i++) {
963 Token t = (Token)alTokens.get(i);
964 if (t.hasDefaultValue()) {
965 initTokens.add(t);
966 } else {
967 uninitTokens.add(t);
968 }
969 }
970
971 return;
972 }
973
974 private int getDataTypeAlignmentSize (Token token) {
975 switch (token.datumType) {
976 case UINT8:
977 return 1;
978 case UINT16:
979 return 2;
980 case UINT32:
981 return 4;
982 case UINT64:
983 return 8;
984 case POINTER:
985 return 1;
986 case BOOLEAN:
987 return 1;
988 default:
989 return 1;
990 }
991 }
992
993 private int getAlignmentSize (Token token) {
994 if (token.getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.HII_TYPE) {
995 return 2;
996 }
997
998 if (token.getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.VPD_TYPE) {
999 return 4;
1000 }
1001
1002 if (token.isUnicodeStringType()) {
1003 return 2;
1004 }
1005
1006 return getDataTypeAlignmentSize(token);
1007 }
1008
1009 public String getCString () {
1010 return cString;
1011 }
1012
1013 public String getHString () {
1014 return hString;
1015 }
1016
1017 private void genCodeWorker(Token t,
1018 ArrayList<CStructTypeDeclaration> declaList,
1019 HashMap<String, String> instTable, String phase)
1020 throws EntityException {
1021
1022 CStructTypeDeclaration decl;
1023
1024 //
1025 // Insert SKU_HEAD if isSkuEnable is true
1026 //
1027 if (t.isSkuEnable()) {
1028 int tableIdx;
1029 tableIdx = skuIdTable.add(t);
1030 decl = new CStructTypeDeclaration(t.getPrimaryKeyString(),
1031 SkuHeadAlignmentSize, getSkuEnabledTypeDeclaration(t), true);
1032 declaList.add(decl);
1033 instTable.put(t.getPrimaryKeyString(),
1034 getSkuEnabledTypeInstantiaion(t, tableIdx));
1035 }
1036
1037 //
1038 // Insert PCD_ENTRY declaration and instantiation
1039 //
1040 getCDeclarationString(t);
1041
1042 decl = new CStructTypeDeclaration(privateGlobalName,
1043 getAlignmentSize(t), privateGlobalCCode, t.hasDefaultValue());
1044 declaList.add(decl);
1045
1046 if (t.hasDefaultValue()) {
1047 instTable.put(privateGlobalName,
1048 getTypeInstantiation(t, declaList, instTable, phase)
1049 );
1050 }
1051
1052 }
1053
1054 private void ProcessTokensNew (List<Token> tokens,
1055 ArrayList<CStructTypeDeclaration> cStructDeclList,
1056 HashMap<String, String> cStructInstTable,
1057 String phase
1058 )
1059 throws EntityException {
1060
1061 for (int idx = 0; idx < tokens.size(); idx++) {
1062 Token t = tokens.get(idx);
1063
1064 genCodeWorker (t, cStructDeclList, cStructInstTable, phase);
1065
1066 sizeTable.add(t);
1067 localTokenNumberTable.add(t);
1068 t.tokenNumber = assignedTokenNumber++;
1069
1070 //
1071 // Add a mapping if this dynamic PCD entry is a EX type
1072 //
1073 if (t.isDynamicEx()) {
1074 exMapTable.add(t.tokenNumber,
1075 t.dynamicExTokenNumber,
1076 guidTable.add(t.tokenSpaceName, t.getPrimaryKeyString()),
1077 t.getPrimaryKeyString()
1078 );
1079 }
1080 }
1081
1082 }
1083
1084 public void genCodeNew () throws EntityException {
1085
1086 ArrayList<CStructTypeDeclaration> cStructDeclList = new ArrayList<CStructTypeDeclaration>();
1087 HashMap<String, String> cStructInstTable = new HashMap<String, String>();
1088
1089 List<Token> nexTokens = new ArrayList<Token> ();
1090 List<Token> exTokens = new ArrayList<Token> ();
1091
1092 getNonExAndExTokens (alTokens, nexTokens, exTokens);
1093
1094 //
1095 // We have to process Non-Ex type PCD entry first. The reason is
1096 // that our optimization assumes that the Token Number of Non-Ex
1097 // PCD entry start from 1 (for PEI phase) and grows continously upwards.
1098 //
1099 // EX type token number starts from the last Non-EX PCD entry and
1100 // grows continously upwards.
1101 //
1102 ProcessTokensNew (nexTokens, cStructDeclList, cStructInstTable, phase);
1103 ProcessTokensNew (exTokens, cStructDeclList, cStructInstTable, phase);
1104
1105 stringTable.genCodeNew(cStructDeclList, cStructInstTable);
1106 skuIdTable.genCodeNew(cStructDeclList, cStructInstTable, phase);
1107 exMapTable.genCodeNew(cStructDeclList, cStructInstTable, phase);
1108 localTokenNumberTable.genCodeNew(cStructDeclList, cStructInstTable, phase);
1109 sizeTable.genCodeNew(cStructDeclList, cStructInstTable, phase);
1110 guidTable.genCodeNew(cStructDeclList, cStructInstTable, phase);
1111
1112 hString = genCMacroCode ();
1113
1114 HashMap <String, String> result;
1115
1116 result = genCStructCode(cStructDeclList,
1117 cStructInstTable,
1118 phase
1119 );
1120
1121 hString += result.get("initDeclStr");
1122 hString += result.get("uninitDeclStr");
1123
1124 hString += String.format("#define PCD_%s_SERVICE_DRIVER_VERSION %d", phase, version);
1125
1126 cString = newLine + newLine + result.get("initInstStr");
1127
1128 }
1129
1130 private String genCMacroCode () {
1131 String macroStr = "";
1132
1133 //
1134 // Generate size info Macro for all Tables
1135 //
1136 macroStr += guidTable.getSizeMacro();
1137 macroStr += stringTable.getSizeMacro();
1138 macroStr += skuIdTable.getSizeMacro();
1139 macroStr += localTokenNumberTable.getSizeMacro();
1140 macroStr += exMapTable.getSizeMacro();
1141
1142 //
1143 // Generate existance info Macro for all Tables
1144 //
1145 macroStr += guidTable.getExistanceMacro();
1146 macroStr += stringTable.getExistanceMacro();
1147 macroStr += skuIdTable.getExistanceMacro();
1148 macroStr += localTokenNumberTable.getExistanceMacro();
1149 macroStr += exMapTable.getExistanceMacro();
1150
1151 macroStr += newLine;
1152
1153 return macroStr;
1154 }
1155
1156 private HashMap <String, String> genCStructCode(
1157 ArrayList<CStructTypeDeclaration> declaList,
1158 HashMap<String, String> instTable,
1159 String phase
1160 ) {
1161
1162 int i;
1163 HashMap <String, String> result = new HashMap<String, String>();
1164 HashMap <Integer, ArrayList<String>> alignmentInitDecl = new HashMap<Integer, ArrayList<String>>();
1165 HashMap <Integer, ArrayList<String>> alignmentUninitDecl = new HashMap<Integer, ArrayList<String>>();
1166 HashMap <Integer, ArrayList<String>> alignmentInitInst = new HashMap<Integer, ArrayList<String>>();
1167
1168 //
1169 // Initialize the storage for each alignment
1170 //
1171 for (i = 8; i > 0; i>>=1) {
1172 alignmentInitDecl.put(new Integer(i), new ArrayList<String>());
1173 alignmentInitInst.put(new Integer(i), new ArrayList<String>());
1174 alignmentUninitDecl.put(new Integer(i), new ArrayList<String>());
1175 }
1176
1177 String initDeclStr = "typedef struct {" + newLine;
1178 String initInstStr = String.format("%s_PCD_DATABASE_INIT g%sPcdDbInit = { ", phase.toUpperCase(), phase.toUpperCase()) + newLine;
1179 String uninitDeclStr = "typedef struct {" + newLine;
1180
1181 //
1182 // Sort all C declaration and instantiation base on Alignment Size
1183 //
1184 for (Object d : declaList) {
1185 CStructTypeDeclaration decl = (CStructTypeDeclaration) d;
1186
1187 if (decl.initTable) {
1188 alignmentInitDecl.get(new Integer(decl.alignmentSize)).add(decl.cCode);
1189 alignmentInitInst.get(new Integer(decl.alignmentSize)).add(instTable.get(decl.key));
1190 } else {
1191 alignmentUninitDecl.get(new Integer(decl.alignmentSize)).add(decl.cCode);
1192 }
1193 }
1194
1195 //
1196 // Generate code for every alignment size
1197 //
1198 for (int align = 8; align > 0; align >>= 1) {
1199 ArrayList<String> declaListBasedOnAlignment = alignmentInitDecl.get(new Integer(align));
1200 ArrayList<String> instListBasedOnAlignment = alignmentInitInst.get(new Integer(align));
1201 for (i = 0; i < declaListBasedOnAlignment.size(); i++) {
1202 initDeclStr += tab + declaListBasedOnAlignment.get(i);
1203 initInstStr += tab + instListBasedOnAlignment.get(i);
1204
1205 //
1206 // We made a assumption that both PEI_PCD_DATABASE and DXE_PCD_DATABASE
1207 // has a least one data memember with alignment size of 1. So we can
1208 // remove the last "," in the C structure instantiation string.
1209 //
1210 if ((align == 1) && (i == declaListBasedOnAlignment.size() - 1)) {
1211 initInstStr += newLine;
1212 } else {
1213 initInstStr += commaNewLine;
1214 }
1215 }
1216
1217 declaListBasedOnAlignment = alignmentUninitDecl.get(new Integer(align));
1218 for (Object d : declaListBasedOnAlignment) {
1219 String s = (String)d;
1220 uninitDeclStr += tab + s;
1221 }
1222 }
1223
1224 initDeclStr += String.format("} %s_PCD_DATABASE_INIT;", phase) + newLine + newLine;
1225 initInstStr += "};";
1226 uninitDeclStr += String.format("} %s_PCD_DATABASE_UNINIT;", phase) + newLine + newLine;
1227
1228 result.put("initDeclStr", initDeclStr);
1229 result.put("initInstStr", initInstStr);
1230 result.put("uninitDeclStr", uninitDeclStr);
1231
1232 return result;
1233 }
1234
1235 public void genCode ()
1236 throws EntityException {
1237
1238 final String newLine = "\r\n";
1239 final String declNewLine = ";\r\n";
1240 final String tab = "\t";
1241 final String commaNewLine = ", \r\n";
1242
1243 int i;
1244 ArrayList<String> decla;
1245 ArrayList<String> inst;
1246
1247 String macroStr = "";
1248 String initDeclStr = "";
1249 String initInstStr = "";
1250 String uninitDeclStr = "";
1251
1252 List<Token> initTokens = new ArrayList<Token> ();
1253 List<Token> uninitTokens = new ArrayList<Token> ();
1254
1255 HashMap <String, ArrayList<String>> initCode = new HashMap<String, ArrayList<String>> ();
1256 HashMap <String, ArrayList<String>> uninitCode = new HashMap<String, ArrayList<String>> ();
1257
1258 getTwoGroupsOfTokens (alTokens, initTokens, uninitTokens);
1259
1260 //
1261 // Generate Structure Declaration for PcdTokens without Default Value
1262 // PEI_PCD_DATABASE_INIT
1263 //
1264 java.util.Comparator<Token> comparator = new AlignmentSizeComp();
1265 java.util.Collections.sort(initTokens, comparator);
1266 initCode = processTokens(initTokens);
1267
1268 //
1269 // Generate Structure Declaration for PcdTokens without Default Value
1270 // PEI_PCD_DATABASE_UNINIT
1271 //
1272 java.util.Collections.sort(uninitTokens, comparator);
1273 uninitCode = processTokens(uninitTokens);
1274
1275 //
1276 // Generate size info Macro for all Tables
1277 //
1278 macroStr += guidTable.getSizeMacro();
1279 macroStr += stringTable.getSizeMacro();
1280 macroStr += skuIdTable.getSizeMacro();
1281 macroStr += localTokenNumberTable.getSizeMacro();
1282 macroStr += exMapTable.getSizeMacro();
1283
1284 //
1285 // Generate existance info Macro for all Tables
1286 //
1287 macroStr += guidTable.getExistanceMacro();
1288 macroStr += stringTable.getExistanceMacro();
1289 macroStr += skuIdTable.getExistanceMacro();
1290 macroStr += localTokenNumberTable.getExistanceMacro();
1291 macroStr += exMapTable.getExistanceMacro();
1292
1293 //
1294 // Generate Structure Declaration for PcdTokens with Default Value
1295 // for example PEI_PCD_DATABASE_INIT
1296 //
1297 initDeclStr += "typedef struct {" + newLine;
1298 {
1299 initDeclStr += tab + exMapTable.getTypeDeclaration();
1300 initDeclStr += tab + guidTable.getTypeDeclaration();
1301 initDeclStr += tab + localTokenNumberTable.getTypeDeclaration();
1302 initDeclStr += tab + stringTable.getTypeDeclaration();
1303 initDeclStr += tab + sizeTable.getTypeDeclaration();
1304 initDeclStr += tab + skuIdTable.getTypeDeclaration();
1305 if (phase.equalsIgnoreCase("PEI")) {
1306 initDeclStr += tab + "SKU_ID SystemSkuId;" + newLine;
1307 }
1308
1309 decla = initCode.get(new String("Declaration"));
1310 for (i = 0; i < decla.size(); i++) {
1311 initDeclStr += tab + decla.get(i) + declNewLine;
1312 }
1313
1314 //
1315 // Generate Structure Declaration for PcdToken with SkuEnabled
1316 //
1317 decla = initCode.get("DeclarationForSku");
1318
1319 for (i = 0; i < decla.size(); i++) {
1320 initDeclStr += tab + decla.get(i) + declNewLine;
1321 }
1322 }
1323 initDeclStr += String.format("} %s_PCD_DATABASE_INIT;\r\n\r\n", phase);
1324
1325 //
1326 // Generate MACRO for structure intialization of PCDTokens with Default Value
1327 // The sequence must match the sequence of declaration of the memembers in the structure
1328 String tmp = String.format("%s_PCD_DATABASE_INIT g%sPcdDbInit = { ", phase.toUpperCase(), phase.toUpperCase());
1329 initInstStr += tmp + newLine;
1330 initInstStr += tab + genInstantiationStr(exMapTable.getInstantiation()) + commaNewLine;
1331 initInstStr += tab + genInstantiationStr(guidTable.getInstantiation()) + commaNewLine;
1332 initInstStr += tab + genInstantiationStr(localTokenNumberTable.getInstantiation()) + commaNewLine;
1333 initInstStr += tab + genInstantiationStr(stringTable.getInstantiation()) + commaNewLine;
1334 initInstStr += tab + genInstantiationStr(sizeTable.getInstantiation()) + commaNewLine;
1335 initInstStr += tab + genInstantiationStr(skuIdTable.getInstantiation()) + commaNewLine;
1336 //
1337 // For SystemSkuId
1338 //
1339 if (phase.equalsIgnoreCase("PEI")) {
1340 initInstStr += tab + "0" + tab + "/* SystemSkuId */" + commaNewLine;
1341 }
1342
1343 inst = initCode.get("Instantiation");
1344 for (i = 0; i < inst.size(); i++) {
1345 initInstStr += tab + inst.get(i) + commaNewLine;
1346 }
1347
1348 inst = initCode.get("InstantiationForSku");
1349 for (i = 0; i < inst.size(); i++) {
1350 initInstStr += tab + inst.get(i);
1351 if (i != inst.size() - 1) {
1352 initInstStr += commaNewLine;
1353 }
1354 }
1355
1356 initInstStr += "};";
1357
1358 uninitDeclStr += "typedef struct {" + newLine;
1359 {
1360 decla = uninitCode.get("Declaration");
1361 if (decla.size() == 0) {
1362 uninitDeclStr += "UINT8 dummy /* The UINT struct is empty */" + declNewLine;
1363 } else {
1364
1365 for (i = 0; i < decla.size(); i++) {
1366 uninitDeclStr += tab + decla.get(i) + declNewLine;
1367 }
1368
1369 decla = uninitCode.get("DeclarationForSku");
1370
1371 for (i = 0; i < decla.size(); i++) {
1372 uninitDeclStr += tab + decla.get(i) + declNewLine;
1373 }
1374 }
1375 }
1376 uninitDeclStr += String.format("} %s_PCD_DATABASE_UNINIT;\r\n\r\n", phase);
1377
1378 cString = initInstStr + newLine;
1379 hString = macroStr + newLine
1380 + initDeclStr + newLine
1381 + uninitDeclStr + newLine
1382 + newLine;
1383
1384 hString += String.format("#define PCD_%s_SERVICE_DRIVER_VERSION %d", phase, version);
1385
1386 }
1387
1388 public static String genInstantiationStr (ArrayList<String> alStr) {
1389 String str = "";
1390 for (int i = 0; i< alStr.size(); i++) {
1391 if (i != 0) {
1392 str += "\t";
1393 }
1394 str += alStr.get(i);
1395 if (i != alStr.size() - 1) {
1396 str += "\r\n";
1397 }
1398 }
1399
1400 return str;
1401 }
1402
1403 private HashMap<String, ArrayList<String>> processTokens (List<Token> alToken)
1404 throws EntityException {
1405
1406 HashMap <String, ArrayList<String>> map = new HashMap<String, ArrayList<String>>();
1407
1408 ArrayList<String> decl = new ArrayList<String>();
1409 ArrayList<String> declForSkuEnableType = new ArrayList<String>();
1410 ArrayList<String> inst = new ArrayList<String>();
1411 ArrayList<String> instForSkuEnableType = new ArrayList<String>();
1412
1413 for (int index = 0; index < alToken.size(); index++) {
1414 Token token = alToken.get(index);
1415
1416 if (token.isSkuEnable()) {
1417 //
1418 // BugBug: Schema only support Data type now
1419 //
1420 int tableIdx;
1421
1422 tableIdx = skuIdTable.add(token);
1423
1424 decl.add(getSkuEnabledTypeDeclaration(token));
1425 if (token.hasDefaultValue()) {
1426 inst.add(getSkuEnabledTypeInstantiaion(token, tableIdx));
1427 }
1428
1429 declForSkuEnableType.add(getDataTypeDeclarationForSkuEnabled(token));
1430 if (token.hasDefaultValue()) {
1431 instForSkuEnableType.add(getDataTypeInstantiationForSkuEnabled(token));
1432 }
1433
1434 } else {
1435 if (token.getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.HII_TYPE) {
1436 decl.add(getVariableEnableTypeDeclaration(token));
1437 inst.add(getVariableEnableInstantiation(token));
1438 } else if (token.getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.VPD_TYPE) {
1439 decl.add(getVpdEnableTypeDeclaration(token));
1440 inst.add(getVpdEnableTypeInstantiation(token));
1441 } else if (token.isUnicodeStringType()) {
1442 decl.add(getStringTypeDeclaration(token));
1443 inst.add(getStringTypeInstantiation(stringTable.add(token.getStringTypeString(), token), token));
1444 }
1445 else {
1446 decl.add(getDataTypeDeclaration(token));
1447 if (token.hasDefaultValue()) {
1448 inst.add(getDataTypeInstantiation(token));
1449 }
1450 }
1451 }
1452
1453 sizeTable.add(token);
1454 localTokenNumberTable.add(token);
1455 token.tokenNumber = assignedTokenNumber++;
1456
1457 }
1458
1459 map.put("Declaration", decl);
1460 map.put("DeclarationForSku", declForSkuEnableType);
1461 map.put("Instantiation", inst);
1462 map.put("InstantiationForSku", instForSkuEnableType);
1463
1464 return map;
1465 }
1466
1467 private String getSkuEnabledTypeDeclaration (Token token) {
1468 return String.format("SKU_HEAD %s;\r\n", token.getPrimaryKeyString());
1469 }
1470
1471 private String getSkuEnabledTypeInstantiaion (Token token, int SkuTableIdx) {
1472
1473 String offsetof = String.format(PcdDatabase.offsetOfSkuHeadStrTemplate, phase, token.hasDefaultValue()? "Init" : "Uninit", token.getPrimaryKeyString());
1474 return String.format("{ %s, %d } /* SKU_ENABLED: %s */", offsetof, SkuTableIdx, token.getPrimaryKeyString());
1475 }
1476
1477 private String getDataTypeDeclarationForSkuEnabled (Token token) {
1478 String typeStr = "";
1479
1480 if (token.datumType == Token.DATUM_TYPE.UINT8) {
1481 typeStr = "UINT8 %s_%s[%d];\r\n";
1482 } else if (token.datumType == Token.DATUM_TYPE.UINT16) {
1483 typeStr = "UINT16 %s_%s[%d];\r\n";
1484 } else if (token.datumType == Token.DATUM_TYPE.UINT32) {
1485 typeStr = "UINT32 %s_%s[%d];\r\n";
1486 } else if (token.datumType == Token.DATUM_TYPE.UINT64) {
1487 typeStr = "UINT64 %s_%s[%d];\r\n";
1488 } else if (token.datumType == Token.DATUM_TYPE.BOOLEAN) {
1489 typeStr = "BOOLEAN %s_%s[%d];\r\n";
1490 } else if (token.datumType == Token.DATUM_TYPE.POINTER) {
1491 return String.format("UINT8 %s_%s[%d];\r\n", token.getPrimaryKeyString(), "SkuDataTable", token.datumSize * token.skuData.size());
1492 }
1493
1494 return String.format(typeStr, token.getPrimaryKeyString(), "SkuDataTable", token.skuData.size());
1495
1496 }
1497
1498 private String getDataTypeInstantiationForSkuEnabled (Token token) {
1499 String str = "";
1500
1501 if (token.datumType == Token.DATUM_TYPE.POINTER) {
1502 return String.format("UINT8 %s_%s[%d]", token.getPrimaryKeyString(), "SkuDataTable", token.datumSize * token.skuData.size());
1503 } else {
1504 str = "{ ";
1505 for (int idx = 0; idx < token.skuData.size(); idx++) {
1506 str += token.skuData.get(idx).toString();
1507 if (idx != token.skuData.size() - 1) {
1508 str += ", ";
1509 }
1510 }
1511 str += "}";
1512
1513 return str;
1514 }
1515
1516 }
1517
1518 private String getDataTypeInstantiationForVariableDefault_new (Token token, String cName, int skuId) {
1519 return String.format("%s /* %s */", token.skuData.get(skuId).value.hiiDefaultValue, cName);
1520 }
1521
1522 private String getDataTypeInstantiation (Token token) {
1523
1524 if (token.datumType == Token.DATUM_TYPE.POINTER) {
1525 return String.format("%s /* %s */", token.getDefaultSku().value, token.getPrimaryKeyString());
1526 } else {
1527 return String.format("%s /* %s */", token.getDefaultSku().value, token.getPrimaryKeyString());
1528 }
1529 }
1530
1531 private String getCType (Token t)
1532 throws EntityException {
1533
1534 if (t.isHiiEnable()) {
1535 return "VARIABLE_HEAD";
1536 }
1537
1538 if (t.isVpdEnable()) {
1539 return "VPD_HEAD";
1540 }
1541
1542 if (t.isUnicodeStringType()) {
1543 return "STRING_HEAD";
1544 }
1545
1546 switch (t.datumType) {
1547 case UINT64:
1548 return "UINT64";
1549 case UINT32:
1550 return "UINT32";
1551 case UINT16:
1552 return "UINT16";
1553 case UINT8:
1554 return "UINT8";
1555 case BOOLEAN:
1556 return "BOOLEAN";
1557 case POINTER:
1558 return "UINT8";
1559 default:
1560 throw new EntityException("Unknown type in getDataTypeCDeclaration");
1561 }
1562 }
1563
1564 private void getCDeclarationString(Token t)
1565 throws EntityException {
1566
1567 if (t.isSkuEnable()) {
1568 privateGlobalName = String.format("%s_%s", t.getPrimaryKeyString(), skuDataTableTemplate);
1569 } else {
1570 privateGlobalName = t.getPrimaryKeyString();
1571 }
1572
1573 if (t.isUnicodeStringType()) {
1574 privateGlobalCCode = String.format("STRING_HEAD %s[%d];\r\n", t.getPrimaryKeyString(), t.getSkuIdCount());
1575 } else {
1576 String type = getCType(t);
1577 if (t.datumType == Token.DATUM_TYPE.POINTER) {
1578 privateGlobalCCode = String.format("%s %s[%d][%d];\r\n", type, privateGlobalName, t.getSkuIdCount(), t.datumSize);
1579 } else {
1580 privateGlobalCCode = String.format("%s %s[%d];\r\n", type, privateGlobalName, t.getSkuIdCount());
1581 }
1582 }
1583 }
1584
1585 private String getDataTypeDeclarationForVariableDefault_new (Token token, String cName, int skuId) {
1586
1587 String typeStr = "";
1588
1589 if (token.datumType == Token.DATUM_TYPE.UINT8) {
1590 typeStr = "UINT8";
1591 } else if (token.datumType == Token.DATUM_TYPE.UINT16) {
1592 typeStr = "UINT16";
1593 } else if (token.datumType == Token.DATUM_TYPE.UINT32) {
1594 typeStr = "UINT32";
1595 } else if (token.datumType == Token.DATUM_TYPE.UINT64) {
1596 typeStr = "UINT64";
1597 } else if (token.datumType == Token.DATUM_TYPE.BOOLEAN) {
1598 typeStr = "BOOLEAN";
1599 } else if (token.datumType == Token.DATUM_TYPE.POINTER) {
1600 return String.format("UINT8 %s[%d]", cName, token.datumSize);
1601 } else {
1602 }
1603
1604 return String.format("%s %s;\r\n", typeStr, cName);
1605 }
1606
1607 private String getDataTypeDeclaration (Token token) {
1608
1609 String typeStr = "";
1610
1611 if (token.datumType == Token.DATUM_TYPE.UINT8) {
1612 typeStr = "UINT8";
1613 } else if (token.datumType == Token.DATUM_TYPE.UINT16) {
1614 typeStr = "UINT16";
1615 } else if (token.datumType == Token.DATUM_TYPE.UINT32) {
1616 typeStr = "UINT32";
1617 } else if (token.datumType == Token.DATUM_TYPE.UINT64) {
1618 typeStr = "UINT64";
1619 } else if (token.datumType == Token.DATUM_TYPE.BOOLEAN) {
1620 typeStr = "BOOLEAN";
1621 } else if (token.datumType == Token.DATUM_TYPE.POINTER) {
1622 return String.format("UINT8 %s[%d]", token.getPrimaryKeyString(), token.datumSize);
1623 } else {
1624 }
1625
1626 return String.format("%s %s", typeStr, token.getPrimaryKeyString());
1627 }
1628
1629 private String getVpdEnableTypeDeclaration (Token token) {
1630 return String.format("VPD_HEAD %s", token.getPrimaryKeyString());
1631 }
1632
1633 private String getTypeInstantiation (Token t, ArrayList<CStructTypeDeclaration> declaList, HashMap<String, String> instTable, String phase) throws EntityException {
1634
1635 int i;
1636
1637 String s;
1638 s = String.format("/* %s */", t.getPrimaryKeyString()) + newLine;
1639 s += tab + "{" + newLine;
1640
1641 for (i = 0; i < t.skuData.size(); i++) {
1642 if (t.isUnicodeStringType() && !t.isHiiEnable()) {
1643 s += tab + tab + String.format("{ %d }", stringTable.add(t.skuData.get(i).value.value, t));
1644 } else if (t.isHiiEnable()) {
1645 /* VPD_HEAD definition
1646 typedef struct {
1647 UINT16 GuidTableIndex; // Offset in Guid Table in units of GUID.
1648 UINT16 StringIndex; // Offset in String Table in units of UINT16.
1649 UINT16 Offset; // Offset in Variable
1650 } VARIABLE_HEAD ;
1651 */
1652 String variableDefaultName = String.format("%s_VariableDefault_%d", t.getPrimaryKeyString(), i);
1653
1654 s += tab + tab + String.format("{ %d, %d, %s, %s }", guidTable.add(t.skuData.get(i).value.variableGuid, t.getPrimaryKeyString()),
1655 stringTable.add(t.skuData.get(i).value.getStringOfVariableName(), t),
1656 t.skuData.get(i).value.variableOffset,
1657 String.format("offsetof(%s_PCD_DATABASE, Init.%s)", phase, variableDefaultName)
1658 );
1659 //
1660 // We need to support the default value, so we add the declaration and
1661 // the instantiation for the default value.
1662 //
1663 CStructTypeDeclaration decl = new CStructTypeDeclaration (variableDefaultName,
1664 getDataTypeAlignmentSize(t),
1665 getDataTypeDeclarationForVariableDefault_new(t, variableDefaultName, i),
1666 true
1667 );
1668 declaList.add(decl);
1669 instTable.put(variableDefaultName, getDataTypeInstantiationForVariableDefault_new (t, variableDefaultName, i));
1670 } else if (t.isVpdEnable()) {
1671 /* typedef struct {
1672 UINT32 Offset;
1673 } VPD_HEAD;
1674 */
1675 s += tab + tab + String.format("{ %s }", t.skuData.get(i).value.vpdOffset);
1676 } else {
1677 s += tab + tab + String.format("{ %s }", t.skuData.get(i).value.value);
1678 }
1679
1680 if (i != t.skuData.size() - 1) {
1681 s += commaNewLine;
1682 } else {
1683 s += newLine;
1684 }
1685
1686 }
1687
1688 s += tab + "}";
1689
1690 return s;
1691 }
1692
1693 private String getVpdEnableTypeInstantiation (Token token) {
1694 return String.format("{ %s } /* %s */", token.getDefaultSku().vpdOffset,
1695 token.getPrimaryKeyString());
1696 }
1697
1698 private String getStringTypeDeclaration (Token token) {
1699 return String.format("UINT16 %s", token.getPrimaryKeyString());
1700 }
1701
1702 private String getStringTypeInstantiation (int StringTableIdx, Token token) {
1703 return String.format ("%d /* %s */", StringTableIdx,
1704 token.getPrimaryKeyString());
1705 }
1706
1707
1708 private String getVariableEnableTypeDeclaration (Token token) {
1709 return String.format("VARIABLE_HEAD %s", token.getPrimaryKeyString());
1710 }
1711
1712 private String getVariableEnableInstantiation (Token token)
1713 throws EntityException {
1714 //
1715 // Need scott fix
1716 //
1717 return String.format("{ %d, %d, %s } /* %s */", guidTable.add(token.getDefaultSku().variableGuid, token.getPrimaryKeyString()),
1718 stringTable.add(token.getDefaultSku().getStringOfVariableName(), token),
1719 token.getDefaultSku().variableOffset,
1720 token.getPrimaryKeyString());
1721 }
1722
1723 public int getTotalTokenNumber () {
1724 return sizeTable.getTableLen();
1725 }
1726
1727 public static String getPcdDatabaseCommonDefinitions ()
1728 throws EntityException {
1729
1730 String retStr = "";
1731 try {
1732 File file = new File(GlobalData.getWorkspacePath() + File.separator +
1733 "Tools" + File.separator +
1734 "Conf" + File.separator +
1735 "Pcd" + File.separator +
1736 "PcdDatabaseCommonDefinitions.sample");
1737 FileReader reader = new FileReader(file);
1738 BufferedReader in = new BufferedReader(reader);
1739 String str;
1740 while ((str = in.readLine()) != null) {
1741 retStr = retStr +"\r\n" + str;
1742 }
1743 } catch (Exception ex) {
1744 throw new EntityException("Fatal error when generating PcdDatabase Common Definitions");
1745 }
1746
1747 return retStr;
1748 }
1749
1750 public static String getPcdDxeDatabaseDefinitions ()
1751 throws EntityException {
1752
1753 String retStr = "";
1754 try {
1755 File file = new File(GlobalData.getWorkspacePath() + File.separator +
1756 "Tools" + File.separator +
1757 "Conf" + File.separator +
1758 "Pcd" + File.separator +
1759 "PcdDatabaseDxeDefinitions.sample");
1760 FileReader reader = new FileReader(file);
1761 BufferedReader in = new BufferedReader(reader);
1762 String str;
1763 while ((str = in.readLine()) != null) {
1764 retStr = retStr +"\r\n" + str;
1765 }
1766 } catch (Exception ex) {
1767 throw new EntityException("Fatal error when generating PcdDatabase Dxe Definitions");
1768 }
1769
1770 return retStr;
1771 }
1772
1773 public static String getPcdPeiDatabaseDefinitions ()
1774 throws EntityException {
1775
1776 String retStr = "";
1777 try {
1778 File file = new File(GlobalData.getWorkspacePath() + File.separator +
1779 "Tools" + File.separator +
1780 "Conf" + File.separator +
1781 "Pcd" + File.separator +
1782 "PcdDatabasePeiDefinitions.sample");
1783 FileReader reader = new FileReader(file);
1784 BufferedReader in = new BufferedReader(reader);
1785 String str;
1786 while ((str = in.readLine()) != null) {
1787 retStr = retStr +"\r\n" + str;
1788 }
1789 } catch (Exception ex) {
1790 throw new EntityException("Fatal error when generating PcdDatabase Pei Definitions");
1791 }
1792
1793 return retStr;
1794 }
1795
1796 }
1797
1798 class ModuleInfo {
1799 public ModuleSADocument.ModuleSA module;
1800 public ModuleTypeDef.Enum type;
1801
1802 public ModuleInfo (ModuleSADocument.ModuleSA module, ModuleTypeDef.Enum type) {
1803 this.module = module;
1804 this.type = type;
1805 }
1806 }
1807
1808 /** This action class is to collect PCD information from MSA, SPD, FPD xml file.
1809 This class will be used for wizard and build tools, So it can *not* inherit
1810 from buildAction or UIAction.
1811 **/
1812 public class CollectPCDAction {
1813 /// memoryDatabase hold all PCD information collected from SPD, MSA, FPD.
1814 private MemoryDatabaseManager dbManager;
1815
1816 /// Workspacepath hold the workspace information.
1817 private String workspacePath;
1818
1819 /// FPD file is the root file.
1820 private String fpdFilePath;
1821
1822 /// Message level for CollectPCDAction.
1823 private int originalMessageLevel;
1824
1825 /// Cache the fpd docment instance for private usage.
1826 private FrameworkPlatformDescriptionDocument fpdDocInstance;
1827
1828 /**
1829 Set WorkspacePath parameter for this action class.
1830
1831 @param workspacePath parameter for this action
1832 **/
1833 public void setWorkspacePath(String workspacePath) {
1834 this.workspacePath = workspacePath;
1835 }
1836
1837 /**
1838 Set action message level for CollectPcdAction tool.
1839
1840 The message should be restored when this action exit.
1841
1842 @param actionMessageLevel parameter for this action
1843 **/
1844 public void setActionMessageLevel(int actionMessageLevel) {
1845 originalMessageLevel = ActionMessage.messageLevel;
1846 ActionMessage.messageLevel = actionMessageLevel;
1847 }
1848
1849 /**
1850 Set FPDFileName parameter for this action class.
1851
1852 @param fpdFilePath fpd file path
1853 **/
1854 public void setFPDFilePath(String fpdFilePath) {
1855 this.fpdFilePath = fpdFilePath;
1856 }
1857
1858 /**
1859 Common function interface for outer.
1860
1861 @param workspacePath The path of workspace of current build or analysis.
1862 @param fpdFilePath The fpd file path of current build or analysis.
1863 @param messageLevel The message level for this Action.
1864
1865 @throws Exception The exception of this function. Because it can *not* be predict
1866 where the action class will be used. So only Exception can be throw.
1867
1868 **/
1869 public void perform(String workspacePath, String fpdFilePath,
1870 int messageLevel) throws Exception {
1871 setWorkspacePath(workspacePath);
1872 setFPDFilePath(fpdFilePath);
1873 setActionMessageLevel(messageLevel);
1874 checkParameter();
1875 execute();
1876 ActionMessage.messageLevel = originalMessageLevel;
1877 }
1878
1879 /**
1880 Core execution function for this action class.
1881
1882 This function work flows will be:
1883 1) Collect and prepocess PCD information from FPD file, all PCD
1884 information will be stored into memory database.
1885 2) Generate 3 strings for
1886 a) All modules using Dynamic(Ex) PCD entry.(Token Number)
1887 b) PEI PCDDatabase (C Structure) for PCD Service PEIM.
1888 c) DXE PCD Database (C structure) for PCD Service DXE.
1889
1890
1891 @throws EntityException Exception indicate failed to execute this action.
1892
1893 **/
1894 private void execute() throws EntityException {
1895 //
1896 // Get memoryDatabaseManager instance from GlobalData.
1897 // The memoryDatabaseManager should be initialized for whatever build
1898 // tools or wizard tools
1899 //
1900 if((dbManager = GlobalData.getPCDMemoryDBManager()) == null) {
1901 throw new EntityException("The instance of PCD memory database manager is null");
1902 }
1903
1904 //
1905 // Collect all PCD information defined in FPD file.
1906 // Evenry token defind in FPD will be created as an token into
1907 // memory database.
1908 //
1909 createTokenInDBFromFPD();
1910
1911 //
1912 // Call Private function genPcdDatabaseSourceCode (void); ComponentTypeBsDriver
1913 // 1) Generate for PEI, DXE PCD DATABASE's definition and initialization.
1914 //
1915 genPcdDatabaseSourceCode ();
1916
1917 }
1918
1919 /**
1920 This function generates source code for PCD Database.
1921
1922 @param void
1923 @throws EntityException If the token does *not* exist in memory database.
1924
1925 **/
1926 private void genPcdDatabaseSourceCode()
1927 throws EntityException {
1928 String PcdCommonHeaderString = PcdDatabase.getPcdDatabaseCommonDefinitions ();
1929
1930 ArrayList<Token> alPei = new ArrayList<Token> ();
1931 ArrayList<Token> alDxe = new ArrayList<Token> ();
1932
1933 dbManager.getTwoPhaseDynamicRecordArray(alPei, alDxe);
1934 PcdDatabase pcdPeiDatabase = new PcdDatabase (alPei, "PEI", 0);
1935 pcdPeiDatabase.genCodeNew();
1936 MemoryDatabaseManager.PcdPeimHString = PcdCommonHeaderString + pcdPeiDatabase.getHString()
1937 + PcdDatabase.getPcdPeiDatabaseDefinitions();
1938 MemoryDatabaseManager.PcdPeimCString = pcdPeiDatabase.getCString();
1939
1940 PcdDatabase pcdDxeDatabase = new PcdDatabase (alDxe,
1941 "DXE",
1942 alPei.size()
1943 );
1944 pcdDxeDatabase.genCodeNew();
1945 MemoryDatabaseManager.PcdDxeHString = MemoryDatabaseManager.PcdPeimHString + pcdDxeDatabase.getHString()
1946 + PcdDatabase.getPcdDxeDatabaseDefinitions();
1947 MemoryDatabaseManager.PcdDxeCString = pcdDxeDatabase.getCString();
1948 }
1949
1950 /**
1951 Get component array from FPD.
1952
1953 This function maybe provided by some Global class.
1954
1955 @return List<ModuleInfo> the component array.
1956
1957 */
1958 private List<ModuleInfo> getComponentsFromFPD()
1959 throws EntityException {
1960 List<ModuleInfo> allModules = new ArrayList<ModuleInfo>();
1961 ModuleInfo current = null;
1962 int index = 0;
1963 org.tianocore.Components components = null;
1964 FrameworkModulesDocument.FrameworkModules fModules = null;
1965 ModuleSADocument.ModuleSA[] modules = null;
1966 HashMap<String, XmlObject> map = new HashMap<String, XmlObject>();
1967
1968 if (fpdDocInstance == null) {
1969 try {
1970 fpdDocInstance = (FrameworkPlatformDescriptionDocument)XmlObject.Factory.parse(new File(fpdFilePath));
1971 } catch(IOException ioE) {
1972 throw new EntityException("File IO error for xml file:" + fpdFilePath + "\n" + ioE.getMessage());
1973 } catch(XmlException xmlE) {
1974 throw new EntityException("Can't parse the FPD xml fle:" + fpdFilePath + "\n" + xmlE.getMessage());
1975 }
1976
1977 }
1978
1979 map.put("FrameworkPlatformDescription", fpdDocInstance);
1980 SurfaceAreaQuery.setDoc(map);
1981 modules = SurfaceAreaQuery.getFpdModuleSAs();
1982 for (index = 0; index < modules.length; index ++) {
1983 SurfaceAreaQuery.setDoc(GlobalData.getDoc(modules[index].getModuleName()));
1984 allModules.add(new ModuleInfo(modules[index],
1985 ModuleTypeDef.Enum.forString(SurfaceAreaQuery.getModuleType())));
1986 }
1987
1988 return allModules;
1989 }
1990
1991 /**
1992 Create token instance object into memory database, the token information
1993 comes for FPD file. Normally, FPD file will contain all token platform
1994 informations.
1995
1996 @return FrameworkPlatformDescriptionDocument The FPD document instance for furture usage.
1997
1998 @throws EntityException Failed to parse FPD xml file.
1999
2000 **/
2001 private void createTokenInDBFromFPD()
2002 throws EntityException {
2003 int index = 0;
2004 int index2 = 0;
2005 int pcdIndex = 0;
2006 List<PcdBuildDefinition.PcdData> pcdBuildDataArray = new ArrayList<PcdBuildDefinition.PcdData>();
2007 PcdBuildDefinition.PcdData pcdBuildData = null;
2008 Token token = null;
2009 SkuInstance skuInstance = null;
2010 int skuIndex = 0;
2011 List<ModuleInfo> modules = null;
2012 String primaryKey = null;
2013 String exceptionString = null;
2014 UsageInstance usageInstance = null;
2015 String primaryKey1 = null;
2016 String primaryKey2 = null;
2017 boolean isDuplicate = false;
2018 Token.PCD_TYPE pcdType = Token.PCD_TYPE.UNKNOWN;
2019 Token.DATUM_TYPE datumType = Token.DATUM_TYPE.UNKNOWN;
2020 int tokenNumber = 0;
2021 String moduleName = null;
2022 String datum = null;
2023 int maxDatumSize = 0;
2024
2025 //
2026 // ----------------------------------------------
2027 // 1), Get all <ModuleSA> from FPD file.
2028 // ----------------------------------------------
2029 //
2030 modules = getComponentsFromFPD();
2031
2032 if (modules == null) {
2033 throw new EntityException("[FPD file error] No modules in FPD file, Please check whether there are elements in <FrameworkModules> in FPD file!");
2034 }
2035
2036 //
2037 // -------------------------------------------------------------------
2038 // 2), Loop all modules to process <PcdBuildDeclarations> for each module.
2039 // -------------------------------------------------------------------
2040 //
2041 for (index = 0; index < modules.size(); index ++) {
2042 isDuplicate = false;
2043 for (index2 = 0; index2 < index; index2 ++) {
2044 //
2045 // BUGBUG: For transition schema, we can *not* get module's version from
2046 // <ModuleSAs>, It is work around code.
2047 //
2048 primaryKey1 = UsageInstance.getPrimaryKey(modules.get(index).module.getModuleName(),
2049 null,
2050 null,
2051 null,
2052 modules.get(index).module.getArch().toString(),
2053 null);
2054 primaryKey2 = UsageInstance.getPrimaryKey(modules.get(index2).module.getModuleName(),
2055 null,
2056 null,
2057 null,
2058 modules.get(index2).module.getArch().toString(),
2059 null);
2060 if (primaryKey1.equalsIgnoreCase(primaryKey2)) {
2061 isDuplicate = true;
2062 break;
2063 }
2064 }
2065
2066 if (isDuplicate) {
2067 continue;
2068 }
2069
2070 //
2071 // It is legal for a module does not contains ANY pcd build definitions.
2072 //
2073 if (modules.get(index).module.getPcdBuildDefinition() == null) {
2074 continue;
2075 }
2076
2077 pcdBuildDataArray = modules.get(index).module.getPcdBuildDefinition().getPcdDataList();
2078
2079 moduleName = modules.get(index).module.getModuleName();
2080
2081 //
2082 // ----------------------------------------------------------------------
2083 // 2.1), Loop all Pcd entry for a module and add it into memory database.
2084 // ----------------------------------------------------------------------
2085 //
2086 for (pcdIndex = 0; pcdIndex < pcdBuildDataArray.size(); pcdIndex ++) {
2087 pcdBuildData = pcdBuildDataArray.get(pcdIndex);
2088 primaryKey = Token.getPrimaryKeyString(pcdBuildData.getCName(),
2089 translateSchemaStringToUUID(pcdBuildData.getTokenSpaceGuid()));
2090 pcdType = Token.getpcdTypeFromString(pcdBuildData.getItemType().toString());
2091 datumType = Token.getdatumTypeFromString(pcdBuildData.getDatumType().toString());
2092 tokenNumber = Integer.decode(pcdBuildData.getToken().toString());
2093 if (pcdBuildData.getValue() != null) {
2094 datum = pcdBuildData.getValue().toString();
2095 } else {
2096 datum = null;
2097 }
2098 maxDatumSize = pcdBuildData.getMaxDatumSize();
2099
2100 if ((pcdType == Token.PCD_TYPE.FEATURE_FLAG) &&
2101 (datumType != Token.DATUM_TYPE.BOOLEAN)){
2102 exceptionString = String.format("[FPD file error] For PCD %s in module %s, the PCD type is FEATRUE_FLAG but "+
2103 "datum type of this PCD entry is not BOOLEAN!",
2104 pcdBuildData.getCName(),
2105 moduleName);
2106 throw new EntityException(exceptionString);
2107 }
2108
2109 //
2110 // Check <TokenSpaceGuid> is exist? In future, because all schema verification will tools
2111 // will check that, following checking code could be removed.
2112 //
2113 if (pcdBuildData.getTokenSpaceGuid() == null) {
2114 exceptionString = String.format("[FPD file error] There is no <TokenSpaceGuid> for PCD %s in module %s! This is required!",
2115 pcdBuildData.getCName(),
2116 moduleName);
2117 throw new EntityException(exceptionString);
2118 }
2119
2120 //
2121 // -------------------------------------------------------------------------------------------
2122 // 2.1.1), Do some necessary checking work for FixedAtBuild, FeatureFlag and PatchableInModule
2123 // -------------------------------------------------------------------------------------------
2124 //
2125 if (!Token.isDynamic(pcdType)) {
2126 //
2127 // Value is required.
2128 //
2129 if (datum == null) {
2130 exceptionString = String.format("[FPD file error] There is no value for PCD entry %s in module %s!",
2131 pcdBuildData.getCName(),
2132 moduleName);
2133 throw new EntityException(exceptionString);
2134 }
2135
2136 //
2137 // Check whether the datum size is matched datum type.
2138 //
2139 if ((exceptionString = verifyDatum(pcdBuildData.getCName(),
2140 moduleName,
2141 datum,
2142 datumType,
2143 maxDatumSize)) != null) {
2144 throw new EntityException(exceptionString);
2145 }
2146 }
2147
2148 //
2149 // ---------------------------------------------------------------------------------
2150 // 2.1.2), Create token or update token information for current anaylized PCD data.
2151 // ---------------------------------------------------------------------------------
2152 //
2153 if (dbManager.isTokenInDatabase(primaryKey)) {
2154 //
2155 // If the token is already exist in database, do some necessary checking
2156 // and add a usage instance into this token in database
2157 //
2158 token = dbManager.getTokenByKey(primaryKey);
2159
2160 //
2161 // checking for DatumType, DatumType should be unique for one PCD used in different
2162 // modules.
2163 //
2164 if (token.datumType != datumType) {
2165 exceptionString = String.format("[FPD file error] The datum type of PCD entry %s is %s, which is different with %s defined in before!",
2166 pcdBuildData.getCName(),
2167 pcdBuildData.getDatumType().toString(),
2168 Token.getStringOfdatumType(token.datumType));
2169 throw new EntityException(exceptionString);
2170 }
2171
2172 //
2173 // Check token number is valid
2174 //
2175 if (tokenNumber != token.tokenNumber) {
2176 exceptionString = String.format("[FPD file error] The token number of PCD entry %s in module %s is different with same PCD entry in other modules!",
2177 pcdBuildData.getCName(),
2178 moduleName);
2179 throw new EntityException(exceptionString);
2180 }
2181
2182 //
2183 // For same PCD used in different modules, the PCD type should all be dynamic or non-dynamic.
2184 //
2185 if (token.isDynamicPCD != Token.isDynamic(pcdType)) {
2186 exceptionString = String.format("[FPD file error] For PCD entry %s in module %s, you define dynamic or non-dynamic PCD type which"+
2187 "is different with others module's",
2188 token.cName,
2189 moduleName);
2190 throw new EntityException(exceptionString);
2191 }
2192
2193 if (token.isDynamicPCD) {
2194 //
2195 // Check datum is equal the datum in dynamic information.
2196 // For dynamic PCD, you can do not write <Value> in sperated every <PcdBuildDefinition> in different <ModuleSA>,
2197 // But if you write, the <Value> must be same as the value in <DynamicPcdBuildDefinitions>.
2198 //
2199 if (!token.isSkuEnable() &&
2200 (token.getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.DEFAULT_TYPE) &&
2201 (datum != null)) {
2202 if (!datum.equalsIgnoreCase(token.getDefaultSku().value)) {
2203 exceptionString = String.format("[FPD file error] For dynamic PCD %s in module %s, the datum in <ModuleSA> is "+
2204 "not equal to the datum in <DynamicPcdBuildDefinitions>, it is "+
2205 "illega! You could no set <Value> in <ModuleSA> for a dynamic PCD!",
2206 token.cName,
2207 moduleName);
2208 throw new EntityException(exceptionString);
2209 }
2210 }
2211
2212 if ((maxDatumSize != 0) &&
2213 (maxDatumSize != token.datumSize)){
2214 exceptionString = String.format("[FPD file error] For dynamic PCD %s in module %s, the max datum size is %d which "+
2215 "is different with <MaxDatumSize> %d defined in <DynamicPcdBuildDefinitions>!",
2216 token.cName,
2217 moduleName,
2218 maxDatumSize,
2219 token.datumSize);
2220 throw new EntityException(exceptionString);
2221 }
2222 }
2223
2224 } else {
2225 //
2226 // If the token is not in database, create a new token instance and add
2227 // a usage instance into this token in database.
2228 //
2229 token = new Token(pcdBuildData.getCName(),
2230 translateSchemaStringToUUID(pcdBuildData.getTokenSpaceGuid()));
2231
2232 token.datumType = datumType;
2233 token.tokenNumber = tokenNumber;
2234 token.isDynamicPCD = Token.isDynamic(pcdType);
2235 token.datumSize = maxDatumSize;
2236
2237 if (token.isDynamicPCD) {
2238 //
2239 // For Dynamic and Dynamic Ex type, need find the dynamic information
2240 // in <DynamicPcdBuildDefinition> section in FPD file.
2241 //
2242 updateDynamicInformation(moduleName,
2243 token,
2244 datum,
2245 maxDatumSize);
2246 }
2247
2248 dbManager.addTokenToDatabase(primaryKey, token);
2249 }
2250
2251 //
2252 // -----------------------------------------------------------------------------------
2253 // 2.1.3), Add the PcdType in current module into this Pcd token's supported PCD type.
2254 // -----------------------------------------------------------------------------------
2255 //
2256 token.updateSupportPcdType(pcdType);
2257
2258 //
2259 // ------------------------------------------------
2260 // 2.1.4), Create an usage instance for this token.
2261 // ------------------------------------------------
2262 //
2263 usageInstance = new UsageInstance(token,
2264 moduleName,
2265 null,
2266 null,
2267 null,
2268 modules.get(index).type,
2269 pcdType,
2270 modules.get(index).module.getArch().toString(),
2271 null,
2272 datum,
2273 maxDatumSize);
2274 token.addUsageInstance(usageInstance);
2275 }
2276 }
2277 }
2278
2279 /**
2280 Verify the datum value according its datum size and datum type, this
2281 function maybe moved to FPD verification tools in future.
2282
2283 @param cName
2284 @param moduleName
2285 @param datum
2286 @param datumType
2287 @param maxDatumSize
2288
2289 @return String
2290 */
2291 /***/
2292 public String verifyDatum(String cName,
2293 String moduleName,
2294 String datum,
2295 Token.DATUM_TYPE datumType,
2296 int maxDatumSize) {
2297 String exceptionString = null;
2298 int value;
2299 BigInteger value64;
2300 String subStr;
2301 int index;
2302
2303 if (moduleName == null) {
2304 moduleName = "section <DynamicPcdBuildDefinitions>";
2305 } else {
2306 moduleName = "module " + moduleName;
2307 }
2308
2309 if (maxDatumSize == 0) {
2310 exceptionString = String.format("[FPD file error] You maybe miss <MaxDatumSize> for PCD %s in %s",
2311 cName,
2312 moduleName);
2313 return exceptionString;
2314 }
2315
2316 switch (datumType) {
2317 case UINT8:
2318 if (maxDatumSize != 1) {
2319 exceptionString = String.format("[FPD file error] The datum type of PCD data %s in %s "+
2320 "is UINT8, but datum size is %d, they are not matched!",
2321 cName,
2322 moduleName,
2323 maxDatumSize);
2324 return exceptionString;
2325 }
2326
2327 if (datum != null) {
2328 try {
2329 value = Integer.decode(datum);
2330 } catch (NumberFormatException nfeExp) {
2331 exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is not valid "+
2332 "digital format of UINT8",
2333 cName,
2334 moduleName);
2335 return exceptionString;
2336 }
2337 if (value > 0xFF) {
2338 exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is %s exceed"+
2339 " the max size of UINT8 - 0xFF",
2340 cName,
2341 moduleName,
2342 datum);
2343 return exceptionString;
2344 }
2345 }
2346 break;
2347 case UINT16:
2348 if (maxDatumSize != 2) {
2349 exceptionString = String.format("[FPD file error] The datum type of PCD data %s in %s "+
2350 "is UINT16, but datum size is %d, they are not matched!",
2351 cName,
2352 moduleName,
2353 maxDatumSize);
2354 return exceptionString;
2355 }
2356 if (datum != null) {
2357 try {
2358 value = Integer.decode(datum);
2359 } catch (NumberFormatException nfeExp) {
2360 exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is "+
2361 "not valid digital of UINT16",
2362 cName,
2363 moduleName);
2364 return exceptionString;
2365 }
2366 if (value > 0xFFFF) {
2367 exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is %s "+
2368 "which exceed the range of UINT16 - 0xFFFF",
2369 cName,
2370 moduleName,
2371 datum);
2372 return exceptionString;
2373 }
2374 }
2375 break;
2376 case UINT32:
2377 if (maxDatumSize != 4) {
2378 exceptionString = String.format("[FPD file error] The datum type of PCD data %s in %s "+
2379 "is UINT32, but datum size is %d, they are not matched!",
2380 cName,
2381 moduleName,
2382 maxDatumSize);
2383 return exceptionString;
2384 }
2385
2386 if (datum != null) {
2387 try {
2388 if (datum.length() > 2) {
2389 if ((datum.charAt(0) == '0') &&
2390 ((datum.charAt(1) == 'x') || (datum.charAt(1) == 'X'))){
2391 subStr = datum.substring(2, datum.length());
2392 value64 = new BigInteger(subStr, 16);
2393 } else {
2394 value64 = new BigInteger(datum);
2395 }
2396 } else {
2397 value64 = new BigInteger(datum);
2398 }
2399 } catch (NumberFormatException nfeExp) {
2400 exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is not "+
2401 "valid digital of UINT32",
2402 cName,
2403 moduleName);
2404 return exceptionString;
2405 }
2406
2407 if (value64.bitLength() > 32) {
2408 exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is %s which "+
2409 "exceed the range of UINT32 - 0xFFFFFFFF",
2410 cName,
2411 moduleName,
2412 datum);
2413 return exceptionString;
2414 }
2415 }
2416 break;
2417 case UINT64:
2418 if (maxDatumSize != 8) {
2419 exceptionString = String.format("[FPD file error] The datum type of PCD data %s in %s "+
2420 "is UINT64, but datum size is %d, they are not matched!",
2421 cName,
2422 moduleName,
2423 maxDatumSize);
2424 return exceptionString;
2425 }
2426
2427 if (datum != null) {
2428 try {
2429 if (datum.length() > 2) {
2430 if ((datum.charAt(0) == '0') &&
2431 ((datum.charAt(1) == 'x') || (datum.charAt(1) == 'X'))){
2432 subStr = datum.substring(2, datum.length());
2433 value64 = new BigInteger(subStr, 16);
2434 } else {
2435 value64 = new BigInteger(datum);
2436 }
2437 } else {
2438 value64 = new BigInteger(datum);
2439 }
2440 } catch (NumberFormatException nfeExp) {
2441 exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is not valid"+
2442 " digital of UINT64",
2443 cName,
2444 moduleName);
2445 return exceptionString;
2446 }
2447
2448 if (value64.bitLength() > 64) {
2449 exceptionString = String.format("[FPD file error] The datum for PCD %s in %s is %s "+
2450 "exceed the range of UINT64 - 0xFFFFFFFFFFFFFFFF",
2451 cName,
2452 moduleName,
2453 datum);
2454 return exceptionString;
2455 }
2456 }
2457 break;
2458 case BOOLEAN:
2459 if (maxDatumSize != 1) {
2460 exceptionString = String.format("[FPD file error] The datum type of PCD data %s in %s "+
2461 "is BOOLEAN, but datum size is %d, they are not matched!",
2462 cName,
2463 moduleName,
2464 maxDatumSize);
2465 return exceptionString;
2466 }
2467
2468 if (datum != null) {
2469 if (!(datum.equalsIgnoreCase("TRUE") ||
2470 datum.equalsIgnoreCase("FALSE"))) {
2471 exceptionString = String.format("[FPD file error] The datum type of PCD data %s in %s "+
2472 "is BOOELAN, but value is not 'true'/'TRUE' or 'FALSE'/'false'",
2473 cName,
2474 moduleName);
2475 return exceptionString;
2476 }
2477
2478 }
2479 break;
2480 case POINTER:
2481 if (datum == null) {
2482 break;
2483 }
2484
2485 char ch = datum.charAt(0);
2486 int start, end;
2487 String strValue;
2488 //
2489 // For void* type PCD, only three datum is support:
2490 // 1) Unicode: string with start char is "L"
2491 // 2) Ansci: String start char is ""
2492 // 3) byte array: String start char "{"
2493 //
2494 if (ch == 'L') {
2495 start = datum.indexOf('\"');
2496 end = datum.lastIndexOf('\"');
2497 if ((start > end) ||
2498 (end > datum.length())||
2499 ((start == end) && (datum.length() > 0))) {
2500 exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID* and datum is "+
2501 "a UNICODE string because start with L\", but format maybe"+
2502 "is not right, correct UNICODE string is L\"...\"!",
2503 cName,
2504 moduleName);
2505 return exceptionString;
2506 }
2507
2508 strValue = datum.substring(start + 1, end);
2509 if ((strValue.length() * 2) > maxDatumSize) {
2510 exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID*, and datum is "+
2511 "a UNICODE string, but the datum size is %d exceed to <MaxDatumSize> : %d",
2512 cName,
2513 moduleName,
2514 strValue.length() * 2,
2515 maxDatumSize);
2516 return exceptionString;
2517 }
2518 } else if (ch == '\"'){
2519 start = datum.indexOf('\"');
2520 end = datum.lastIndexOf('\"');
2521 if ((start > end) ||
2522 (end > datum.length())||
2523 ((start == end) && (datum.length() > 0))) {
2524 exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID* and datum is "+
2525 "a ANSCII string because start with \", but format maybe"+
2526 "is not right, correct ANSIC string is \"...\"!",
2527 cName,
2528 moduleName);
2529 return exceptionString;
2530 }
2531 strValue = datum.substring(start + 1, end);
2532 if ((strValue.length()) > maxDatumSize) {
2533 exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID*, and datum is "+
2534 "a ANSCI string, but the datum size is %d which exceed to <MaxDatumSize> : %d",
2535 cName,
2536 moduleName,
2537 strValue.length(),
2538 maxDatumSize);
2539 return exceptionString;
2540 }
2541 } else if (ch =='{') {
2542 String[] strValueArray;
2543
2544 start = datum.indexOf('{');
2545 end = datum.lastIndexOf('}');
2546 strValue = datum.substring(start + 1, end);
2547 strValue = strValue.trim();
2548 if (strValue.length() == 0) {
2549 break;
2550 }
2551 strValueArray = strValue.split(",");
2552 for (index = 0; index < strValueArray.length; index ++) {
2553 try{
2554 value = Integer.decode(strValueArray[index].trim());
2555 } catch (NumberFormatException nfeEx) {
2556 exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID*, and "+
2557 "it is byte array in fact. For every byte in array should be a valid"+
2558 "byte digital, but element %s is not a valid byte digital!",
2559 cName,
2560 moduleName,
2561 strValueArray[index]);
2562 return exceptionString;
2563 }
2564 if (value > 0xFF) {
2565 exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID*, "+
2566 "it is byte array in fact. But the element of %s exceed the byte range",
2567 cName,
2568 moduleName,
2569 strValueArray[index]);
2570 return exceptionString;
2571 }
2572 }
2573
2574 if (strValueArray.length > maxDatumSize) {
2575 exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID*, and datum is byte"+
2576 "array, but the number of bytes is %d which exceed to <MaxDatumSzie> : %d!",
2577 cName,
2578 moduleName,
2579 strValueArray.length,
2580 maxDatumSize);
2581 return exceptionString;
2582 }
2583 } else {
2584 exceptionString = String.format("[FPD file error] The datum type of PCD %s in %s is VOID*. For VOID* type, you have three format choise:\n "+
2585 "1) UNICODE string: like L\"xxxx\";\r\n"+
2586 "2) ANSIC string: like \"xxx\";\r\n"+
2587 "3) Byte array: like {0x2, 0x45, 0x23}\r\n"+
2588 "But the datum in seems does not following above format!",
2589 cName,
2590 moduleName);
2591 return exceptionString;
2592 }
2593 break;
2594 default:
2595 exceptionString = String.format("[FPD file error] For PCD entry %s in %s, datum type is unknown, it should be one of "+
2596 "UINT8, UINT16, UINT32, UINT64, VOID*, BOOLEAN",
2597 cName,
2598 moduleName);
2599 return exceptionString;
2600 }
2601 return null;
2602 }
2603
2604 /**
2605 Get dynamic information for a dynamic PCD from <DynamicPcdBuildDefinition> seciton in FPD file.
2606
2607 This function should be implemented in GlobalData in future.
2608
2609 @param token The token instance which has hold module's PCD information
2610 @param moduleName The name of module who will use this Dynamic PCD.
2611
2612 @return DynamicPcdBuildDefinitions.PcdBuildData
2613 */
2614 /***/
2615 private DynamicPcdBuildDefinitions.PcdBuildData getDynamicInfoFromFPD(Token token,
2616 String moduleName)
2617 throws EntityException {
2618 int index = 0;
2619 String exceptionString = null;
2620 String dynamicPrimaryKey = null;
2621 DynamicPcdBuildDefinitions dynamicPcdBuildDefinitions = null;
2622 List<DynamicPcdBuildDefinitions.PcdBuildData> dynamicPcdBuildDataArray = null;
2623
2624 //
2625 // If FPD document is not be opened, open and initialize it.
2626 //
2627 if (fpdDocInstance == null) {
2628 try {
2629 fpdDocInstance = (FrameworkPlatformDescriptionDocument)XmlObject.Factory.parse(new File(fpdFilePath));
2630 } catch(IOException ioE) {
2631 throw new EntityException("File IO error for xml file:" + fpdFilePath + "\n" + ioE.getMessage());
2632 } catch(XmlException xmlE) {
2633 throw new EntityException("Can't parse the FPD xml fle:" + fpdFilePath + "\n" + xmlE.getMessage());
2634 }
2635 }
2636
2637 dynamicPcdBuildDefinitions = fpdDocInstance.getFrameworkPlatformDescription().getDynamicPcdBuildDefinitions();
2638 if (dynamicPcdBuildDefinitions == null) {
2639 exceptionString = String.format("[FPD file error] There are no <PcdDynamicBuildDescriptions> in FPD file but contains Dynamic type "+
2640 "PCD entry %s in module %s!",
2641 token.cName,
2642 moduleName);
2643 throw new EntityException(exceptionString);
2644 }
2645
2646 dynamicPcdBuildDataArray = dynamicPcdBuildDefinitions.getPcdBuildDataList();
2647 for (index = 0; index < dynamicPcdBuildDataArray.size(); index ++) {
2648 //
2649 // Check <TokenSpaceGuid> is exist? In future, because all schema verification will tools
2650 // will check that, following checking code could be removed.
2651 //
2652 if (dynamicPcdBuildDataArray.get(index).getTokenSpaceGuid() == null) {
2653 exceptionString = String.format("[FPD file error] There is no <TokenSpaceGuid> for PCD %s in <DynamicPcdBuildDefinitions>! This is required!",
2654 dynamicPcdBuildDataArray.get(index).getCName());
2655 throw new EntityException(exceptionString);
2656 }
2657
2658 dynamicPrimaryKey = Token.getPrimaryKeyString(dynamicPcdBuildDataArray.get(index).getCName(),
2659 translateSchemaStringToUUID(dynamicPcdBuildDataArray.get(index).getTokenSpaceGuid()));
2660 if (dynamicPrimaryKey.equalsIgnoreCase(token.getPrimaryKeyString())) {
2661 return dynamicPcdBuildDataArray.get(index);
2662 }
2663 }
2664
2665 return null;
2666 }
2667
2668 /**
2669 Update dynamic information for PCD entry.
2670
2671 Dynamic information is retrieved from <PcdDynamicBuildDeclarations> in
2672 FPD file.
2673
2674 @param moduleName The name of the module who use this PCD
2675 @param token The token instance
2676 @param datum The <datum> in module's PCD information
2677 @param maxDatumSize The <maxDatumSize> in module's PCD information
2678
2679 @return Token
2680 */
2681 private Token updateDynamicInformation(String moduleName,
2682 Token token,
2683 String datum,
2684 int maxDatumSize)
2685 throws EntityException {
2686 int index = 0;
2687 int offset;
2688 String exceptionString = null;
2689 DynamicTokenValue dynamicValue;
2690 SkuInstance skuInstance = null;
2691 String temp;
2692 boolean hasSkuId0 = false;
2693 Token.PCD_TYPE pcdType = Token.PCD_TYPE.UNKNOWN;
2694 int tokenNumber = 0;
2695 String hiiDefaultValue = null;
2696 String[] variableGuidString = null;
2697
2698 List<DynamicPcdBuildDefinitions.PcdBuildData.SkuInfo> skuInfoList = null;
2699 DynamicPcdBuildDefinitions.PcdBuildData dynamicInfo = null;
2700
2701 dynamicInfo = getDynamicInfoFromFPD(token, moduleName);
2702 if (dynamicInfo == null) {
2703 exceptionString = String.format("[FPD file error] For Dynamic PCD %s used by module %s, "+
2704 "there is no dynamic information in <DynamicPcdBuildDefinitions> "+
2705 "in FPD file, but it is required!",
2706 token.cName,
2707 moduleName);
2708 throw new EntityException(exceptionString);
2709 }
2710
2711 token.datumSize = dynamicInfo.getMaxDatumSize();
2712
2713 exceptionString = verifyDatum(token.cName,
2714 moduleName,
2715 null,
2716 token.datumType,
2717 token.datumSize);
2718 if (exceptionString != null) {
2719 throw new EntityException(exceptionString);
2720 }
2721
2722 if ((maxDatumSize != 0) &&
2723 (maxDatumSize != token.datumSize)) {
2724 exceptionString = String.format("FPD file error] For dynamic PCD %s, the datum size in module %s is %d, but "+
2725 "the datum size in <DynamicPcdBuildDefinitions> is %d, they are not match!",
2726 token.cName,
2727 moduleName,
2728 maxDatumSize,
2729 dynamicInfo.getMaxDatumSize());
2730 throw new EntityException(exceptionString);
2731 }
2732 tokenNumber = Integer.decode(dynamicInfo.getToken().toString());
2733 if (tokenNumber != token.tokenNumber) {
2734 exceptionString = String.format("[FPD file error] For dynamic PCD %s, the token number in module %s is 0x%x, but"+
2735 "in <DynamicPcdBuildDefinictions>, the token number is 0x%x, they are not match!",
2736 token.cName,
2737 moduleName,
2738 token.tokenNumber,
2739 tokenNumber);
2740 throw new EntityException(exceptionString);
2741 }
2742
2743 pcdType = Token.getpcdTypeFromString(dynamicInfo.getItemType().toString());
2744 if (pcdType == Token.PCD_TYPE.DYNAMIC_EX) {
2745 token.dynamicExTokenNumber = tokenNumber;
2746 }
2747
2748 skuInfoList = dynamicInfo.getSkuInfoList();
2749
2750 //
2751 // Loop all sku data
2752 //
2753 for (index = 0; index < skuInfoList.size(); index ++) {
2754 skuInstance = new SkuInstance();
2755 //
2756 // Although SkuId in schema is BigInteger, but in fact, sku id is 32 bit value.
2757 //
2758 temp = skuInfoList.get(index).getSkuId().toString();
2759 skuInstance.id = Integer.decode(temp);
2760 if (skuInstance.id == 0) {
2761 hasSkuId0 = true;
2762 }
2763 //
2764 // Judge whether is DefaultGroup at first, because most case is DefautlGroup.
2765 //
2766 if (skuInfoList.get(index).getValue() != null) {
2767 skuInstance.value.setValue(skuInfoList.get(index).getValue().toString());
2768 if ((exceptionString = verifyDatum(token.cName,
2769 null,
2770 skuInfoList.get(index).getValue().toString(),
2771 token.datumType,
2772 token.datumSize)) != null) {
2773 throw new EntityException(exceptionString);
2774 }
2775
2776 token.skuData.add(skuInstance);
2777
2778 //
2779 // Judege wether is same of datum between module's information
2780 // and dynamic information.
2781 //
2782 if (datum != null) {
2783 if ((skuInstance.id == 0) &&
2784 !datum.toString().equalsIgnoreCase(skuInfoList.get(index).getValue().toString())) {
2785 exceptionString = "[FPD file error] For dynamic PCD " + token.cName + ", the value in module " + moduleName + " is " + datum.toString() + " but the "+
2786 "value of sku 0 data in <DynamicPcdBuildDefinition> is " + skuInstance.value.value + ". They are must be same!"+
2787 " or you could not define value for a dynamic PCD in every <ModuleSA>!";
2788 throw new EntityException(exceptionString);
2789 }
2790 }
2791 continue;
2792 }
2793
2794 //
2795 // Judge whether is HII group case.
2796 //
2797 if (skuInfoList.get(index).getVariableName() != null) {
2798 exceptionString = null;
2799 if (skuInfoList.get(index).getVariableGuid() == null) {
2800 exceptionString = String.format("[FPD file error] For dynamic PCD %s in <DynamicPcdBuildDefinitions> section in FPD "+
2801 "file, who use HII, but there is no <VariableGuid> defined for Sku %d data!",
2802 token.cName,
2803 index);
2804 if (exceptionString != null) {
2805 throw new EntityException(exceptionString);
2806 }
2807 }
2808
2809 if (skuInfoList.get(index).getVariableOffset() == null) {
2810 exceptionString = String.format("[FPD file error] For dynamic PCD %s in <DynamicPcdBuildDefinitions> section in FPD "+
2811 "file, who use HII, but there is no <VariableOffset> defined for Sku %d data!",
2812 token.cName,
2813 index);
2814 if (exceptionString != null) {
2815 throw new EntityException(exceptionString);
2816 }
2817 }
2818
2819 if (skuInfoList.get(index).getHiiDefaultValue() == null) {
2820 exceptionString = String.format("[FPD file error] For dynamic PCD %s in <DynamicPcdBuildDefinitions> section in FPD "+
2821 "file, who use HII, but there is no <HiiDefaultValue> defined for Sku %d data!",
2822 token.cName,
2823 index);
2824 if (exceptionString != null) {
2825 throw new EntityException(exceptionString);
2826 }
2827 }
2828
2829 if (skuInfoList.get(index).getHiiDefaultValue() != null) {
2830 hiiDefaultValue = skuInfoList.get(index).getHiiDefaultValue().toString();
2831 } else {
2832 hiiDefaultValue = null;
2833 }
2834
2835 if ((exceptionString = verifyDatum(token.cName,
2836 null,
2837 hiiDefaultValue,
2838 token.datumType,
2839 token.datumSize)) != null) {
2840 throw new EntityException(exceptionString);
2841 }
2842
2843 offset = Integer.decode(skuInfoList.get(index).getVariableOffset());
2844 if (offset > 0xFFFF) {
2845 throw new EntityException(String.format("[FPD file error] For dynamic PCD %s , the variable offset defined in sku %d data "+
2846 "exceed 64K, it is not allowed!",
2847 token.cName,
2848 index));
2849 }
2850
2851 //
2852 // Get variable guid string according to the name of guid which will be mapped into a GUID in SPD file.
2853 //
2854 variableGuidString = GlobalData.getGuidInfoGuid(skuInfoList.get(index).getVariableGuid().toString());
2855 if (variableGuidString == null) {
2856 throw new EntityException(String.format("[GUID Error] For dynamic PCD %s, the variable guid %s can be found in all SPD file!",
2857 token.cName,
2858 skuInfoList.get(index).getVariableGuid().toString()));
2859 }
2860
2861 skuInstance.value.setHiiData(skuInfoList.get(index).getVariableName(),
2862 translateSchemaStringToUUID(variableGuidString[1]),
2863 skuInfoList.get(index).getVariableOffset(),
2864 skuInfoList.get(index).getHiiDefaultValue().toString());
2865 token.skuData.add(skuInstance);
2866 continue;
2867 }
2868
2869 if (skuInfoList.get(index).getVpdOffset() != null) {
2870 skuInstance.value.setVpdData(skuInfoList.get(index).getVpdOffset());
2871 token.skuData.add(skuInstance);
2872 continue;
2873 }
2874
2875 exceptionString = String.format("[FPD file error] For dynamic PCD %s, the dynamic info must "+
2876 "be one of 'DefaultGroup', 'HIIGroup', 'VpdGroup'.",
2877 token.cName);
2878 throw new EntityException(exceptionString);
2879 }
2880
2881 if (!hasSkuId0) {
2882 exceptionString = String.format("[FPD file error] For dynamic PCD %s in <DynamicPcdBuildDefinitions>, there are "+
2883 "no sku id = 0 data, which is required for every dynamic PCD",
2884 token.cName);
2885 throw new EntityException(exceptionString);
2886 }
2887
2888 return token;
2889 }
2890
2891 /**
2892 Translate the schema string to UUID instance.
2893
2894 In schema, the string of UUID is defined as following two types string:
2895 1) GuidArrayType: pattern = 0x[a-fA-F0-9]{1,8},( )*0x[a-fA-F0-9]{1,4},(
2896 )*0x[a-fA-F0-9]{1,4}(,( )*\{)?(,?( )*0x[a-fA-F0-9]{1,2}){8}( )*(\})?
2897
2898 2) GuidNamingConvention: pattern =
2899 [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
2900
2901 This function will convert string and create uuid instance.
2902
2903 @param uuidString UUID string in XML file
2904
2905 @return UUID UUID instance
2906 **/
2907 private UUID translateSchemaStringToUUID(String uuidString)
2908 throws EntityException {
2909 String temp;
2910 String[] splitStringArray;
2911 int index;
2912 int chIndex;
2913 int chLen;
2914
2915 if (uuidString == null) {
2916 return null;
2917 }
2918
2919 if (uuidString.length() == 0) {
2920 return null;
2921 }
2922
2923 if (uuidString.equals("0") ||
2924 uuidString.equalsIgnoreCase("0x0")) {
2925 return new UUID(0, 0);
2926 }
2927
2928 uuidString = uuidString.replaceAll("\\{", "");
2929 uuidString = uuidString.replaceAll("\\}", "");
2930
2931 //
2932 // If the UUID schema string is GuidArrayType type then need translate
2933 // to GuidNamingConvention type at first.
2934 //
2935 if ((uuidString.charAt(0) == '0') && ((uuidString.charAt(1) == 'x') || (uuidString.charAt(1) == 'X'))) {
2936 splitStringArray = uuidString.split("," );
2937 if (splitStringArray.length != 11) {
2938 throw new EntityException ("[FPD file error] Wrong format for UUID string: " + uuidString);
2939 }
2940
2941 //
2942 // Remove blank space from these string and remove header string "0x"
2943 //
2944 for (index = 0; index < 11; index ++) {
2945 splitStringArray[index] = splitStringArray[index].trim();
2946 splitStringArray[index] = splitStringArray[index].substring(2, splitStringArray[index].length());
2947 }
2948
2949 //
2950 // Add heading '0' to normalize the string length
2951 //
2952 for (index = 3; index < 11; index ++) {
2953 chLen = splitStringArray[index].length();
2954 for (chIndex = 0; chIndex < 2 - chLen; chIndex ++) {
2955 splitStringArray[index] = "0" + splitStringArray[index];
2956 }
2957 }
2958
2959 //
2960 // construct the final GuidNamingConvention string
2961 //
2962 temp = String.format("%s-%s-%s-%s%s-%s%s%s%s%s%s",
2963 splitStringArray[0],
2964 splitStringArray[1],
2965 splitStringArray[2],
2966 splitStringArray[3],
2967 splitStringArray[4],
2968 splitStringArray[5],
2969 splitStringArray[6],
2970 splitStringArray[7],
2971 splitStringArray[8],
2972 splitStringArray[9],
2973 splitStringArray[10]);
2974 uuidString = temp;
2975 }
2976
2977 return UUID.fromString(uuidString);
2978 }
2979
2980 /**
2981 check parameter for this action.
2982
2983 @throws EntityException Bad parameter.
2984 **/
2985 private void checkParameter() throws EntityException {
2986 File file = null;
2987
2988 if((fpdFilePath == null) ||(workspacePath == null)) {
2989 throw new EntityException("WorkspacePath and FPDFileName should be blank for CollectPCDAtion!");
2990 }
2991
2992 if(fpdFilePath.length() == 0 || workspacePath.length() == 0) {
2993 throw new EntityException("WorkspacePath and FPDFileName should be blank for CollectPCDAtion!");
2994 }
2995
2996 file = new File(workspacePath);
2997 if(!file.exists()) {
2998 throw new EntityException("WorkpacePath " + workspacePath + " does not exist!");
2999 }
3000
3001 file = new File(fpdFilePath);
3002
3003 if(!file.exists()) {
3004 throw new EntityException("FPD File " + fpdFilePath + " does not exist!");
3005 }
3006 }
3007
3008 /**
3009 Test case function
3010
3011 @param argv parameter from command line
3012 **/
3013 public static void main(String argv[]) throws EntityException {
3014 CollectPCDAction ca = new CollectPCDAction();
3015 ca.setWorkspacePath("m:/tianocore/edk2");
3016 ca.setFPDFilePath("m:/tianocore/edk2/EdkNt32Pkg/Nt32.fpd");
3017 ca.setActionMessageLevel(ActionMessage.MAX_MESSAGE_LEVEL);
3018 GlobalData.initInfo("Tools" + File.separator + "Conf" + File.separator + "FrameworkDatabase.db",
3019 "m:/tianocore/edk2");
3020 ca.execute();
3021 }
3022 }
EFI Development Kit II mirror for PVE