Distinguish PEIM entrypoint and driver entrypoint
[mirror_edk2.git] / Tools / Source / MigrationTools / org / tianocore / migration / ModuleReader.java
CommitLineData
b0282412 1/** @file\r
2 \r
3 Copyright (c) 2006, Intel Corporation\r
4 All rights reserved. This program and the accompanying materials\r
5 are licensed and made available under the terms and conditions of the BSD License\r
6 which accompanies this distribution. The full text of the license may be found at\r
7 http://opensource.org/licenses/bsd-license.php\r
8 \r
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
11 \r
12 **/\r
0dc8c589 13package org.tianocore.migration;\r
14\r
15import java.io.*;\r
16import java.util.*;\r
17import java.util.regex.*;\r
446e26ee 18\r
0dc8c589 19import org.tianocore.*;\r
20\r
39e5e412 21public final class ModuleReader implements Common.ForDoAll {\r
22 private static final ModuleReader modulereader = new ModuleReader();\r
23 private ModuleInfo mi;\r
24 private final CommentLaplace commentlaplace = new CommentLaplace();\r
27e0221a 25 \r
26 private static final Pattern ptninfequation = Pattern.compile("([^\\s]*)\\s*=\\s*([^\\s]*)");\r
27 private static final Pattern ptnsection = Pattern.compile("\\[([^\\[\\]]*)\\]([^\\[\\]]*)\\n", Pattern.MULTILINE);\r
28 private static final Pattern ptnfilename = Pattern.compile("[^\\s]+");\r
29 \r
39e5e412 30 public final void ModuleScan() throws Exception {\r
27e0221a 31 Common.toDoAll(mi.modulepath, ModuleInfo.class.getMethod("enroll", String.class), mi, null, Common.FILE);\r
cfdfbaca 32\r
39e5e412 33 // inf&msa\r
27e0221a 34 String filename = null;\r
35 if (mi.msaorinf.isEmpty()) {\r
36 MigrationTool.ui.println("No INF nor MSA file found!");\r
37 System.exit(0);\r
38 } else {\r
39 if (mi.msaorinf.size() == 1) {\r
40 filename = (String)mi.msaorinf.toArray()[0];\r
41 } else {\r
42 filename = MigrationTool.ui.choose("Found .inf or .msa file for module\n" + mi.modulepath + "\nChoose one Please", mi.msaorinf.toArray());\r
43 }\r
44 }\r
5f4eb6b6 45\r
27e0221a 46 if (filename.contains(".inf")) {\r
47 readInf(filename);\r
48 } else if (filename.contains(".msa")) {\r
49 readMsa(filename);\r
50 }\r
39e5e412 51 // inf&msa\r
cfdfbaca 52\r
39e5e412 53 preProcessModule();\r
27e0221a 54 }\r
55 \r
39e5e412 56 private final void readMsa(String name) throws Exception {\r
27e0221a 57 ModuleSurfaceAreaDocument msadoc = ModuleSurfaceAreaDocument.Factory.parse(new File(mi.modulepath + File.separator + name));\r
58 ModuleSurfaceAreaDocument.ModuleSurfaceArea msa = msadoc.getModuleSurfaceArea();\r
59 MsaHeaderDocument.MsaHeader msaheader = msa.getMsaHeader();\r
7bcb8d17 60\r
27e0221a 61 mi.modulename = msaheader.getModuleName();\r
62 mi.guidvalue = msaheader.getGuidValue();\r
63 mi.moduletype = msaheader.getModuleType().toString(); // ???\r
7bcb8d17 64\r
27e0221a 65 SourceFilesDocument.SourceFiles sourcefiles = msa.getSourceFiles();\r
66 \r
67 String temp;\r
68 Iterator<FilenameDocument.Filename> li = sourcefiles.getFilenameList().iterator();\r
69 while (li.hasNext()) {\r
70 if (!mi.localmodulesources.contains(temp = li.next().toString())) {\r
71 System.out.println("Source File Missing! : " + temp);\r
72 }\r
73 }\r
74 }\r
75 \r
39e5e412 76 private final void readInf(String name) throws Exception {\r
27e0221a 77 System.out.println("\nParsing INF file: " + name);\r
78 String wholeline;\r
79 Matcher mtrinfequation;\r
80 Matcher mtrsection;\r
81 Matcher mtrfilename;\r
0dc8c589 82\r
27e0221a 83 wholeline = Common.file2string(mi.modulepath + File.separator + name);\r
84 mtrsection = ptnsection.matcher(wholeline);\r
85 while (mtrsection.find()) {\r
86 if (mtrsection.group(1).matches("defines")) {\r
87 mtrinfequation = ptninfequation.matcher(mtrsection.group(2));\r
88 while (mtrinfequation.find()) {\r
89 if (mtrinfequation.group(1).matches("BASE_NAME")) {\r
90 mi.modulename = mtrinfequation.group(2);\r
91 }\r
92 if (mtrinfequation.group(1).matches("FILE_GUID")) {\r
93 mi.guidvalue = mtrinfequation.group(2);\r
94 }\r
95 if (mtrinfequation.group(1).matches("COMPONENT_TYPE")) {\r
96 mi.moduletype = mtrinfequation.group(2);\r
97 }\r
98 }\r
99 }\r
77dd49a7 100 if (mtrsection.group(1).contains("nmake.")) {\r
27e0221a 101 mtrinfequation = ptninfequation.matcher(mtrsection.group(2));\r
102 while (mtrinfequation.find()) {\r
103 if (mtrinfequation.group(1).matches("IMAGE_ENTRY_POINT")) {\r
104 mi.entrypoint = mtrinfequation.group(2);\r
105 }\r
106 if (mtrinfequation.group(1).matches("DPX_SOURCE")) {\r
107 if (!mi.localmodulesources.contains(mtrinfequation.group(2))) {\r
108 MigrationTool.ui.println("DPX File Missing! : " + mtrinfequation.group(2));\r
109 }\r
110 }\r
111 }\r
112 }\r
113 if (mtrsection.group(1).contains("sources.")) {\r
114 mtrfilename = ptnfilename.matcher(mtrsection.group(2));\r
115 while (mtrfilename.find()) {\r
39e5e412 116 mi.infsources.add(mtrfilename.group());\r
27e0221a 117 if (!mi.localmodulesources.contains(mtrfilename.group())) {\r
39e5e412 118 MigrationTool.ui.println("Warn: Source File Missing! : " + mtrfilename.group());\r
27e0221a 119 }\r
120 }\r
121 }\r
0e9d14c4 122 if (mtrsection.group(1).matches("includes.")) {\r
39e5e412 123 mtrfilename = ptnfilename.matcher(mtrsection.group(2));\r
124 while (mtrfilename.find()) {\r
125 mi.infincludes.add(mtrfilename.group());\r
126 }\r
127 }\r
27e0221a 128 }\r
129 }\r
130 \r
39e5e412 131 private final void preProcessModule() throws Exception {\r
132 // according to .inf file, add extraordinary includes and sourcefiles\r
77dd49a7 133 Common.dirCopy(mi.modulepath, mi.modulepath + File.separator + "temp"); // collect all Laplace.namechange to here???\r
39e5e412 134 \r
135 if (!mi.infincludes.isEmpty()) {\r
136 Iterator<String> it = mi.infincludes.iterator();\r
137 String tempincludename = null;\r
138 while (it.hasNext()) {\r
139 tempincludename = it.next();\r
140 if (tempincludename.contains("..")) {\r
141 Matcher mtr = Common.PTNSEPARATER.matcher(tempincludename);\r
142 if (mtr.find() && !mtr.group(2).matches(".")) {\r
143 Common.oneLevelDirCopy(mi.modulepath.replaceAll(Common.STRSEPARATER, "$1") + File.separator + mtr.group(2), mi.modulepath + File.separator + "temp", ".h");\r
144 } else {\r
145 Common.oneLevelDirCopy(mi.modulepath.replaceAll(Common.STRSEPARATER, "$1"), mi.modulepath + File.separator + "temp", ".h");\r
146 }\r
147 }\r
148 }\r
149 }\r
150 if (!mi.infsources.isEmpty()) {\r
151 Iterator<String> it = mi.infsources.iterator();\r
152 String tempsourcename = null;\r
153 while (it.hasNext()) {\r
154 tempsourcename = it.next();\r
155 if (tempsourcename.contains("..")) {\r
156 Common.ensureDir(mi.modulepath + File.separator + "temp" + File.separator + "MT_Parent_Sources");\r
157 Matcher mtr = Common.PTNSEPARATER.matcher(tempsourcename);\r
158 if (mtr.find()) {\r
159 Common.fileCopy(mi.modulepath.replaceAll(Common.STRSEPARATER, "$1") + File.separator + mtr.group(2), mi.modulepath + File.separator + "temp" + File.separator + "MT_Parent_Sources" + File.separator + mtr.group(2));\r
160 }\r
161 }\r
162 }\r
163 }\r
446e26ee 164\r
39e5e412 165 //CommentOutNonLocalHFile();\r
166 Common.toDoAll(mi.modulepath + File.separator + "temp", this, Common.FILE);\r
167 \r
168 parsePreProcessedSourceCode();\r
446e26ee 169\r
27e0221a 170 }\r
446e26ee 171\r
39e5e412 172 private final void parsePreProcessedSourceCode() throws Exception {\r
27e0221a 173 //Cl cl = new Cl(modulepath);\r
174 //cl.execute("Fat.c");\r
175 //cl.generateAll(preprocessedccodes);\r
176 //\r
177 //System.out.println("Note!!!! The CL is not implemented now , pls do it manually!!! RUN :");\r
178 //System.out.println("cl " + modulepath + "\\temp\\*.c" + " -P");\r
179 //String[] list = new File(modulepath + File.separator + "temp").list(); // without CL , add\r
180 BufferedReader rd = null;\r
181 String ifile = null;\r
182 String line = null;\r
183 String temp = null;\r
184 \r
185 Iterator<String> ii = mi.localmodulesources.iterator();\r
186 while (ii.hasNext()) {\r
187 temp = ii.next();\r
188 if (temp.contains(".c")) {\r
189 mi.preprocessedccodes.add(temp);\r
190 }\r
191 }\r
192 \r
193 ii = mi.preprocessedccodes.iterator();\r
194 \r
195 Pattern patefifuncc = Pattern.compile("g?(BS|RT)\\s*->\\s*([a-zA-Z_]\\w*)",Pattern.MULTILINE);\r
196 Pattern patentrypoint = Pattern.compile("EFI_([A-Z]*)_ENTRY_POINT\\s*\\(([^\\(\\)]*)\\)",Pattern.MULTILINE);\r
197 Matcher matguid;\r
198 Matcher matfuncc;\r
199 Matcher matfuncd;\r
200 Matcher matenclosereplace;\r
201 Matcher matefifuncc;\r
202 Matcher matentrypoint;\r
203 Matcher matmacro;\r
204 \r
205 while (ii.hasNext()) {\r
206 StringBuffer wholefile = new StringBuffer();\r
207 ifile = ii.next();\r
208 rd = new BufferedReader(new FileReader(mi.modulepath + File.separator + "temp" + File.separator + ifile));\r
209 while ((line = rd.readLine()) != null) {\r
210 wholefile.append(line + '\n');\r
211 }\r
212 line = wholefile.toString();\r
213 \r
214 // if this is a Pei phase module , add these library class to .msa\r
215 matentrypoint = patentrypoint.matcher(line);\r
216 if (matentrypoint.find()) {\r
217 mi.entrypoint = matentrypoint.group(2);\r
218 if (matentrypoint.group(1).matches("PEIM")) {\r
219 mi.hashrequiredr9libs.add("PeimEntryPoint");\r
220 } else {\r
221 mi.hashrequiredr9libs.add("UefiDriverEntryPoint");\r
222 }\r
223 }\r
224 \r
225 // find guid\r
226 matguid = Guid.ptnguid.matcher(line); // several ways to implement this , which one is faster ? :\r
227 while (matguid.find()) { // 1.currently , find once , then call to identify which is it\r
228 if ((temp = Guid.register(matguid, mi, MigrationTool.db)) != null) { // 2.use 3 different matchers , search 3 times to find each\r
229 //matguid.appendReplacement(result, MigrationTool.db.getR9Guidname(temp)); // search the database for all 3 kinds of guids , high cost\r
230 }\r
231 }\r
232 //matguid.appendTail(result);\r
233 //line = result.toString();\r
446e26ee 234\r
27e0221a 235 // find EFI call in form of '->' , many 'gUnicodeCollationInterface->' like things are not changed\r
236 // This item is not simply replaced , special operation is required.\r
237 matefifuncc = patefifuncc.matcher(line);\r
238 while (matefifuncc.find()) {\r
239 mi.hashEFIcall.add(matefifuncc.group(2));\r
240 }\r
446e26ee 241\r
27e0221a 242 // find function call\r
243 matfuncc = Func.ptnfuncc.matcher(line);\r
244 while (matfuncc.find()) {\r
245 if ((temp = Func.register(matfuncc, mi, MigrationTool.db)) != null) {\r
246 //MigrationTool.ui.println(ifile + " dofunc " + temp);\r
247 //matfuncc.appendReplacement(result, MigrationTool.db.getR9Func(temp));\r
248 }\r
249 }\r
250 //matfuncc.appendTail(result);\r
251 //line = result.toString();\r
446e26ee 252\r
27e0221a 253 // find macro\r
254 matmacro = Macro.ptntmacro.matcher(line);\r
255 while (matmacro.find()) {\r
256 if ((temp = Macro.register(matmacro, mi, MigrationTool.db)) != null) {\r
257 }\r
258 }\r
259 \r
260 // find function definition\r
261 // replace all {} to @\r
262 while ((matenclosereplace = Func.ptnbrace.matcher(line)).find()) {\r
263 line = matenclosereplace.replaceAll("@");\r
264 }\r
446e26ee 265\r
27e0221a 266 matfuncd = Func.ptnfuncd.matcher(line);\r
267 while (matfuncd.find()) {\r
268 if ((temp = Func.register(matfuncd, mi, MigrationTool.db)) != null) {\r
269 }\r
270 }\r
271 }\r
272 \r
273 // op on hash\r
274 Iterator<String> funcci = mi.hashfuncc.iterator();\r
275 while (funcci.hasNext()) {\r
276 if (!mi.hashfuncd.contains(temp = funcci.next()) && !mi.hashEFIcall.contains(temp)) {\r
277 mi.hashnonlocalfunc.add(temp); // this set contains both changed and not changed items\r
278 }\r
279 }\r
280 }\r
39e5e412 281 \r
282 public class CommentLaplace extends Common.Laplace {\r
283 public String operation(String wholeline) {\r
284 StringBuffer wholebuffer = new StringBuffer();\r
285 String templine = null;\r
286 Pattern ptnincludefile = Pattern.compile("[\"<](.*[.]h)[\">]");\r
287 Pattern ptninclude = Pattern.compile("#include\\s*(.*)");\r
288 Matcher mtrinclude = ptninclude.matcher(wholeline);\r
289 Matcher mtrincludefile = null;\r
290 while (mtrinclude.find()) {\r
291 mtrincludefile = ptnincludefile.matcher(mtrinclude.group(1));\r
292 if (mtrincludefile.find() && mi.localmodulesources.contains(mtrincludefile.group(1))) {\r
293 templine = mtrinclude.group();\r
294 } else {\r
295 templine = MigrationTool.MIGRATIONCOMMENT + mtrinclude.group();\r
296 }\r
297 mtrinclude.appendReplacement(wholebuffer, templine);\r
298 }\r
299 mtrinclude.appendTail(wholebuffer);\r
300 return wholebuffer.toString();\r
301 }\r
302 \r
303 public boolean recognize(String filename) {\r
304 return filename.contains(".c") || filename.contains(".h");\r
305 }\r
306 \r
307 public String namechange(String oldname) {\r
308 return oldname;\r
309 }\r
310 }\r
311\r
312 //-----------------------------------ForDoAll-----------------------------------//\r
313 public void run(String filepath) throws Exception {\r
314 String name = mi.modulepath + File.separator + "temp" + File.separator + filepath.replace(mi.modulepath + File.separator + "temp" + File.separator, "");\r
315 commentlaplace.transform(name, name);\r
316 }\r
317\r
318 public boolean filter(File dir) {\r
319 return true;\r
320 }\r
321 //-----------------------------------ForDoAll-----------------------------------//\r
322 \r
323 public final void setModuleInfo(ModuleInfo m) {\r
324 mi = m;\r
325 }\r
326 \r
327 public static final void aimAt(ModuleInfo mi) throws Exception {\r
328 modulereader.setModuleInfo(mi);\r
329 modulereader.ModuleScan();\r
330 }\r
719cebfe 331}\r