The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/imgact_binmisc.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
    3  *
    4  * Copyright (c) 2013 Stacey D. Son
    5  *
    6  * Redistribution and use in source and binary forms, with or without
    7  * modification, are permitted provided that the following conditions
    8  * are met:
    9  * 1. Redistributions of source code must retain the above copyright
   10  *    notice, this list of conditions and the following disclaimer.
   11  * 2. Redistributions in binary form must reproduce the above copyright
   12  *    notice, this list of conditions and the following disclaimer in the
   13  *    documentation and/or other materials provided with the distribution.
   14  *
   15  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   25  * SUCH DAMAGE.
   26  *
   27  * $FreeBSD: stable/12/sys/sys/imgact_binmisc.h 326823 2017-12-13 16:13:17Z pfg $
   28  */
   29 
   30 #ifndef _IMGACT_BINMISC_H_
   31 #define _IMGACT_BINMISC_H_
   32 
   33 /**
   34  * Miscellaneous binary interpreter image activator.
   35  */
   36 
   37 #include <sys/param.h>  /* for MAXPATHLEN */
   38 
   39 /*
   40  * Imgact bin misc parameters.
   41  */
   42 #define IBE_VERSION     1       /* struct ximgact_binmisc_entry version. */
   43 #define IBE_NAME_MAX    32      /* Max size for entry name. */
   44 #define IBE_MAGIC_MAX   256     /* Max size for header magic and mask. */
   45 #define IBE_ARG_LEN_MAX 256     /* Max space for optional interpreter command-
   46                                    line arguments separated by white space */
   47 #define IBE_INTERP_LEN_MAX      (MAXPATHLEN + IBE_ARG_LEN_MAX)
   48 #define IBE_MAX_ENTRIES 64      /* Max number of interpreter entries. */
   49 
   50 /*
   51  * Imgact bin misc interpreter entry flags.
   52  */
   53 #define IBF_ENABLED     0x0001  /* Entry is active. */
   54 #define IBF_USE_MASK    0x0002  /* Use mask on header magic field. */
   55 
   56 /*
   57  * Used with sysctlbyname() to pass imgact bin misc entries in and out of the
   58  * kernel.
   59  */
   60 typedef struct ximgact_binmisc_entry {
   61         uint32_t xbe_version;   /* Struct version(IBE_VERSION) */
   62         uint32_t xbe_flags;     /* Entry flags (IBF_*) */
   63         uint32_t xbe_moffset;   /* Magic offset in header */
   64         uint32_t xbe_msize;     /* Magic size */
   65         uint32_t spare[3];      /* Spare fields for future use */
   66         char xbe_name[IBE_NAME_MAX];    /* Unique interpreter name */
   67         char xbe_interpreter[IBE_INTERP_LEN_MAX]; /* Interpreter path + args */
   68         uint8_t xbe_magic[IBE_MAGIC_MAX]; /* Header Magic */
   69         uint8_t xbe_mask[IBE_MAGIC_MAX]; /* Magic Mask */
   70 } ximgact_binmisc_entry_t;
   71 
   72 /*
   73  * sysctl() command names.
   74  */
   75 #define IBE_SYSCTL_NAME         "kern.binmisc"
   76 
   77 #define IBE_SYSCTL_NAME_ADD     IBE_SYSCTL_NAME ".add"
   78 #define IBE_SYSCTL_NAME_REMOVE  IBE_SYSCTL_NAME ".remove"
   79 #define IBE_SYSCTL_NAME_DISABLE IBE_SYSCTL_NAME ".disable"
   80 #define IBE_SYSCTL_NAME_ENABLE  IBE_SYSCTL_NAME ".enable"
   81 #define IBE_SYSCTL_NAME_LOOKUP  IBE_SYSCTL_NAME ".lookup"
   82 #define IBE_SYSCTL_NAME_LIST    IBE_SYSCTL_NAME ".list"
   83 
   84 #define KMOD_NAME       "imgact_binmisc"
   85 
   86 /*
   87  * Examples of manipulating the interpreter table using sysctlbyname(3):
   88  *
   89  * #include <sys/imgact_binmisc.h>
   90  *
   91  * #define LLVM_MAGIC  "BC\xc0\xde"
   92  *
   93  * #define MIPS64_ELF_MAGIC     "\x7f\x45\x4c\x46\x02\x02\x01\x00\x00\x00" \
   94  *                              "\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08"
   95  * #define MIPS64_ELF_MASK      "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff" \
   96  *                              "\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff"
   97  *
   98  * ximgact_binmisc_entry_t xbe, *xbep, out_xbe;
   99  * size_t size = 0, osize;
  100  * int error, i;
  101  *
  102  * // Add image activator for LLVM byte code
  103  * bzero(&xbe, sizeof(xbe));
  104  * xbe.xbe_version = IBE_VERSION;
  105  * xbe.xbe_flags = IBF_ENABLED;
  106  * strlcpy(xbe.xbe_name, "llvm_bc", IBE_NAME_MAX);
  107  * strlcpy(xbe.xbe_interpreter, "/usr/bin/lli --fake-arg0=#a",
  108  *     IBE_INTERP_LEN_MAX);
  109  * xbe.xbe_moffset = 0;
  110  * xbe.xbe_msize = 4;
  111  * memcpy(xbe.xbe_magic, LLVM_MAGIC, xbe.xbe_msize);
  112  * error = sysctlbyname(IBE_SYSCTL_NAME_ADD, NULL, NULL, &xbe, sizeof(xbe));
  113  *
  114  * // Add image activator for mips64 ELF binaries to use qemu user mode
  115  * bzero(&xbe, sizeof(xbe));
  116  * xbe.xbe_version = IBE_VERSION;
  117  * xbe.xbe_flags = IBF_ENABLED | IBF_USE_MASK;
  118  * strlcpy(xbe.xbe_name, "mips64elf", IBE_NAME_MAX);
  119  * strlcpy(xbe.xbe_interpreter, "/usr/local/bin/qemu-mips64",
  120  *      IBE_INTERP_LEN_MAX);
  121  * xbe.xbe_moffset = 0;
  122  * xbe.xbe_msize = 20;
  123  * memcpy(xbe.xbe_magic, MIPS64_ELF_MAGIC, xbe.xbe_msize);
  124  * memcpy(xbe.xbe_mask, MIPS64_ELF_MASK, xbe.xbe_msize);
  125  * sysctlbyname(IBE_SYSCTL_NAME_ADD, NULL, NULL, &xbe, sizeof(xbe));
  126  *
  127  * // Disable (OR Enable OR Remove) image activator for LLVM byte code
  128  * bzero(&xbe, sizeof(xbe));
  129  * xbe.xbe_version = IBE_VERSION;
  130  * strlcpy(xbe.xbe_name, "llvm_bc", IBE_NAME_MAX);
  131  * error = sysctlbyname(IBE_SYSCTL_NAME_DISABLE, NULL, NULL, &xbe, sizeof(xbe));
  132  * // OR sysctlbyname(IBE_SYSCTL_NAME_ENABLE, NULL, NULL, &xbe, sizeof(xbe));
  133  * // OR sysctlbyname(IBE_SYSCTL_NAME_REMOVE, NULL, NULL, &xbe, sizeof(xbe));
  134  *
  135  * // Lookup image activator  "llvm_bc"
  136  * bzero(&xbe, sizeof(xbe));
  137  * xbe.xbe_version = IBE_VERSION;
  138  * strlcpy(xbe.xbe_name, "llvm_bc", IBE_NAME_MAX);
  139  * size = sizeof(out_xbe);
  140  * error = sysctlbyname(IBE_SYSCTL_NAME_LOOKUP, &out_xbe, &size, &xbe,
  141  *      sizeof(xbe));
  142  *
  143  * // Get all the currently configured image activators and report
  144  * error = sysctlbyname(IBE_SYSCTL_NAME_LIST, NULL, &size, NULL, 0);
  145  * if (0 == error && size > 0) {
  146  *      xbep = malloc(size);
  147  *      while(1) {
  148  *          osize = size;
  149  *          error = sysctlbyname("kern.binmisc.list", xbep, &size, NULL, 0);
  150  *          if (-1 == error && ENOMEM == errno && size == osize) {
  151  *              // The buffer too small and needs to grow
  152  *              size += sizeof(xbe);
  153  *              xbep = realloc(xbep, size);
  154  *          } else
  155  *              break;
  156  *      }
  157  * }
  158  * for(i = 0; i < (size / sizeof(xbe)); i++, xbep++)
  159  *      printf("name: %s interpreter: %s flags: %s %s\n", xbep->xbe_name,
  160  *          xbep->xbe_interpreter, (xbep->xbe_flags & IBF_ENABLED) ?
  161  *          "ENABLED" : "", (xbep->xbe_flags & IBF_ENABLED) ? "USE_MASK" : "");
  162  *
  163  * The sysctlbyname() calls above may return the following errors in addition
  164  * to the standard ones:
  165  *
  166  * [EINVAL]  Invalid argument in the input ximgact_binmisc_entry_t structure.
  167  * [EEXIST]  Interpreter entry for given name already exist in kernel list.
  168  * [ENOMEM]  Allocating memory in the kernel failed or, in the case of
  169  *           kern.binmisc.list, the user buffer is too small.
  170  * [ENOENT]  Interpreter entry for given name is not found.
  171  * [ENOSPC]  Attempted to exceed maximum number of entries (IBE_MAX_ENTRIES).
  172  */
  173 
  174 #endif /* !_IMGACT_BINMISC_H_ */

Cache object: b4ae4e69f7caa291dbd5a38f4d867c44


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.