BaseTools/BuildEnv

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