BaseTools/Source/Python/UPT/Logger/ToolError.py

   1 ## @file
   2 # Standardized Error Hanlding infrastructures.
   3 #
   4 # Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
   5 #
   6 # This program and the accompanying materials are licensed and made available
   7 # under the terms and conditions of the BSD License which accompanies this
   8 # distribution. The full text of the license may be found at
   9 # http://opensource.org/licenses/bsd-license.php
  10 #
  11 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13 #
  14
  15 '''
  16 ToolError
  17 '''
  18
  19 import Logger.StringTable as ST
  20
  21 FILE_OPEN_FAILURE = 1
  22 FILE_WRITE_FAILURE = 2
  23 FILE_PARSE_FAILURE = 3
  24 FILE_READ_FAILURE = 4
  25 FILE_CREATE_FAILURE = 5
  26 FILE_CHECKSUM_FAILURE = 6
  27 FILE_COMPRESS_FAILURE = 7
  28 FILE_DECOMPRESS_FAILURE = 8
  29 FILE_MOVE_FAILURE = 9
  30 FILE_DELETE_FAILURE = 10
  31 FILE_COPY_FAILURE = 11
  32 FILE_POSITIONING_FAILURE = 12
  33 FILE_ALREADY_EXIST = 13
  34 FILE_NOT_FOUND = 14
  35 FILE_TYPE_MISMATCH = 15
  36 FILE_CASE_MISMATCH = 16
  37 FILE_DUPLICATED = 17
  38 FILE_UNKNOWN_ERROR = 0x0FFF
  39
  40 OPTION_UNKNOWN = 0x1000
  41 OPTION_MISSING = 0x1001
  42 OPTION_CONFLICT = 0x1002
  43 OPTION_VALUE_INVALID = 0x1003
  44 OPTION_DEPRECATED = 0x1004
  45 OPTION_NOT_SUPPORTED = 0x1005
  46 OPTION_UNKNOWN_ERROR = 0x1FFF
  47
  48 PARAMETER_INVALID = 0x2000
  49 PARAMETER_MISSING = 0x2001
  50 PARAMETER_UNKNOWN_ERROR = 0x2FFF
  51
  52 FORMAT_INVALID = 0x3000
  53 FORMAT_NOT_SUPPORTED = 0x3001
  54 FORMAT_UNKNOWN = 0x3002
  55 FORMAT_UNKNOWN_ERROR = 0x3FFF
  56
  57 RESOURCE_NOT_AVAILABLE = 0x4000
  58 RESOURCE_ALLOCATE_FAILURE = 0x4001
  59 RESOURCE_FULL = 0x4002
  60 RESOURCE_OVERFLOW = 0x4003
  61 RESOURCE_UNDERRUN = 0x4004
  62 RESOURCE_UNKNOWN_ERROR = 0x4FFF
  63
  64 ATTRIBUTE_NOT_AVAILABLE = 0x5000
  65 ATTRIBUTE_GET_FAILURE = 0x5001
  66 ATTRIBUTE_SET_FAILURE = 0x5002
  67 ATTRIBUTE_UPDATE_FAILURE = 0x5003
  68 ATTRIBUTE_ACCESS_DENIED = 0x5004
  69 ATTRIBUTE_RETRIEVE_FAILURE = 0x5005
  70 ATTRIBUTE_UNKNOWN_ERROR = 0x5FFF
  71 ATTRIBUTE_RETRIEVE_FAILURE = 0x5F00
  72
  73 IO_NOT_READY = 0x6000
  74 IO_BUSY = 0x6001
  75 IO_TIMEOUT = 0x6002
  76 IO_UNKNOWN_ERROR = 0x6FFF
  77
  78 COMMAND_FAILURE = 0x7000
  79
  80 CODE_ERROR = 0xC0DE
  81
  82 AUTOGEN_ERROR = 0xF000
  83 PARSER_ERROR = 0xF001
  84 BUILD_ERROR = 0xF002
  85 GENFDS_ERROR = 0xF003
  86 ECC_ERROR = 0xF004
  87 EOT_ERROR = 0xF005
  88 DDC_ERROR = 0xF009
  89 WARNING_AS_ERROR = 0xF006
  90 MIGRATION_ERROR = 0xF010
  91 EDK1_INF_ERROR = 0xF011
  92 ABORT_ERROR = 0xFFFE
  93 UNKNOWN_ERROR = 0xFFFF
  94
  95 UPT_ALREADY_INSTALLED_ERROR = 0xD000
  96 UPT_ENVIRON_MISSING_ERROR = 0xD001
  97 UPT_REPKG_ERROR = 0xD002
  98 UPT_ALREADY_RUNNING_ERROR = 0xD003
  99 UPT_MUL_DEC_ERROR = 0xD004
 100 UPT_INI_PARSE_ERROR = 0xE000
 101
 102 ## Error message of each error code
 103 #
 104 gERROR_MESSAGE = {
 105     FILE_NOT_FOUND          :   ST.ERR_FILE_NOT_FOUND,
 106     FILE_OPEN_FAILURE       :   ST.ERR_FILE_OPEN_FAILURE,
 107     FILE_WRITE_FAILURE      :   ST.ERR_FILE_WRITE_FAILURE,
 108     FILE_PARSE_FAILURE      :   ST.ERR_FILE_PARSE_FAILURE,
 109     FILE_READ_FAILURE       :   ST.ERR_FILE_READ_FAILURE,
 110     FILE_CREATE_FAILURE     :   ST.ERR_FILE_CREATE_FAILURE,
 111     FILE_CHECKSUM_FAILURE   :   ST.ERR_FILE_CHECKSUM_FAILURE,
 112     FILE_COMPRESS_FAILURE   :   ST.ERR_FILE_COMPRESS_FAILURE,
 113     FILE_DECOMPRESS_FAILURE :   ST.ERR_FILE_DECOMPRESS_FAILURE,
 114     FILE_MOVE_FAILURE       :   ST.ERR_FILE_MOVE_FAILURE,
 115     FILE_DELETE_FAILURE     :   ST.ERR_FILE_DELETE_FAILURE,
 116     FILE_COPY_FAILURE       :   ST.ERR_FILE_COPY_FAILURE,
 117     FILE_POSITIONING_FAILURE:   ST.ERR_FILE_POSITIONING_FAILURE,
 118     FILE_ALREADY_EXIST      :   ST.ERR_FILE_ALREADY_EXIST,
 119     FILE_TYPE_MISMATCH      :   ST.ERR_FILE_TYPE_MISMATCH ,
 120     FILE_CASE_MISMATCH      :   ST.ERR_FILE_CASE_MISMATCH,
 121     FILE_DUPLICATED         :   ST.ERR_FILE_DUPLICATED,
 122     FILE_UNKNOWN_ERROR      :   ST.ERR_FILE_UNKNOWN_ERROR,
 123
 124     OPTION_UNKNOWN          :   ST.ERR_OPTION_UNKNOWN,
 125     OPTION_MISSING          :   ST.ERR_OPTION_MISSING,
 126     OPTION_CONFLICT         :   ST.ERR_OPTION_CONFLICT,
 127     OPTION_VALUE_INVALID    :   ST.ERR_OPTION_VALUE_INVALID,
 128     OPTION_DEPRECATED       :   ST.ERR_OPTION_DEPRECATED,
 129     OPTION_NOT_SUPPORTED    :   ST.ERR_OPTION_NOT_SUPPORTED,
 130     OPTION_UNKNOWN_ERROR    :   ST.ERR_OPTION_UNKNOWN_ERROR,
 131
 132     PARAMETER_INVALID       :   ST.ERR_PARAMETER_INVALID,
 133     PARAMETER_MISSING       :   ST.ERR_PARAMETER_MISSING,
 134     PARAMETER_UNKNOWN_ERROR :   ST.ERR_PARAMETER_UNKNOWN_ERROR,
 135
 136     FORMAT_INVALID          :   ST.ERR_FORMAT_INVALID,
 137     FORMAT_NOT_SUPPORTED    :   ST.ERR_FORMAT_NOT_SUPPORTED,
 138     FORMAT_UNKNOWN          :   ST.ERR_FORMAT_UNKNOWN,
 139     FORMAT_UNKNOWN_ERROR    :   ST.ERR_FORMAT_UNKNOWN_ERROR,
 140
 141     RESOURCE_NOT_AVAILABLE  :   ST.ERR_RESOURCE_NOT_AVAILABLE,
 142     RESOURCE_ALLOCATE_FAILURE : ST.ERR_RESOURCE_ALLOCATE_FAILURE,
 143     RESOURCE_FULL           :   ST.ERR_RESOURCE_FULL,
 144     RESOURCE_OVERFLOW       :   ST.ERR_RESOURCE_OVERFLOW,
 145     RESOURCE_UNDERRUN       :   ST.ERR_RESOURCE_UNDERRUN,
 146     RESOURCE_UNKNOWN_ERROR  :   ST.ERR_RESOURCE_UNKNOWN_ERROR,
 147
 148     ATTRIBUTE_NOT_AVAILABLE :   ST.ERR_ATTRIBUTE_NOT_AVAILABLE,
 149     ATTRIBUTE_RETRIEVE_FAILURE : ST.ERR_ATTRIBUTE_RETRIEVE_FAILURE,
 150     ATTRIBUTE_SET_FAILURE   :   ST.ERR_ATTRIBUTE_SET_FAILURE,
 151     ATTRIBUTE_UPDATE_FAILURE:   ST.ERR_ATTRIBUTE_UPDATE_FAILURE,
 152     ATTRIBUTE_ACCESS_DENIED :   ST.ERR_ATTRIBUTE_ACCESS_DENIED,
 153     ATTRIBUTE_UNKNOWN_ERROR :   ST.ERR_ATTRIBUTE_UNKNOWN_ERROR,
 154
 155     COMMAND_FAILURE         :   ST.ERR_COMMAND_FAILURE,
 156
 157     IO_NOT_READY            :   ST.ERR_IO_NOT_READY,
 158     IO_BUSY                 :   ST.ERR_IO_BUSY,
 159     IO_TIMEOUT              :   ST.ERR_IO_TIMEOUT,
 160     IO_UNKNOWN_ERROR        :   ST.ERR_IO_UNKNOWN_ERROR,
 161
 162     UNKNOWN_ERROR           :   ST.ERR_UNKNOWN_ERROR,
 163
 164     UPT_ALREADY_INSTALLED_ERROR : ST.ERR_UPT_ALREADY_INSTALLED_ERROR,
 165     UPT_ENVIRON_MISSING_ERROR   : ST.ERR_UPT_ENVIRON_MISSING_ERROR,
 166     UPT_REPKG_ERROR             : ST.ERR_UPT_REPKG_ERROR,
 167     UPT_ALREADY_RUNNING_ERROR   : ST.ERR_UPT_ALREADY_RUNNING_ERROR,
 168     UPT_MUL_DEC_ERROR           : ST.ERR_MUL_DEC_ERROR,
 169     UPT_INI_PARSE_ERROR     :   ST.ERR_UPT_INI_PARSE_ERROR,
 170 }
 171
 172 ## Exception indicating a fatal error
 173 #
 174 class FatalError(Exception):
 175     pass
 176