Tools/Source/MigrationTools/org/tianocore/migration/SourceFileReplacer.java

   1 /** @file
   2
   3  Copyright (c) 2006, Intel Corporation
   4  All rights reserved. This program and the accompanying materials
   5  are licensed and made available under the terms and conditions of the BSD License
   6  which accompanies this distribution.  The full text of the license may be found at
   7  http://opensource.org/licenses/bsd-license.php
   8
   9  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12  **/
  13 package org.tianocore.migration;
  14
  15 import java.io.*;
  16 import java.util.*;
  17 import java.util.regex.Matcher;
  18 import java.util.regex.Pattern;
  19
  20 public final class SourceFileReplacer implements Common.ForDoAll {
  21     private static final SourceFileReplacer SFReplacer = new SourceFileReplacer();
  22     private ModuleInfo mi;
  23     private static final Set<Common.Laplace> Laplaces = new HashSet<Common.Laplace>();
  24
  25     // these sets are used only for printing log of the changes in current file
  26     private static final Set<r8tor9> filefunc = new HashSet<r8tor9>();
  27     private static final Set<r8tor9> filemacro = new HashSet<r8tor9>();
  28     private static final Set<r8tor9> fileguid = new HashSet<r8tor9>();
  29     private static final Set<r8tor9> fileppi = new HashSet<r8tor9>();
  30     private static final Set<r8tor9> fileprotocol = new HashSet<r8tor9>();
  31     private static final Set<String> filer8only = new HashSet<String>();
  32
  33     private static final String[] specialhoblibfunc = {
  34         "BuildModuleHob",
  35         "BuildResourceDescriptorHob",
  36         "BuildFvHob",
  37         "BuildCpuHob",
  38         "BuildGuidDataHob",
  39         "BuildStackHob",
  40         "BuildBspStoreHob",
  41         "BuildMemoryAllocationHob"
  42         };
  43
  44     //---------------------------------------inner classes---------------------------------------//
  45     private static class r8tor9 {
  46         r8tor9(String r8, String r9) {
  47             r8thing = r8;
  48             r9thing = r9;
  49         }
  50         public String r8thing;
  51         public String r9thing;
  52     }
  53
  54     private class IdleLaplace extends Common.Laplace {
  55         public String operation(String wholeline) {
  56             return wholeline;
  57         }
  58
  59         public boolean recognize(String filename) {
  60             return filename.contains(".h") || filename.contains(".H") || filename.contains(".uni");
  61         }
  62
  63         public String namechange(String oldname) {
  64             if (oldname.contains(".H")) {
  65                 return oldname.replaceFirst(".H", ".h");
  66             } else {
  67                 return oldname;
  68             }
  69         }
  70     }
  71     private class DxsLaplace extends Common.Laplace {
  72         public String operation(String wholeline) {
  73             if (mi.getModuleType().equals("PEIM")) {
  74                 return addincludefile(wholeline, "\\<PeimDepex.h\\>");
  75             } else {
  76                 return addincludefile(wholeline, "\\<DxeDepex.h\\>");
  77             }
  78         }
  79
  80         public boolean recognize(String filename) {
  81             return filename.contains(".dxs");
  82         }
  83
  84         public String namechange(String oldname) {
  85             return oldname;
  86         }
  87     }
  88
  89     private class CLaplace extends Common.Laplace {
  90         public  String operation(String wholeline) {
  91             boolean addr8 = false;
  92             // remove EFI_DRIVER_ENTRY_POINT
  93             wholeline = wholeline.replaceAll("(EFI_[A-Z]+_ENTRY_POINT\\s*\\(\\s*" + mi.entrypoint + "\\s*\\)\\s*;)", MigrationTool.MIGRATIONCOMMENT + " $1");
  94             // redefine module entry point for some self-relocated modules
  95             wholeline = wholeline.replaceAll (mi.entrypoint + "([^{]*?})", "_ModuleEntryPoint" + "$1");
  96             // remove R8 library contractor
  97             wholeline = wholeline.replaceAll ("(\\b(?:Efi|Dxe)InitializeDriverLib\\b)", MigrationTool.MIGRATIONCOMMENT + " $1");
  98             // Add Library Class for potential reference of gBS, gRT & gDS.
  99             if (Common.find (wholeline, "\\bg?BS\\b")) {
 100                 mi.hashrequiredr9libs.add("UefiBootServicesTableLib");
 101             }
 102             if (Common.find (wholeline, "\\bg?RT\\b")) {
 103                 mi.hashrequiredr9libs.add ("UefiRuntimeServicesTableLib");
 104             }
 105             if (Common.find (wholeline, "\\bgDS\\b")) {
 106                 mi.hashrequiredr9libs.add ("DxeServicesTableLib");
 107             }
 108             // start replacing names
 109             String r8thing;
 110             String r9thing;
 111             Iterator<String> it;
 112             // Converting non-locla function
 113             it = mi.hashnonlocalfunc.iterator();
 114             while (it.hasNext()) {
 115                 r8thing = it.next();
 116                 mi.hashrequiredr9libs.add(MigrationTool.db.getR9Lib(r8thing));                // add a library here
 117
 118                 r8tor9 temp;
 119                 if ((r9thing = MigrationTool.db.getR9Func(r8thing)) != null) {
 120                     if (!r8thing.equals(r9thing)) {
 121                         if (wholeline.contains(r8thing)) {
 122                             wholeline = wholeline.replaceAll(r8thing, r9thing);
 123                             filefunc.add(new r8tor9(r8thing, r9thing));
 124                             Iterator<r8tor9> rt = filefunc.iterator();
 125                             while (rt.hasNext()) {
 126                                 temp = rt.next();
 127                                 if (MigrationTool.db.r8only.contains(temp.r8thing)) {
 128                                     filer8only.add(r8thing);
 129                                     mi.hashr8only.add(r8thing);
 130                                     addr8 = true;
 131                                 }
 132                             }
 133                         }
 134                     }
 135                 }
 136             }                                                            //is any of the guids changed?
 137             if (addr8 == true) {
 138                 wholeline = addincludefile(wholeline, "\"R8Lib.h\"");
 139             }
 140
 141             // Converting macro
 142             it = mi.hashnonlocalmacro.iterator();
 143             while (it.hasNext()) {                        //macros are all assumed MdePkg currently
 144                 r8thing = it.next();
 145                 //mi.hashrequiredr9libs.add(MigrationTool.db.getR9Lib(r8thing));
 146                 if ((r9thing = MigrationTool.db.getR9Macro(r8thing)) != null) {
 147                     if (wholeline.contains(r8thing)) {
 148                         wholeline = wholeline.replaceAll(r8thing, r9thing);
 149                         filemacro.add(new r8tor9(r8thing, r9thing));
 150                     }
 151                 }
 152             }
 153
 154             // Converting guid
 155             replaceGuid(wholeline, mi.guid, "guid", fileguid);
 156             replaceGuid(wholeline, mi.ppi, "ppi", fileppi);
 157             replaceGuid(wholeline, mi.protocol, "protocol", fileprotocol);
 158
 159             // Converting Pei
 160             // First , find all (**PeiServices)-> or (*PeiServices). with arg "PeiServices" , change name and add #%
 161             Pattern ptnpei = Pattern.compile("\\(\\*\\*?PeiServices\\)[.-][>]?\\s*(\\w*)(\\s*\\(\\s*PeiServices\\s*,\\s*)", Pattern.MULTILINE);
 162             if (mi.getModuleType().matches("PEIM")) {
 163             //if (mi.moduletype.contains("PEIM")) {
 164                 Matcher mtrpei = ptnpei.matcher(wholeline);
 165                 while (mtrpei.find()) {                                        // ! add a library here !
 166                     wholeline = mtrpei.replaceAll("PeiServices$1#%$2");
 167                     mi.hashrequiredr9libs.add("PeiServicesLib");
 168                 }
 169                 mtrpei.reset();
 170                 if (wholeline.contains("PeiServicesCopyMem")) {
 171                     wholeline = wholeline.replaceAll("PeiServicesCopyMem#%", "CopyMem");
 172                     mi.hashrequiredr9libs.add("BaseMemoryLib");
 173                 }
 174                 if (wholeline.contains("PeiServicesSetMem")) {
 175                     wholeline = wholeline.replaceAll("PeiServicesSetMem#%", "SetMem");
 176                     mi.hashrequiredr9libs.add("BaseMemoryLib");
 177                 }
 178
 179                 // Second , find all #% to drop the arg "PeiServices"
 180                 Pattern ptnpeiarg = Pattern.compile("#%+(\\s*\\(+\\s*)PeiServices\\s*,\\s*", Pattern.MULTILINE);
 181                 Matcher mtrpeiarg = ptnpeiarg.matcher(wholeline);
 182                 while (mtrpeiarg.find()) {
 183                     wholeline = mtrpeiarg.replaceAll("$1");
 184                 }
 185             }
 186
 187             wholeline = hobLibFuncDropStatus(wholeline);
 188
 189             Matcher mtrmac;
 190             mtrmac = Pattern.compile("EFI_IDIV_ROUND\\((.*), (.*)\\)").matcher(wholeline);
 191             if (mtrmac.find()) {
 192                 wholeline = mtrmac.replaceAll("\\($1 \\/ $2 \\+ \\(\\(\\(2 \\* \\($1 \\% $2\\)\\) \\< $2\\) \\? 0 \\: 1\\)\\)");
 193             }
 194             mtrmac = Pattern.compile("EFI_MIN\\((.*), (.*)\\)").matcher(wholeline);
 195             if (mtrmac.find()) {
 196                 wholeline = mtrmac.replaceAll("\\(\\($1 \\< $2\\) \\? $1 \\: $2\\)");
 197             }
 198             mtrmac = Pattern.compile("EFI_MAX\\((.*), (.*)\\)").matcher(wholeline);
 199             if (mtrmac.find()) {
 200                 wholeline = mtrmac.replaceAll("\\(\\($1 \\> $2\\) \\? $1 \\: $2\\)");
 201             }
 202             mtrmac = Pattern.compile("EFI_UINTN_ALIGNED\\((.*)\\)").matcher(wholeline);
 203             if (mtrmac.find()) {
 204                 wholeline = mtrmac.replaceAll("\\(\\(\\(UINTN\\) $1\\) \\& \\(sizeof \\(UINTN\\) \\- 1\\)\\)");
 205             }
 206             if (wholeline.contains("EFI_UINTN_ALIGN_MASK")) {
 207                 wholeline = wholeline.replaceAll("EFI_UINTN_ALIGN_MASK", "(sizeof (UINTN) - 1)");
 208             }
 209
 210             show(filefunc, "function");
 211             show(filemacro, "macro");
 212             show(fileguid, "guid");
 213             show(fileppi, "ppi");
 214             show(fileprotocol, "protocol");
 215             if (!filer8only.isEmpty()) {
 216                 MigrationTool.ui.println("Converting r8only : " + filer8only);
 217             }
 218
 219             filefunc.clear();
 220             filemacro.clear();
 221             fileguid.clear();
 222             fileppi.clear();
 223             fileprotocol.clear();
 224             filer8only.clear();
 225
 226             return wholeline;
 227         }
 228
 229         public boolean recognize(String filename) {
 230             return filename.contains(".c") || filename.contains(".C");
 231         }
 232
 233         public String namechange(String oldname) {
 234             if (oldname.contains(".C")) {
 235                 return oldname.replaceFirst(".C", ".c");
 236             } else {
 237                 return oldname;
 238             }
 239         }
 240     }
 241     //---------------------------------------inner classes---------------------------------------//
 242
 243     //-------------------------------------process functions-------------------------------------//
 244     private static final String addincludefile(String wholeline, String hfile) {
 245         return wholeline.replaceFirst("(\\*/\\s)", "$1\n#include " + hfile + "\n");
 246     }
 247
 248     private static final void show(Set<r8tor9> hash, String sh) {
 249         Iterator<r8tor9> it = hash.iterator();
 250         r8tor9 temp;
 251         if (!hash.isEmpty()) {
 252             MigrationTool.ui.print("Converting " + sh + " : ");
 253             while (it.hasNext()) {
 254                 temp = it.next();
 255                 MigrationTool.ui.print("[" + temp.r8thing + "->" + temp.r9thing + "] ");
 256             }
 257             MigrationTool.ui.println("");
 258         }
 259     }
 260
 261     private static final void replaceGuid(String line, Set<String> hash, String kind, Set<r8tor9> filehash) {
 262         Iterator<String> it;
 263         String r8thing;
 264         String r9thing;
 265         it = hash.iterator();
 266         while (it.hasNext()) {
 267             r8thing = it.next();
 268             if ((r9thing = MigrationTool.db.getR9Guidname(r8thing)) != null) {
 269                 if (!r8thing.equals(r9thing)) {
 270                     if (line.contains(r8thing)) {
 271                         line = line.replaceAll(r8thing, r9thing);
 272                         filehash.add(new r8tor9(r8thing, r9thing));
 273                     }
 274                 }
 275             }
 276         }
 277     }
 278
 279     private final String hobLibFuncDropStatus(String wholeline) {        // or use regex to find pattern "Status = ..."
 280         Pattern ptnhobstatus;
 281         Matcher mtrhobstatus;
 282         String templine = wholeline;
 283         for (int i = 0; i < specialhoblibfunc.length; i++) {
 284             ptnhobstatus = Pattern.compile("(Status\\s*=\\s*)?" + specialhoblibfunc[i] + "(.*?\\)\\s*;)", Pattern.DOTALL);
 285             mtrhobstatus = ptnhobstatus.matcher(templine);
 286             if (mtrhobstatus.find()) {
 287                 templine = mtrhobstatus.replaceAll(specialhoblibfunc[i] + mtrhobstatus.group(2) + "\n  //Migration comments: R9 Hob-building library functions will assert if build failure.\n  Status = EFI_SUCCESS;");
 288             }
 289         }
 290         return templine;
 291     }
 292
 293     private final void addr8only() throws Exception {
 294         String paragraph = null;
 295         String line = Common.file2string(MigrationTool.db.DatabasePath + File.separator + "R8Lib.c");
 296         PrintWriter outfile1 = new PrintWriter(new BufferedWriter(new FileWriter(MigrationTool.ModuleInfoMap.get(mi) + File.separator + "Migration_" + mi.modulename + File.separator + "R8Lib.c")));
 297         PrintWriter outfile2 = new PrintWriter(new BufferedWriter(new FileWriter(MigrationTool.ModuleInfoMap.get(mi) + File.separator + "Migration_" + mi.modulename + File.separator + "R8Lib.h")));
 298         Pattern ptnr8only = Pattern.compile("////#?(\\w*)?(.*?R8_(\\w*).*?)////~", Pattern.DOTALL);
 299         Matcher mtrr8only = ptnr8only.matcher(line);
 300         Matcher mtrr8onlyhead;
 301
 302         //add head comment
 303         Matcher mtrr8onlyheadcomment = Critic.PTN_NEW_HEAD_COMMENT.matcher(line);
 304         if (mtrr8onlyheadcomment.find()) {
 305             outfile1.append(mtrr8onlyheadcomment.group() + "\n\n");
 306             outfile2.append(mtrr8onlyheadcomment.group() + "\n\n");
 307         }
 308
 309         //add functions body
 310         while (mtrr8only.find()) {
 311             if (mi.hashr8only.contains(mtrr8only.group(3))) {
 312                 paragraph = mtrr8only.group(2);
 313                 outfile1.append(paragraph + "\n\n");
 314                 if (mtrr8only.group(1).length() != 0) {
 315                     mi.hashrequiredr9libs.add(mtrr8only.group(1));
 316                 }
 317                 //generate R8lib.h
 318                 while ((mtrr8onlyhead = Func.ptnbrace.matcher(paragraph)).find()) {
 319                     paragraph = mtrr8onlyhead.replaceAll(";");
 320                 }
 321                 outfile2.append(paragraph + "\n\n");
 322             }
 323         }
 324         outfile1.flush();
 325         outfile1.close();
 326         outfile2.flush();
 327         outfile2.close();
 328
 329         mi.localmodulesources.add("R8Lib.h");
 330         mi.localmodulesources.add("R8Lib.c");
 331     }
 332     //-------------------------------------process functions-------------------------------------//
 333
 334     //-----------------------------------ForDoAll-----------------------------------//
 335     public void run(String filepath) throws Exception {
 336         String inname = filepath.replace(mi.modulepath + File.separator, "");
 337         String tempinpath = mi.modulepath + File.separator + "temp" + File.separator;
 338         String tempoutpath = MigrationTool.ModuleInfoMap.get(mi) + File.separator + "Migration_" + mi.modulename + File.separator;
 339
 340         Iterator<Common.Laplace> itLaplace = Laplaces.iterator();
 341         while (itLaplace.hasNext()) {
 342             Common.Laplace lap = itLaplace.next();
 343             if (lap.recognize(inname)) {
 344                 MigrationTool.ui.println("\nHandling file: " + inname);
 345                 lap.transform(tempinpath + inname, tempoutpath + lap.namechange(inname));
 346             }
 347         }
 348     }
 349
 350     public boolean filter(File dir) {
 351         return true;
 352     }
 353     //-----------------------------------ForDoAll-----------------------------------//
 354
 355     private final void setModuleInfo(ModuleInfo moduleinfo) {
 356         mi = moduleinfo;
 357     }
 358
 359     private final void start() throws Exception {
 360         Laplaces.add(new DxsLaplace());
 361         Laplaces.add(new CLaplace());
 362         Laplaces.add(new IdleLaplace());
 363
 364         Common.toDoAll(mi.localmodulesources, this);
 365
 366         if (!mi.hashr8only.isEmpty()) {
 367             addr8only();
 368         }
 369
 370         Laplaces.clear();
 371     }
 372
 373     public static final void fireAt(ModuleInfo moduleinfo) throws Exception {
 374         SFReplacer.setModuleInfo(moduleinfo);
 375         SFReplacer.start();
 376     }
 377 }