Tools/Source/GenBuild/org/tianocore/build/pcd/entity/UsageInstance.java

   1 /** @file
   2   UsageInstance class.
   3
   4   This class indicate an usage instance for a PCD token. This instance maybe a module
   5   or platform setting. When a module produce or cosume a PCD token, then this module
   6   is an usage instance for this PCD token.
   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.entity;
  19
  20
  21 import java.util.UUID;
  22 import org.tianocore.ModuleTypeDef;
  23 import org.tianocore.build.pcd.exception.EntityException;
  24
  25 /**
  26   This class indicate an usage instance for a PCD token. This instance maybe a module
  27   or platform setting. When a module produce or cosume a PCD token, then this module
  28   is an usage instance for this PCD token.
  29 **/
  30 public class UsageInstance {
  31     ///
  32     /// This parent that this usage instance belongs to.
  33     ///
  34     public Token            parentToken;
  35
  36     ///
  37     /// The name of the module who contains this PCD.
  38     ///
  39     public String           moduleName;
  40
  41     ///
  42     /// The GUID of the module who contains this PCD.
  43     ///
  44     public UUID             moduleGUID;
  45
  46     ///
  47     /// The name of the package whose module contains this PCD.
  48     ///
  49     public String           packageName;
  50
  51     ///
  52     /// The GUID of the package whose module contains this PCD.
  53     ///
  54     public UUID             packageGUID;
  55
  56     ///
  57     /// The PCD type defined for module
  58     ///
  59     public Token.PCD_TYPE   modulePcdType;
  60
  61     ///
  62     /// The arch string of module contains this PCD
  63     ///
  64     public String           arch;
  65
  66     ///
  67     /// The version of module contains this PCD
  68     ///
  69     public String           version;
  70
  71     ///
  72     /// The module type for this usage instance.
  73     ///
  74     public ModuleTypeDef.Enum    moduleType;
  75
  76     ///
  77     /// The value of the PCD in this usage instance.
  78     ///
  79     public String           datum;
  80
  81     ///
  82     /// The maxDatumSize could be different for same PCD in different module
  83     /// But this case is allow for FeatureFlag, FixedAtBuild, PatchableInModule
  84     /// type.
  85     ///
  86     public int              maxDatumSize;
  87
  88     ///
  89     /// Autogen string for header file.
  90     ///
  91     public String           hAutogenStr;
  92
  93     ///
  94     /// Auotgen string for C code file.
  95     ///
  96     public String           cAutogenStr;
  97
  98     /**
  99        Constructure function
 100
 101        @param parentToken         Member variable.
 102        @param moduleName          Member variable.
 103        @param moduleGUID          Member variable.
 104        @param packageName         Member variable.
 105        @param packageGUID         Member variable.
 106        @param moduleType          Member variable.
 107        @param modulePcdType       Member variable.
 108        @param arch                Member variable.
 109        @param version             Member variable.
 110        @param value               Member variable.
 111        @param maxDatumSize        Member variable.
 112      */
 113     public UsageInstance (Token             parentToken,
 114                           String            moduleName,
 115                           UUID              moduleGUID,
 116                           String            packageName,
 117                           UUID              packageGUID,
 118                           ModuleTypeDef.Enum moduleType,
 119                           Token.PCD_TYPE    modulePcdType,
 120                           String            arch,
 121                           String            version,
 122                           String            value,
 123                           int               maxDatumSize) {
 124         this.parentToken      = parentToken;
 125         this.moduleName       = moduleName;
 126         this.moduleGUID       = moduleGUID;
 127         this.packageName      = packageName;
 128         this.packageGUID      = packageGUID;
 129         this.moduleType       = moduleType;
 130         this.modulePcdType    = modulePcdType;
 131         this.arch             = arch;
 132         this.version          = version;
 133         this.datum            = value;
 134         this.maxDatumSize     = maxDatumSize;
 135     }
 136
 137     /**
 138        Get the primary key for usage instance array for every token.
 139
 140        @param moduleName      the name of module
 141        @param moduleGUID      the GUID name of module
 142        @param packageName     the name of package who contains this module
 143        @param packageGUID     the GUID name of package
 144        @param arch            the archtecture string
 145        @param version         the version of this module
 146
 147        @return String         primary key
 148      */
 149     public static String getPrimaryKey(String moduleName,
 150                                        UUID   moduleGUID,
 151                                        String packageName,
 152                                        UUID   packageGUID,
 153                                        String arch,
 154                                        String version) {
 155         //
 156         // Because currently transition schema not require write moduleGuid, package Name, Packge GUID in
 157         // <ModuleSA> section, So currently no expect all paramter must be valid.
 158         return(moduleName                                                              + "_" +
 159                ((moduleGUID  != null) ? moduleGUID.toString() : "NullModuleGuid")      + "_" +
 160                ((packageName != null) ? packageName : "NullPackageName")               + "_" +
 161                ((packageGUID != null) ? packageGUID.toString() : "NullPackageGuid")    + "_" +
 162                ((arch        != null) ? arch : "NullArch")                             + "_" +
 163                ((version     != null) ? version : "NullVersion"));
 164     }
 165
 166     /**
 167        Get primary key string for this usage instance
 168
 169        @return String primary key string
 170     **/
 171     public String getPrimaryKey() {
 172         return UsageInstance.getPrimaryKey(moduleName, moduleGUID, packageName, packageGUID, arch, version);
 173     }
 174
 175     /**
 176        Judget whether current module is PEI driver
 177
 178        @return boolean
 179      */
 180     public boolean isPeiPhaseComponent() {
 181         if ((moduleType == ModuleTypeDef.PEI_CORE) ||
 182             (moduleType == ModuleTypeDef.PEIM)) {
 183             return true;
 184         }
 185         return false;
 186     }
 187
 188   public boolean isDxePhaseComponent() {
 189       //
 190       // BugBug: May need confirmation on which type of module can
 191       //         make use of Dynamic(EX) PCD entry.
 192       //
 193       if ((moduleType == ModuleTypeDef.DXE_DRIVER) ||
 194           (moduleType == ModuleTypeDef.DXE_RUNTIME_DRIVER) ||
 195           (moduleType == ModuleTypeDef.DXE_SAL_DRIVER) ||
 196           (moduleType == ModuleTypeDef.DXE_SMM_DRIVER) ||
 197           (moduleType == ModuleTypeDef.UEFI_DRIVER) ||
 198           (moduleType == ModuleTypeDef.UEFI_APPLICATION)
 199           ) {
 200           return true;
 201       }
 202       return false;
 203   }
 204
 205     /**
 206        Generate autogen string for header file and C code file.
 207
 208        @throws EntityException Fail to generate.
 209
 210        @param isBuildUsedLibrary  whether the autogen is for library.
 211      */
 212     public void generateAutoGen(boolean isBuildUsedLibrary)
 213         throws EntityException {
 214         String  guidStringCName     = null;
 215         boolean isByteArray         = false;
 216         String  printDatum          = null;
 217         String  tokenNumberString   = null;
 218
 219         hAutogenStr = "";
 220         cAutogenStr = "";
 221
 222         if (this.modulePcdType == Token.PCD_TYPE.DYNAMIC_EX) {
 223             tokenNumberString =  Long.toString(parentToken.dynamicExTokenNumber, 16);
 224         } else {
 225             tokenNumberString = Long.toString(parentToken.tokenNumber, 16);
 226         }
 227
 228         hAutogenStr += String.format("#define _PCD_TOKEN_%s  0x%s\r\n",
 229                                      parentToken.cName, tokenNumberString);
 230
 231         if (!isBuildUsedLibrary && !parentToken.isDynamicPCD) {
 232             if (datum.trim().charAt(0) == '{') {
 233                 isByteArray = true;
 234             }
 235         }
 236
 237         if (parentToken.datumType == Token.DATUM_TYPE.UINT64) {
 238             printDatum = this.datum + "ULL";
 239         } else {
 240             printDatum = this.datum;
 241         }
 242
 243         switch (modulePcdType) {
 244         case FEATURE_FLAG:
 245             hAutogenStr += String.format("extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n",
 246                                          parentToken.cName);
 247             hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  _gPcd_FixedAtBuild_%s\r\n",
 248                                          parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),
 249                                          parentToken.cName,
 250                                          parentToken.cName);
 251             hAutogenStr += String.format("//#define _PCD_SET_MODE_%s_%s ASSERT(FALSE) If is not allowed to set value for a FEATURE_FLAG PCD\r\n",
 252                                          parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),
 253                                          parentToken.cName);
 254
 255             if (!isBuildUsedLibrary) {
 256                 hAutogenStr += String.format("#define _PCD_VALUE_%s   %s\r\n",
 257                                              parentToken.cName,
 258                                              printDatum);
 259                 cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const BOOLEAN _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",
 260                                              parentToken.cName,
 261                                              parentToken.cName);
 262             }
 263             break;
 264         case FIXED_AT_BUILD:
 265             if (isByteArray) {
 266                 hAutogenStr += String.format("extern const UINT8 _gPcd_FixedAtBuild_%s[];\r\n",
 267                                              parentToken.cName);
 268                 hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  (VOID*)_gPcd_FixedAtBuild_%s\r\n",
 269                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
 270                                              parentToken.cName,
 271                                              parentToken.cName);
 272             } else {
 273                 hAutogenStr += String.format("extern const %s _gPcd_FixedAtBuild_%s;\r\n",
 274                                              Token.getAutogendatumTypeString(parentToken.datumType),
 275                                              parentToken.cName);
 276                 hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  _gPcd_FixedAtBuild_%s\r\n",
 277                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
 278                                              parentToken.cName,
 279                                              parentToken.cName);
 280             }
 281
 282             hAutogenStr += String.format("//#define _PCD_SET_MODE_%s_%s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\r\n",
 283                                          parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),
 284                                          parentToken.cName);
 285             if (!isBuildUsedLibrary) {
 286                 hAutogenStr += String.format("#define _PCD_VALUE_%s   %s\r\n",
 287                                              parentToken.cName,
 288                                              printDatum);
 289                 if (isByteArray) {
 290                     cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gPcd_FixedAtBuild_%s[] = _PCD_VALUE_%s;\r\n",
 291                                                  parentToken.cName,
 292                                                  parentToken.cName);
 293                 } else {
 294                     cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const %s _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",
 295                                                  Token.getAutogendatumTypeString(parentToken.datumType),
 296                                                  parentToken.cName,
 297                                                  parentToken.cName);
 298                 }
 299             }
 300             break;
 301         case PATCHABLE_IN_MODULE:
 302             if (isByteArray) {
 303                 hAutogenStr += String.format("extern UINT8 _gPcd_BinaryPatch_%s[];\r\n",
 304                                              parentToken.cName);
 305                 hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  (VOID*)_gPcd_BinaryPatch_%s\r\n",
 306                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
 307                                              parentToken.cName,
 308                                              parentToken.cName);
 309             } else {
 310                 hAutogenStr += String.format("extern %s _gPcd_BinaryPatch_%s;\r\n",
 311                                              Token.getAutogendatumTypeString(parentToken.datumType),
 312                                              parentToken.cName);
 313                 hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  _gPcd_BinaryPatch_%s\r\n",
 314                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
 315                                              parentToken.cName,
 316                                              parentToken.cName);
 317             }
 318
 319             //
 320             // Generate _PCD_SET_MODE_xx macro for using set BinaryPatch value via PcdSet macro
 321             //
 322             if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {
 323                 hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer) CopyMem (_gPcd_BinaryPatch_%s, (Buffer), (SizeOfBuffer))\r\n",
 324                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
 325                                              parentToken.cName,
 326                                              parentToken.cName);
 327             } else {
 328                 hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(Value) (_gPcd_BinaryPatch_%s = (Value))\r\n",
 329                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
 330                                              parentToken.cName,
 331                                              parentToken.cName);
 332             }
 333
 334             if (!isBuildUsedLibrary) {
 335                 hAutogenStr += String.format("#define _PCD_VALUE_%s   %s\r\n",
 336                                              parentToken.cName,
 337                                              printDatum);
 338                 if (isByteArray) {
 339                     cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED UINT8 _gPcd_BinaryPatch_%s[] = _PCD_VALUE_%s;\r\n",
 340                                                  parentToken.cName,
 341                                                  parentToken.cName);
 342                 } else {
 343                     cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED %s _gPcd_BinaryPatch_%s = _PCD_VALUE_%s;\r\n",
 344                                                  Token.getAutogendatumTypeString(parentToken.datumType),
 345                                                  parentToken.cName,
 346                                                  parentToken.cName);
 347                 }
 348             }
 349
 350             break;
 351         case DYNAMIC:
 352             hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  LibPcdGet%s(_PCD_TOKEN_%s)\r\n",
 353                                          Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
 354                                          parentToken.cName,
 355                                          Token.getAutogenLibrarydatumTypeString(parentToken.datumType),
 356                                          parentToken.cName);
 357             if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {
 358                 hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer)  LibPcdSet%s(_PCD_TOKEN_%s, (SizeOfBuffer), (Buffer))\r\n",
 359                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
 360                                              parentToken.cName,
 361                                              Token.getAutogenLibrarydatumTypeString(parentToken.datumType),
 362                                              parentToken.cName);
 363             } else {
 364                 hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(Value)  LibPcdSet%s(_PCD_TOKEN_%s, (Value))\r\n",
 365                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
 366                                              parentToken.cName,
 367                                              Token.getAutogenLibrarydatumTypeString(parentToken.datumType),
 368                                              parentToken.cName);
 369             }
 370             break;
 371         case DYNAMIC_EX:
 372             guidStringCName = "_gPcd_TokenSpaceGuid_" +
 373                               parentToken.tokenSpaceName.toString().replaceAll("-", "_");
 374
 375             hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s LibPcdGetEx%s(&%s, _PCD_TOKEN_%s)\r\n",
 376                                          Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
 377                                          parentToken.cName,
 378                                          Token.getAutogenLibrarydatumTypeString(parentToken.datumType),
 379                                          guidStringCName,
 380                                          parentToken.cName);
 381
 382             if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {
 383                 hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, _PCD_TOKEN_%s, (SizeOfBuffer), (Buffer))\r\n",
 384                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
 385                                              parentToken.cName,
 386                                              Token.getAutogenLibrarydatumTypeString(parentToken.datumType),
 387                                              guidStringCName,
 388                                              parentToken.cName);
 389             } else {
 390                 hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(Value) LibPcdSetEx%s(&%s, _PCD_TOKEN_%s, (Value))\r\n",
 391                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
 392                                              parentToken.cName,
 393                                              Token.getAutogenLibrarydatumTypeString(parentToken.datumType),
 394                                              guidStringCName,
 395                                              parentToken.cName);
 396
 397             }
 398             break;
 399         }
 400     }
 401
 402     /**
 403       Get the autogen string for header file.
 404
 405       @return The string of header file.
 406     **/
 407     public String getHAutogenStr() {
 408         return hAutogenStr;
 409     }
 410
 411     /**
 412       Get the autogen string for C code file.
 413
 414       @return The string of C Code file.
 415     **/
 416     public String getCAutogenStr() {
 417         return cAutogenStr;
 418     }
 419 }
 420