src/os2/dllar.sh

   1 #!/bin/sh
   2 #
   3 # dllar - a tool to build both a .dll and an .a file
   4 # from a set of object (.o) files for EMX/OS2.
   5 #
   6 #  Written by Andrew Zabolotny, bit@freya.etu.ru
   7 #  Ported to Unix like shell by Stefan Neis, Stefan.Neis@t-online.de
   8 #
   9 #  This script will accept a set of files on the command line.
  10 #  All the public symbols from the .o files will be exported into
  11 #  a .DEF file, then linker will be run (through gcc) against them to
  12 #  build a shared library consisting of all given .o files. All libraries
  13 #  (.a) will be first decompressed into component .o files then act as
  14 #  described above. You can optionally give a description (-d "description")
  15 #  which will be put into .DLL. To see the list of accepted options (as well
  16 #  as command-line format) simply run this program without options. The .DLL
  17 #  is built to be imported by name (there is no guarantee that new versions
  18 #  of the library you build will have same ordinals for same symbols).
  19 #
  20 #  dllar is free software; you can redistribute it and/or modify
  21 #  it under the terms of the GNU General Public License as published by
  22 #  the Free Software Foundation; either version 2, or (at your option)
  23 #  any later version.
  24 #
  25 #  dllar is distributed in the hope that it will be useful,
  26 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  27 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28 #  GNU General Public License for more details.
  29 #
  30 #  You should have received a copy of the GNU General Public License
  31 #  along with dllar; see the file COPYING.  If not, write to the Free
  32 #  Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  33 #  02111-1307, USA.
  34
  35 # To successfuly run this program you will need:
  36 #  - Current drive should have LFN support (HPFS, ext2, network, etc)
  37 #    (Sometimes dllar generates filenames which won't fit 8.3 scheme)
  38 #  - gcc
  39 #    (used to build the .dll)
  40 #  - emxexp
  41 #    (used to create .def file from .o files)
  42 #  - emximp
  43 #    (used to create .a file from .def file)
  44 #  - GNU text utilites (cat, sort, uniq)
  45 #    used to process emxexp output
  46 #  - GNU file utilities (mv, rm)
  47 #  - GNU sed
  48 #  - lxlite (optional, see flag below)
  49 #    (used for general .dll cleanup)
  50 #
  51
  52 flag_USE_LXLITE=1;
  53
  54 #
  55 # helper functions
  56 # basnam, variant of basename, which does _not_ remove the path, _iff_
  57 #                              second argument (suffix to remove) is given
  58 basnam(){
  59     case $# in
  60     1)
  61         echo $1 | sed 's/.*\///' | sed 's/.*\\//'
  62         ;;
  63     2)
  64         echo $1 | sed 's/'$2'$//'
  65         ;;
  66     *)
  67         echo "error in basnam $*"
  68         exit 8
  69         ;;
  70     esac
  71 }
  72
  73 # Cleanup temporary files and output
  74 CleanUp() {
  75     cd $curDir
  76     for i in $inputFiles ; do
  77         case $i in
  78         *!)
  79             rm -rf `basnam $i !`
  80             ;;
  81         *)
  82             ;;
  83         esac
  84     done
  85
  86     # Kill result in case of failure as there is just to many stupid make/nmake
  87     # things out there which doesn't do this.
  88     if [ $# -eq 0 ]; then
  89         rm -f "${outFile}.a" "${outFile}.def" "${outFile}.dll"
  90     fi
  91 }
  92
  93 # Print usage and exit script with rc=1.
  94 PrintHelp() {
  95  echo 'Usage: dllar [-o[utput] output_file] [-d[escription] "dll descrption"]'
  96  echo '       [-cc "CC"] [-f[lags] "CFLAGS"] [-ord[inals]] -ex[clude] "symbol(s)"'
  97  echo '       [-libf[lags] "{INIT|TERM}{GLOBAL|INSTANCE}"] [-nocrt[dll]] [-nolxl[ite]]'
  98  echo '       [*.o] [*.a]'
  99  echo '*> "output_file" should have no extension.'
 100  echo '   If it has the .o, .a or .dll extension, it is automatically removed.'
 101  echo '   The import library name is derived from this and is set to "name".a.'
 102  echo '*> "cc" is used to use another GCC executable.   (default: gcc.exe)'
 103  echo '*> "flags" should be any set of valid GCC flags. (default: -s -Zcrtdll)'
 104  echo '   These flags will be put at the start of GCC command line.'
 105  echo '*> -ord[inals] tells dllar to export entries by ordinals. Be careful.'
 106  echo '*> -ex[clude] defines symbols which will not be exported. You can define'
 107  echo '   multiple symbols, for example -ex "myfunc yourfunc _GLOBAL*".'
 108  echo '   If the last character of a symbol is "*", all symbols beginning'
 109  echo '   with the prefix before "*" will be exclude, (see _GLOBAL* above).'
 110  echo '*> -libf[lags] can be used to add INITGLOBAL/INITINSTANCE and/or'
 111  echo '   TERMGLOBAL/TERMINSTANCE flags to the dynamically-linked library.'
 112  echo '*> -nocrt[dll] switch will disable linking the library against emx''s'
 113  echo '   C runtime DLLs.'
 114  echo '*> -nolxl[ite] switch will disable running lxlite on the resulting DLL.'
 115  echo '*> All other switches (for example -L./ or -lmylib) will be passed'
 116  echo '   unchanged to GCC at the end of command line.'
 117  echo '*> If you create a DLL from a library and you do not specify -o,'
 118  echo '   the basename for DLL and import library will be set to library name,'
 119  echo '   the initial library will be renamed to 'name'_s.a (_s for static)'
 120  echo '   i.e. "dllar gcc.a" will create gcc.dll and gcc.a, and the initial'
 121  echo '   library will be renamed into gcc_s.a.'
 122  echo '--------'
 123  echo 'Example:'
 124  echo '   dllar -o gcc290.dll libgcc.a -d "GNU C runtime library" -ord'
 125  echo '    -ex "__main __ctordtor*" -libf "INITINSTANCE TERMINSTANCE"'
 126  CleanUp
 127  exit 1
 128 }
 129
 130 # Execute a command.
 131 # If exit code of the commnad <> 0 CleanUp() is called and we'll exit the script.
 132 # @Uses    Whatever CleanUp() uses.
 133 doCommand() {
 134     echo "$*"
 135     eval $*
 136     rcCmd=$?
 137
 138     if [ $rcCmd -ne 0 ]; then
 139         echo "command failed, exit code="$rcCmd
 140         CleanUp
 141         exit $rcCmd
 142     fi
 143 }
 144
 145 # main routine
 146 # setup globals
 147 cmdLine=$*
 148 outFile=""
 149 inputFiles=""
 150 description=""
 151 CC=gcc.exe
 152 CFLAGS="-s -Zcrtdll"
 153 EXTRA_CFLAGS=""
 154 EXPORT_BY_ORDINALS=0
 155 exclude_symbols=""
 156 library_flags=""
 157 curDir=`pwd`
 158 curDirS=curDir
 159 case $curDirS in
 160 */)
 161   ;;
 162 *)
 163   curDirS=${curDirS}"/"
 164   ;;
 165 esac
 166 # Parse commandline
 167 libsToLink=0
 168 while [ $1 ]; do
 169     case $1 in
 170     -ord*)
 171         EXPORT_BY_ORDINALS=1;
 172         ;;
 173     -o*)
 174         shift
 175         outFile=$1
 176         ;;
 177     -d*)
 178         shift
 179         description=$1
 180         ;;
 181     -f*)
 182         shift
 183         CFLAGS=$1
 184         ;;
 185     -c*)
 186         shift
 187         CC=$1
 188         ;;
 189     -h*)
 190         PrintHelp
 191         ;;
 192     -ex*)
 193         shift
 194         exclude_symbols=${exclude_symbols}$1" "
 195         ;;
 196     -libf*)
 197         shift
 198         library_flags=${library_flags}$1" "
 199         ;;
 200     -nocrt*)
 201         CFLAGS="-s"
 202         ;;
 203     -nolxl*)
 204         flag_USE_LXLITE=0
 205         ;;
 206     -* | /* | *.dll)
 207         case $1 in
 208         -L* | -l*)
 209             libsToLink=1
 210             ;;
 211         *)
 212             ;;
 213         esac
 214         EXTRA_CFLAGS=${EXTRA_CFLAGS}" "$1
 215         ;;
 216     *)
 217         found=0;
 218         if [ $libsToLink -ne 0 ]; then
 219             EXTRA_CFLAGS=${EXTRA_CFLAGS}" "$1
 220         else
 221             for file in $1 ; do
 222                 if [ -f $file ]; then
 223                     inputFiles="${inputFiles} $file"
 224                     found=1
 225                 fi
 226             done
 227             if [ $found -eq 0 ]; then
 228                 echo "ERROR: No file(s) found: "$1
 229                 exit 8
 230             fi
 231         fi
 232       ;;
 233     esac
 234     shift
 235 done # iterate cmdline words
 236
 237 #
 238 if [ -z "$inputFiles" ]; then
 239     echo "dllar: no input files"
 240     PrintHelp
 241 fi
 242
 243 # Now extract all .o files from .a files
 244 newInputFiles=""
 245 for file in $inputFiles ; do
 246     case $file in
 247     *.a | *.lib)
 248         case $file in
 249         *.a)
 250             suffix=".a"
 251             AR="ar"
 252             ;;
 253         *.lib)
 254             suffix=".lib"
 255             AR="emxomfar"
 256             ;;
 257         *)
 258             ;;
 259         esac
 260         dirname=`basnam $file $suffix`"_%"
 261         mkdir $dirname
 262         if [ $? -ne 0 ]; then
 263             echo "Failed to create subdirectory ./$dirname"
 264             CleanUp
 265             exit 8;
 266         fi
 267         # Append '!' to indicate archive
 268         newInputFiles="$newInputFiles ${dirname}!"
 269         doCommand "cd $dirname; $AR x ../$file"
 270         cd $curDir
 271         found=0;
 272         for subfile in $dirname/*.o ; do
 273             if [ -f $subfile ]; then
 274                 found=1
 275                 if [ -s $subfile ]; then
 276                     # FIXME: This should be: is file size > 32 byte, _not_ > 0!
 277                     newInputFiles="$newInputFiles $subname"
 278                 fi
 279             fi
 280         done
 281         if [ $found -eq 0 ]; then
 282             echo "WARNING: there are no files in archive \'$file\'"
 283         fi
 284         ;;
 285     *)
 286         newInputFiles="${newInputFiles} $file"
 287         ;;
 288     esac
 289 done
 290 inputFiles="$newInputFiles"
 291
 292 # Output filename(s).
 293 do_backup=0;
 294 if [ -z $outFile ]; then
 295     do_backup=1;
 296     set outFile $inputFiles; outFile=$2
 297 fi
 298
 299 # If it is an archive, remove the '!' and the '_%' suffixes
 300 case $outFile in
 301 *_%!)
 302     outFile=`basnam $outFile _%!`
 303     ;;
 304 *)
 305     ;;
 306 esac
 307 case $outFile in
 308 *.dll)
 309     outFile=`basnam $outFile .dll`
 310     ;;
 311 *.DLL)
 312     outFile=`basnam $outFile .DLL`
 313     ;;
 314 *.o)
 315     outFile=`basnam $outFile .o`
 316     ;;
 317 *.obj)
 318     outFile=`basnam $outFile .obj`
 319     ;;
 320 *.a)
 321     outFile=`basnam $outFile .a`
 322     ;;
 323 *.lib)
 324     outFile=`basnam $outFile .lib`
 325     ;;
 326 *)
 327     ;;
 328 esac
 329 defFile="${outFile}.def"
 330 dllFile="${outFile}.dll"
 331 arcFile="${outFile}.a"
 332
 333 if [ $do_backup -ne 0 -a -f $arcFile ] ; then
 334     doCommand "mv $arcFile ${outFile}_s.a"
 335 fi
 336
 337 # Extract public symbols from all the object files.
 338 tmpdefFile=${defFile}_%
 339 rm -f $tmpdefFile
 340 for file in $inputFiles ; do
 341     case $file in
 342     *!)
 343         ;;
 344     *)
 345         doCommand "emxexp -u $file >> $tmpdefFile"
 346         ;;
 347     esac
 348 done
 349
 350 # Create the def file.
 351 rm -f $defFile
 352 libName=`basnam $outFile`
 353 echo "LIBRARY `echo $libName | sed 's/\./_/'` $library_flags" >> $defFile
 354 if [ -n $description ]; then
 355     echo "DESCRIPTION  \"${description}\"" >> $defFile
 356 fi
 357 echo "EXPORTS" >> $defFile
 358
 359 doCommand "cat $tmpdefFile | sort.exe | uniq.exe > ${tmpdefFile}%"
 360 grep -v "^ *;" < ${tmpdefFile}% | grep -v "^ *$" >$tmpdefFile
 361
 362 # Checks if the export is ok or not.
 363 for word in $exclude_symbols; do
 364     grep -v $word < $tmpdefFile >${tmpdefFile}%
 365     mv ${tmpdefFile}% $tmpdefFile
 366 done
 367
 368
 369 if [ $EXPORT_BY_ORDINALS -ne 0 ]; then
 370     sed "=" < $tmpdefFile | \
 371     sed '
 372       N
 373       : loop
 374       s/^\([0-9]\+\)\([^;]*\)\(;.*\)\?/\2 @\1 NONAME/
 375       t loop
 376     ' > ${tmpdefFile}%
 377     grep -v "^ *$" < ${tmpdefFile}% > $tmpdefFile
 378 else
 379     rm -f ${tmpdefFile}%
 380 fi
 381 cat $tmpdefFile >> $defFile
 382 rm -f $tmpdefFile
 383
 384 # Do linking, create implib, and apply lxlite.
 385 gccCmdl="";
 386 for file in $inputFiles ; do
 387     case $file in
 388     *!)
 389         ;;
 390     *)
 391         gccCmdl="$gccCmdl $file"
 392         ;;
 393     esac
 394 done
 395 doCommand "$CC $CFLAGS -Zdll -o $dllFile $defFile $gccCmdl $EXTRA_CFLAGS"
 396
 397 doCommand "emximp -o $arcFile $defFile"
 398 if [ $flag_USE_LXLITE -ne 0 ]; then
 399     add_flags="";
 400     if [ $EXPORT_BY_ORDINALS -ne 0 ]; then
 401         add_flags="-ynd"
 402     fi
 403     doCommand "lxlite -cs -t: -mrn -mln $add_flags $dllFile"
 404 fi
 405
 406 # Successful exit.
 407 CleanUp 1
 408 exit 0