]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /** @file\r |
2 | File is FfsProcess class which is used to get the corresponding FFS layout\r | |
3 | information for driver module. \r | |
4 | \r | |
5 | Copyright (c) 2006, Intel Corporation\r | |
6 | All rights reserved. This program and the accompanying materials\r | |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | **/\r | |
14 | package org.tianocore.build;\r | |
15 | \r | |
16 | import java.io.File;\r | |
878ddf1f | 17 | import java.util.Vector;\r |
18 | \r | |
19 | import javax.xml.namespace.QName;\r | |
878ddf1f | 20 | \r |
21 | import org.apache.tools.ant.BuildException;\r | |
22 | import org.apache.tools.ant.Project;\r | |
23 | import org.apache.xmlbeans.XmlCursor;\r | |
a29c47e0 | 24 | import org.tianocore.BuildOptionsDocument;\r |
25 | import org.tianocore.build.global.GlobalData;\r | |
26 | import org.tianocore.build.global.SurfaceAreaQuery;\r | |
27 | import org.tianocore.build.id.FpdModuleIdentification;\r | |
4a6a5026 | 28 | import org.tianocore.common.definitions.EdkDefinitions;\r |
91f7d582 | 29 | import org.tianocore.common.logger.EdkLog;\r |
878ddf1f | 30 | import org.w3c.dom.Document;\r |
31 | import org.w3c.dom.Element;\r | |
878ddf1f | 32 | \r |
33 | /** \r | |
34 | <p><code>FfsProcess</code> is a class to find the corresponding FFS layout. </p>\r | |
35 | \r | |
4b5f5549 | 36 | <p>The FFS Layout is like following: </p>\r |
878ddf1f | 37 | \r |
38 | <pre>\r | |
39 | <Ffs type="APPLICATION">\r | |
40 | <Attribute Name="FFS_FILETYPE" Value="EFI_FV_FILETYPE_APPLICATION" />\r | |
41 | <Attribute Name="FFS_ATTRIB_CHECKSUM" Value="TRUE" />\r | |
42 | <Sections EncapsulationType="Compress">\r | |
43 | <Sections EncapsulationType="Guid-Defined">\r | |
44 | <Section SectionType="EFI_SECTION_PE32" /> \r | |
45 | <Section SectionType="EFI_SECTION_USER_INTERFACE" />\r | |
46 | <Section SectionType="EFI_SECTION_VERSION" /> \r | |
47 | </Sections>\r | |
48 | </Sections>\r | |
49 | </Ffs>\r | |
50 | </pre>\r | |
51 | \r | |
52 | @since GenBuild 1.0\r | |
53 | **/\r | |
54 | public class FfsProcess {\r | |
55 | \r | |
a29c47e0 | 56 | private BuildOptionsDocument.BuildOptions.Ffs ffsXmlObject;\r |
878ddf1f | 57 | \r |
58 | ///\r | |
59 | /// ANT script to call GenFfs\r | |
60 | ///\r | |
61 | private Element ffsNode = null;\r | |
62 | \r | |
63 | ///\r | |
64 | /// Module base name\r | |
65 | ///\r | |
66 | private String basename;\r | |
67 | \r | |
68 | ///\r | |
69 | /// Sections type: normal\r | |
70 | ///\r | |
71 | private static int MODE_NONE = 0;\r | |
72 | \r | |
73 | ///\r | |
74 | /// Sections type: compress\r | |
75 | ///\r | |
76 | private static int MODE_COMPRESS = 1;\r | |
77 | \r | |
78 | ///\r | |
79 | /// Sections type: guid-define\r | |
80 | ///\r | |
81 | private static int MODE_GUID_DEFINED = 2;\r | |
82 | \r | |
83 | ///\r | |
84 | /// mapping from section type to section output file extension\r | |
85 | ///\r | |
4a6a5026 | 86 | public static final String[][] sectionExt = EdkDefinitions.SectionTypeExtensions;\r |
878ddf1f | 87 | \r |
88 | /**\r | |
89 | search in the type, if componentType is listed in type, return true; \r | |
90 | otherwise return false.\r | |
91 | \r | |
92 | @param type a list supported component type separated by comma\r | |
93 | @param componentType current module component type\r | |
94 | @return whether componentType is one of type \r | |
95 | **/\r | |
96 | private boolean isMatch(String type, String componentType) {\r | |
97 | String[] items = type.split("[ \t]*,[ \t]*");\r | |
98 | for (int i = 0; i < items.length; i++) {\r | |
99 | if (items[i].equalsIgnoreCase(componentType)) {\r | |
100 | return true;\r | |
101 | }\r | |
102 | }\r | |
103 | return false;\r | |
104 | }\r | |
105 | \r | |
106 | /**\r | |
4b5f5549 | 107 | Find the corresponding FFS layout in <code>FPD</code>. \r |
878ddf1f | 108 | \r |
109 | @param buildType Current module's component type\r | |
110 | @param project Ant project\r | |
111 | @return whether find the corresponding FFS layout\r | |
112 | @throws BuildException\r | |
4b5f5549 | 113 | If can't find FFS Layout in FPD.\r |
878ddf1f | 114 | **/\r |
a29c47e0 | 115 | public boolean initSections(String buildType, Project project, FpdModuleIdentification fpdModuleId) throws BuildException {\r |
878ddf1f | 116 | //\r |
82516887 | 117 | // Try to find Ffs layout from FPD file\r |
a29c47e0 | 118 | //\r |
19bf6b15 | 119 | SurfaceAreaQuery saq = new SurfaceAreaQuery(GlobalData.getFpdBuildOptionsMap());\r |
83fba802 | 120 | BuildOptionsDocument.BuildOptions.Ffs[] ffsArray = saq.getFpdFfs();\r |
a29c47e0 | 121 | for (int i = 0; i < ffsArray.length; i++) {\r |
122 | if (isMatch(ffsArray[i].getFfsKey(), buildType)) {\r | |
123 | ffsXmlObject = ffsArray[i];\r | |
124 | return true;\r | |
125 | }\r | |
126 | }\r | |
127 | \r | |
878ddf1f | 128 | //\r |
e64c74dd | 129 | // If FfsFormatKey is not null, report exception and fail build\r |
130 | // Otherwise report warning message\r | |
878ddf1f | 131 | //\r |
e64c74dd | 132 | if (buildType == null) {\r |
91f7d582 | 133 | EdkLog.log(EdkLog.EDK_WARNING, "Warning: this module doesn't specify a FfsFormatKey. ");\r |
82516887 | 134 | } else {\r |
391dbbb1 | 135 | throw new BuildException("Can't find the FfsFormatKey [" + buildType + "] attribute in the FPD file!"); \r |
878ddf1f | 136 | }\r |
e64c74dd | 137 | \r |
82516887 | 138 | return false;\r |
878ddf1f | 139 | }\r |
140 | \r | |
141 | /**\r | |
142 | Recursive parse the FFS layout. Find out all section type here used. \r | |
143 | \r | |
144 | @param document BaseName_build.xml Xml document\r | |
145 | @param basename Module's base name\r | |
146 | @param guid Module's GUID\r | |
147 | @param targetFilename Module's final file name (GUID-BaseName.APP)\r | |
148 | @return List of section type\r | |
149 | **/\r | |
150 | public String[] getGenSectionElements(Document document, String basename, String guid, String targetFilename) {\r | |
151 | this.basename = basename;\r | |
82516887 | 152 | if (ffsXmlObject == null) {\r |
878ddf1f | 153 | return new String[0];\r |
154 | }\r | |
155 | Vector<String> sectionList = new Vector<String>();\r | |
156 | XmlCursor cursor = null;\r | |
2eb7d78d | 157 | \r |
158 | cursor = ffsXmlObject.newCursor();\r | |
159 | \r | |
878ddf1f | 160 | int mode = MODE_NONE;\r |
82516887 | 161 | Element genffsfileEle = document.createElement("genffsfile");\r |
162 | genffsfileEle.setAttribute("outputDir", "${BIN_DIR}");\r | |
163 | genffsfileEle.setAttribute("moduleType", "${MODULE_TYPE}");\r | |
164 | genffsfileEle.setAttribute("BaseName", basename);\r | |
165 | genffsfileEle.setAttribute("fileGuid", guid);\r | |
166 | \r | |
878ddf1f | 167 | if (cursor.toFirstChild()) {\r |
168 | do {\r | |
169 | if (cursor.getName().getLocalPart().equalsIgnoreCase("Attribute")) {\r | |
170 | String name = cursor.getAttributeText(new QName("Name"));\r | |
171 | String value = cursor.getAttributeText(new QName("Value"));\r | |
82516887 | 172 | genffsfileEle.setAttribute(changeAttributeName(name), value);\r |
878ddf1f | 173 | } else if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r |
174 | cursor.push();\r | |
82516887 | 175 | dealSection(mode, document, genffsfileEle, cursor, sectionList);\r |
878ddf1f | 176 | cursor.pop();\r |
177 | } else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r | |
178 | cursor.push();\r | |
82516887 | 179 | dealSections(mode, document, genffsfileEle, cursor, sectionList);\r |
878ddf1f | 180 | cursor.pop();\r |
181 | }\r | |
182 | } while (cursor.toNextSibling());\r | |
183 | }\r | |
184 | //\r | |
185 | // Check dependency \r | |
186 | //\r | |
187 | Element outofdateEle = document.createElement("OnDependency");\r | |
188 | Element sourceEle = document.createElement("sourcefiles");\r | |
66a9a6f8 | 189 | Vector<String> sections = new Vector<String>();\r |
878ddf1f | 190 | for (int i = 0; i < sectionList.size(); i++) {\r |
66a9a6f8 | 191 | String section = (String) sectionList.get(i);\r |
192 | if (isSectionType(section)) {\r | |
193 | sections.addElement(section);\r | |
194 | }\r | |
878ddf1f | 195 | Element pathEle = document.createElement("file");\r |
66a9a6f8 | 196 | pathEle.setAttribute("name", getSectionFile(basename, section));\r |
878ddf1f | 197 | sourceEle.appendChild(pathEle);\r |
198 | }\r | |
66a9a6f8 | 199 | String[] result = sections.toArray(new String[sections.size()]);\r |
200 | \r | |
878ddf1f | 201 | outofdateEle.appendChild(sourceEle);\r |
202 | Element targetEle = document.createElement("targetfiles");\r | |
203 | Element fileEle = document.createElement("file");\r | |
52cbbdbc | 204 | fileEle.setAttribute("name", "${BIN_DIR}" + File.separatorChar + targetFilename);\r |
878ddf1f | 205 | targetEle.appendChild(fileEle);\r |
206 | outofdateEle.appendChild(targetEle);\r | |
207 | Element sequentialEle = document.createElement("sequential");\r | |
82516887 | 208 | sequentialEle.appendChild(genffsfileEle);\r |
878ddf1f | 209 | outofdateEle.appendChild(sequentialEle);\r |
210 | ffsNode = outofdateEle;\r | |
211 | return result;\r | |
212 | }\r | |
213 | \r | |
214 | /**\r | |
215 | Change the attribute name. For example: \r | |
216 | \r | |
217 | <pre>\r | |
218 | Before change: FFS_ATTRIB_CHECKSUM \r | |
219 | After change: ffsATTRIBCHECKSUM\r | |
220 | </pre>\r | |
221 | \r | |
222 | @param name Original attribute name\r | |
223 | @return Changed attribute name\r | |
224 | **/\r | |
225 | private String changeAttributeName(String name) {\r | |
226 | String[] strs = name.split("_");\r | |
227 | String str = strs[0].toLowerCase();\r | |
228 | for (int j = 1; j < strs.length; j++) {\r | |
229 | str += strs[j];\r | |
230 | }\r | |
231 | return str;\r | |
232 | }\r | |
233 | \r | |
234 | /**\r | |
235 | Recursively deal with Sections. If sections does not specify a type, then omit it.\r | |
236 | \r | |
237 | @param mode Current node mode (MODE_NONE | MODE_COMPREE | MODE_GUID_DEFINED)\r | |
238 | @param doc Xml Document\r | |
239 | @param root Root Node\r | |
240 | @param cursor Current FFS layout cursor\r | |
241 | @param list List of section type here used\r | |
242 | **/\r | |
243 | private void dealSections(int mode, Document doc, Element root, XmlCursor cursor, Vector<String> list) {\r | |
244 | String type = cursor.getAttributeText(new QName("EncapsulationType"));\r | |
a1ffb10f | 245 | String toolName = cursor.getAttributeText(new QName("ToolName"));\r |
246 | String sectType = cursor.getAttributeText(new QName("SectionType"));\r | |
247 | if (type == null && sectType == null) {\r | |
878ddf1f | 248 | if (cursor.toFirstChild()) {\r |
249 | do {\r | |
250 | if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r | |
251 | cursor.push();\r | |
252 | dealSection(mode, doc, root, cursor, list);\r | |
253 | cursor.pop();\r | |
254 | } else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r | |
255 | cursor.push();\r | |
256 | dealSections(mode, doc, root, cursor, list);\r | |
257 | cursor.pop();\r | |
258 | }\r | |
259 | } while (cursor.toNextSibling());\r | |
260 | }\r | |
261 | return;\r | |
262 | }\r | |
263 | Element ele;\r | |
a1ffb10f | 264 | Element toolEle = null;\r |
265 | if (type.equalsIgnoreCase("COMPRESS") && (toolName == null || toolName.equalsIgnoreCase(""))) {\r | |
878ddf1f | 266 | mode = MODE_COMPRESS;\r |
267 | //\r | |
a1ffb10f | 268 | // <gensection sectiontype="EFI_SECTION_COMPRESSION"> \r |
269 | // \r | |
270 | ele = doc.createElement("gensection");\r | |
271 | ele.setAttribute("sectionType", "EFI_SECTION_COMPRESSION");\r | |
272 | \r | |
878ddf1f | 273 | } else {\r |
274 | mode = MODE_GUID_DEFINED;\r | |
275 | //\r | |
a1ffb10f | 276 | // <gensection sectiontype="EFI_SECTION_GUID_DEFINED">\r |
277 | // \r | |
278 | ele = doc.createElement("gensection");\r | |
279 | if (type != null) {\r | |
5c4eec41 | 280 | if (type.equalsIgnoreCase("COMPRESS")) {\r |
281 | ele.setAttribute("sectionType", "EFI_SECTION_COMPRESSION");\r | |
282 | }else {\r | |
283 | ele.setAttribute("sectiontype", "EFI_SECTION_GUID_DEFINED"); \r | |
284 | }\r | |
285 | \r | |
a1ffb10f | 286 | } else {\r |
287 | ele.setAttribute("sectiontype", sectType);\r | |
288 | }\r | |
289 | //\r | |
878ddf1f | 290 | // <tool toolName="${OEMTOOLPATH}\toolname"\r |
291 | // outputPath = "${DEST_DIR_OUTPUT}">\r | |
292 | //\r | |
a1ffb10f | 293 | toolEle = doc.createElement("tool");\r |
294 | if (toolName == null || toolName.equalsIgnoreCase("")) {\r | |
295 | toolEle.setAttribute("toolName", "${WORKSPACE_DIR}" + File.separatorChar + "Tools" + File.separatorChar + "bin"\r | |
878ddf1f | 296 | + File.separatorChar + "GenCRC32Section");\r |
a1ffb10f | 297 | }else{\r |
298 | File toolExe = new File(toolName);\r | |
299 | //\r | |
300 | // If <Tool> element exist, add sub element under <tool> . \r | |
301 | // \r | |
302 | if (toolExe.isAbsolute()) {\r | |
303 | toolEle.setAttribute("toolName", toolName);\r | |
304 | } else {\r | |
305 | toolEle.setAttribute("toolName", "${WORKSPACE_DIR}" + File.separatorChar + "Tools" + File.separatorChar + "bin"\r | |
306 | + File.separatorChar + toolName);\r | |
307 | }\r | |
308 | }\r | |
309 | \r | |
310 | toolEle.setAttribute("outputPath", "${DEST_DIR_OUTPUT}");\r | |
311 | ele.appendChild(toolEle);\r | |
878ddf1f | 312 | }\r |
313 | if (cursor.toFirstChild()) {\r | |
314 | do {\r | |
315 | if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r | |
316 | cursor.push();\r | |
a1ffb10f | 317 | if (toolEle == null) {\r |
318 | dealSection(mode, doc, ele, cursor, list);\r | |
319 | } else {\r | |
320 | dealSection(mode, doc, toolEle, cursor, list);\r | |
321 | }\r | |
322 | \r | |
878ddf1f | 323 | cursor.pop();\r |
324 | } else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r | |
325 | cursor.push();\r | |
a1ffb10f | 326 | if (toolEle == null) {\r |
327 | dealSections(mode, doc, ele, cursor, list);\r | |
328 | } else {\r | |
329 | dealSections(mode, doc, toolEle, cursor, list);\r | |
330 | }\r | |
331 | \r | |
878ddf1f | 332 | cursor.pop();\r |
333 | }\r | |
334 | } while (cursor.toNextSibling());\r | |
335 | }\r | |
336 | root.appendChild(ele);\r | |
337 | }\r | |
338 | \r | |
339 | /**\r | |
340 | Recursively deal with section.\r | |
341 | \r | |
342 | @param mode Current node mode (MODE_NONE | MODE_COMPREE | MODE_GUID_DEFINED)\r | |
343 | @param doc Xml Document\r | |
344 | @param root Root Node\r | |
345 | @param cursor Current FFS layout cursor\r | |
346 | @param list List of section type here used\r | |
347 | **/\r | |
348 | private void dealSection(int mode, Document doc, Element root, XmlCursor cursor, Vector<String> list) {\r | |
349 | String type = cursor.getAttributeText(new QName("SectionType"));\r | |
e3cc4061 | 350 | String alignment = cursor.getAttributeText(new QName("Alignment"));\r |
8a9783c1 | 351 | \r |
352 | //\r | |
353 | // Judge if file is specified? Yes, just use the file, else call Build Macro\r | |
354 | // If fileName is null, means without FileNames specify in FPD file\r | |
355 | //\r | |
356 | String fileName = null;\r | |
357 | cursor.push();\r | |
358 | if (cursor.toFirstChild()) {\r | |
359 | do {\r | |
360 | if (cursor.getName().getLocalPart().equalsIgnoreCase("Filenames")) {\r | |
361 | cursor.push();\r | |
362 | if (cursor.toFirstChild()) {\r | |
363 | do {\r | |
364 | if (cursor.getName().getLocalPart().equalsIgnoreCase("Filename")) {\r | |
365 | fileName = cursor.getTextValue();\r | |
366 | }\r | |
367 | } while (cursor.toNextSibling());\r | |
368 | }\r | |
369 | cursor.pop();\r | |
370 | }\r | |
371 | } while (cursor.toNextSibling());\r | |
372 | }\r | |
373 | \r | |
374 | cursor.pop();\r | |
375 | \r | |
376 | if (fileName == null) {\r | |
377 | list.addElement(type);\r | |
66a9a6f8 | 378 | } else {\r |
379 | list.addElement(fileName);\r | |
8a9783c1 | 380 | }\r |
66a9a6f8 | 381 | \r |
878ddf1f | 382 | if (mode == MODE_GUID_DEFINED) {\r |
383 | //\r | |
384 | // <input file="${DEST_DIR_OUTPUT}\Bds.pe32"/>\r | |
385 | //\r | |
386 | Element ele = doc.createElement("input");\r | |
8a9783c1 | 387 | if (fileName == null) {\r |
66a9a6f8 | 388 | ele.setAttribute("file", getSectionFile(basename, type));\r |
8a9783c1 | 389 | } else {\r |
706c2ad4 | 390 | ele.setAttribute("file", fileName);\r |
8a9783c1 | 391 | }\r |
878ddf1f | 392 | root.appendChild(ele);\r |
393 | } else {\r | |
394 | //\r | |
395 | // <sectFile fileName= "..."/>\r | |
396 | //\r | |
397 | Element ele = doc.createElement("sectFile");\r | |
8a9783c1 | 398 | if (fileName == null) {\r |
66a9a6f8 | 399 | ele.setAttribute("fileName", getSectionFile(basename, type));\r |
8a9783c1 | 400 | } else {\r |
706c2ad4 | 401 | ele.setAttribute("fileName", fileName);\r |
8a9783c1 | 402 | }\r |
e3cc4061 | 403 | if (alignment != null) {\r |
404 | ele.setAttribute("Alignment", alignment);\r | |
405 | }\r | |
878ddf1f | 406 | root.appendChild(ele);\r |
407 | }\r | |
408 | }\r | |
409 | \r | |
410 | /**\r | |
a29c47e0 | 411 | Get the corresponding section file suffix.\r |
878ddf1f | 412 | \r |
413 | @param type Section type\r | |
414 | @return Corresponding section file extension\r | |
415 | **/\r | |
66a9a6f8 | 416 | private String getSectionFile(String basename, String type) {\r |
417 | for (int i = 0; i < sectionExt.length; i++) {\r | |
418 | if (sectionExt[i][0].equalsIgnoreCase(type)) {\r | |
419 | return "${DEST_DIR_OUTPUT}" + File.separatorChar + basename + sectionExt[i][1];\r | |
420 | }\r | |
421 | }\r | |
422 | return type;\r | |
423 | }\r | |
424 | \r | |
425 | private boolean isSectionType(String type) {\r | |
878ddf1f | 426 | for (int i = 0; i < sectionExt.length; i++) {\r |
427 | if (sectionExt[i][0].equalsIgnoreCase(type)) {\r | |
66a9a6f8 | 428 | return true;\r |
878ddf1f | 429 | }\r |
430 | }\r | |
66a9a6f8 | 431 | return false;\r |
878ddf1f | 432 | }\r |
433 | \r | |
434 | /**\r | |
435 | Return the ANT script to call GenFfs Tool.\r | |
436 | \r | |
437 | @return ANT script to call GenFfs Tool\r | |
438 | **/\r | |
439 | public Element getFfsNode() {\r | |
440 | return ffsNode;\r | |
441 | }\r | |
442 | }\r |