BaseTools/BuildEnv

   1 #
   2 # Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
   3 # This program and the accompanying materials
   4 # are licensed and made available under the terms and conditions of the BSD License
   5 # which accompanies this distribution.  The full text of the license may be found at
   6 # http://opensource.org/licenses/bsd-license.php
   7 #
   8 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   9 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  10
  11 #
  12 # Setup the environment for unix-like systems running a bash-like shell.
  13 # This file must be "sourced" not merely executed. For example: ". edksetup.sh"
  14 #
  15
  16 SetWorkspace() {
  17
  18   #
  19   # If WORKSPACE is already set, then we can return right now
  20   #
  21   if [ -n "$WORKSPACE" ]
  22   then
  23     return 0
  24   fi
  25
  26   #
  27   # Set $WORKSPACE
  28   #
  29   export WORKSPACE=`pwd`
  30
  31   return 0
  32
  33 }
  34
  35 RestorePreviousConfiguration() {
  36   #
  37   # Restore previous configuration
  38   #
  39   PREVIOUS_CONF_FILE=Conf/BuildEnv.sh
  40   if [ -e $PREVIOUS_CONF_FILE ]
  41   then
  42     echo Loading previous configuration from \$WORKSPACE/$PREVIOUS_CONF_FILE
  43     . $WORKSPACE/$PREVIOUS_CONF_FILE
  44   fi
  45 }
  46
  47 GenerateShellCodeToSetVariable() {
  48   VARIABLE=$1
  49   OUTPUT_FILE=$2
  50   VAR_VALUE="echo \${${VARIABLE}}"
  51   VAR_VALUE=`eval $VAR_VALUE`
  52   echo "if [ -z \"\$${VARIABLE}\" ]"             >> $OUTPUT_FILE
  53   echo "then"                                    >> $OUTPUT_FILE
  54   echo "  export ${VARIABLE}=${VAR_VALUE}"       >> $OUTPUT_FILE
  55   echo "fi"                                      >> $OUTPUT_FILE
  56 }
  57
  58 GenerateShellCodeToUpdatePath() {
  59   OUTPUT_FILE=$1
  60   echo "if [ -e $EDK_TOOLS_PATH_BIN ]"                        >> $OUTPUT_FILE
  61   echo "then"                                                 >> $OUTPUT_FILE
  62   echo "  if [ "\${PATH/$EDK_TOOLS_PATH_BIN/}" == "\$PATH" ]" >> $OUTPUT_FILE
  63   echo "  then"                                               >> $OUTPUT_FILE
  64   echo "    export PATH=$EDK_TOOLS_PATH_BIN:\$PATH"           >> $OUTPUT_FILE
  65   echo "  fi"                                                 >> $OUTPUT_FILE
  66   echo "fi"                                                   >> $OUTPUT_FILE
  67 }
  68
  69 StoreCurrentConfiguration() {
  70   #
  71   # Write configuration to a shell script to allow for configuration to be
  72   # easily reloaded.
  73   #
  74   OUTPUT_FILE=Conf/BuildEnv.sh
  75   #echo Storing current configuration into \$WORKSPACE/$OUTPUT_FILE
  76   OUTPUT_FILE=$WORKSPACE/$OUTPUT_FILE
  77   echo "# Auto-generated by ${BASH_SOURCE[0]}" > $OUTPUT_FILE
  78   GenerateShellCodeToSetVariable WORKSPACE $OUTPUT_FILE
  79   GenerateShellCodeToSetVariable EDK_TOOLS_PATH $OUTPUT_FILE
  80   GenerateShellCodeToUpdatePath $OUTPUT_FILE
  81 }
  82
  83 SetEdkToolsPath() {
  84
  85   #
  86   # If EDK_TOOLS_PATH is already set, then we can return right now
  87   #
  88   if [ -n "$EDK_TOOLS_PATH" ]
  89   then
  90     return 0
  91   fi
  92
  93   #
  94   # Try $WORKSPACE/Conf/EdkTools
  95   #
  96   if [ -e $WORKSPACE/Conf/EdkTools ]
  97   then
  98     export EDK_TOOLS_PATH=$WORKSPACE/Conf/EdkTools
  99     return 0
 100   fi
 101
 102   #
 103   # Try $WORKSPACE/Conf/BaseToolsSource
 104   #
 105   if [ -e $WORKSPACE/Conf/BaseToolsSource ]
 106   then
 107     export EDK_TOOLS_PATH=$WORKSPACE/Conf/BaseToolsSource
 108     return 0
 109   fi
 110
 111   #
 112   # Try $WORKSPACE/BaseTools
 113   #
 114   if [ -e $WORKSPACE/BaseTools ]
 115   then
 116     export EDK_TOOLS_PATH=$WORKSPACE/BaseTools
 117     return 0
 118   fi
 119
 120   echo "Unable to determine EDK_TOOLS_PATH"
 121   echo
 122   echo "You may need to download the 'BaseTools' from buildtools.tianocore.org."
 123   echo "After downloading, either create a symbolic link to the source at"
 124   echo "\$WORKSPACE/Conf/BaseToolsSource, or set the EDK_TOOLS_PATH environment"
 125   echo "variable."
 126
 127 }
 128
 129 GetBaseToolsBinSubDir() {
 130   #
 131   # Figure out a uniq directory name from the uname command
 132   #
 133   UNAME_DIRNAME=`uname -sm`
 134   UNAME_DIRNAME=${UNAME_DIRNAME// /-}
 135   UNAME_DIRNAME=${UNAME_DIRNAME//\//-}
 136   echo $UNAME_DIRNAME
 137 }
 138
 139 GetEdkToolsPathBinDirectory() {
 140   #
 141   # Figure out a uniq directory name from the uname command
 142   #
 143   BIN_SUB_DIR=`GetBaseToolsBinSubDir`
 144
 145   if [ -e $EDK_TOOLS_PATH/BinWrappers/$BIN_SUB_DIR ]
 146   then
 147     EDK_TOOLS_PATH_BIN=$EDK_TOOLS_PATH/BinWrappers/$BIN_SUB_DIR
 148   else
 149     EDK_TOOLS_PATH_BIN=$EDK_TOOLS_PATH/Bin/$BIN_SUB_DIR
 150   fi
 151
 152   echo $EDK_TOOLS_PATH_BIN
 153 }
 154
 155 AddDirToStartOfPath() {
 156   DIRNAME=$1
 157   PATH=$DIRNAME:$DIRNAME:$DIRNAME:$PATH
 158   PATH=${PATH//$DIRNAME:/}
 159   PATH=$DIRNAME:$PATH
 160   export PATH
 161 }
 162
 163 AddEdkToolsToPath() {
 164
 165   #
 166   # If EDK_TOOLS_PATH is not set, then we cannot update PATH
 167   #
 168   if [ -z "$EDK_TOOLS_PATH" ]
 169   then
 170     return 1
 171   fi
 172
 173   EDK_TOOLS_PATH_BIN=`GetEdkToolsPathBinDirectory`
 174
 175   AddDirToStartOfPath $EDK_TOOLS_PATH/BinWrappers/PosixLike
 176   AddDirToStartOfPath $EDK_TOOLS_PATH_BIN
 177
 178 }
 179
 180 CopySingleTemplateFile() {
 181
 182   SRC_FILENAME=Conf/$1.template
 183   DST_FILENAME=Conf/$1.txt
 184
 185   if [ -e $WORKSPACE/$DST_FILENAME ]
 186   then
 187     return
 188   fi
 189
 190   echo "Copying \$EDK_TOOLS_PATH/$SRC_FILENAME"
 191   echo "     to \$WORKSPACE/$DST_FILENAME"
 192   SRC_FILENAME=$EDK_TOOLS_PATH/$SRC_FILENAME
 193   DST_FILENAME=$WORKSPACE/$DST_FILENAME
 194   cp $SRC_FILENAME $DST_FILENAME
 195
 196 }
 197
 198 CopyTemplateFiles() {
 199
 200   CopySingleTemplateFile build_rule
 201   CopySingleTemplateFile tools_def
 202   CopySingleTemplateFile target
 203
 204 }
 205
 206 ScriptMain() {
 207
 208   SetWorkspace
 209   if [ -z $WORKSPACE ]
 210   then
 211     echo "Failure setting WORKSPACE"
 212     return 1
 213   fi
 214
 215   RestorePreviousConfiguration
 216
 217   SetEdkToolsPath
 218   if [ -z $EDK_TOOLS_PATH ]
 219   then
 220     return 1
 221   fi
 222
 223   AddEdkToolsToPath
 224   if [ $? -ne 0 ]
 225   then
 226     echo "Failure adding EDK Tools into PATH!"
 227     return 1
 228   fi
 229
 230   StoreCurrentConfiguration
 231
 232   echo WORKSPACE: $WORKSPACE
 233   echo EDK_TOOLS_PATH: $EDK_TOOLS_PATH
 234
 235   CopyTemplateFiles
 236
 237 }
 238
 239 #
 240 # Run the main function
 241 #
 242 ScriptMain
 243