sys/kern/genoffset.sh

   1 #!/bin/sh
   2
   3 # SPDX-License-Identifier: BSD-2-Clause
   4 #
   5 # Copyright (c) 2000, Bruce Evans <bde@freebsd.org>
   6 # Copyright (c) 2018, Jeff Roberson <jeff@freebsd.org>
   7 #
   8 # Redistribution and use in source and binary forms, with or without
   9 # modification, are permitted provided that the following conditions
  10 # are met:
  11 # 1. Redistributions of source code must retain the above copyright
  12 #    notice, this list of conditions and the following disclaimer.
  13 # 2. Redistributions in binary form must reproduce the above copyright
  14 #    notice, this list of conditions and the following disclaimer in the
  15 #    documentation and/or other materials provided with the distribution.
  16 #
  17 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 # SUCH DAMAGE.
  28 #
  29
  30 usage()
  31 {
  32         echo "usage: genoffset [-o outfile] objfile"
  33         exit 1
  34 }
  35
  36 work()
  37 (
  38     local last off x1 x2 x3 struct field type lastoff lasttype
  39
  40     echo "#ifndef _OFFSET_INC_"
  41     echo "#define _OFFSET_INC_"
  42     echo "#if !defined(GENOFFSET) && (!defined(KLD_MODULE) || defined(KLD_TIED))"
  43     last=
  44     temp=$(mktemp -d genoffset.XXXXXXXXXX)
  45     trap "rm -rf ${temp}" EXIT
  46     # Note: we need to print symbol values in decimal so the numeric sort works
  47     ${NM:='nm'} ${NMFLAGS} -t d "$1" | grep __assym_offset__ | sed -e 's/__/ /g' | sort -k 4 -k 1 -n |
  48     while read off x1 x2 struct field type x3; do
  49         off=$(echo "$off" | sed -E 's/^0+//')
  50         if [ "$last" != "$struct" ]; then
  51             if [ -n "$last" ]; then
  52                 echo "};"
  53             fi
  54             echo "struct ${struct}_lite {"
  55             last=$struct
  56             printf "%b" "\tu_char\tpad_${field}[${off}];\n"
  57         else
  58             printf "%b" "\tu_char\tpad_${field}[${off} - (${lastoff} + sizeof(${lasttype}))];\n"
  59         fi
  60         printf "%b" "\t${type}\t${field};\n"
  61         lastoff="$off"
  62         lasttype="$type"
  63         echo "_SA(${struct}, ${field}, ${off});" >> "$temp/asserts"
  64     done
  65     echo "};"
  66     echo "#define _SA(s,f,o) _Static_assert(__builtin_offsetof(struct s ## _lite, f) == o, \\"
  67     printf '\t"struct "#s"_lite field "#f" not at offset "#o)\n'
  68     cat "$temp/asserts"
  69     echo "#undef _SA"
  70     echo "#endif"
  71     echo "#endif"
  72 )
  73
  74
  75 #
  76 #MAIN PROGGRAM
  77 #
  78 use_outfile="no"
  79 while getopts "o:" option
  80 do
  81         case "$option" in
  82         o)      outfile="$OPTARG"
  83                 use_outfile="yes";;
  84         *)      usage;;
  85         esac
  86 done
  87 shift $((OPTIND - 1))
  88 case $# in
  89 1)      ;;
  90 *)      usage;;
  91 esac
  92
  93 if [ "$use_outfile" = "yes" ]
  94 then
  95         work "$1"  3>"$outfile" >&3 3>&-
  96 else
  97         work "$1"
  98 fi
  99