sys/sys/exec.h

   1 /*-
   2  * Copyright (c) 1992, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * (c) UNIX System Laboratories, Inc.
   5  * All or some portions of this file are derived from material licensed
   6  * to the University of California by American Telephone and Telegraph
   7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   8  * the permission of UNIX System Laboratories, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 4. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)exec.h      8.3 (Berkeley) 1/21/94
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _SYS_EXEC_H_
  39 #define _SYS_EXEC_H_
  40
  41 /*
  42  * The following structure is found at the top of the user stack of each
  43  * user process. The ps program uses it to locate argv and environment
  44  * strings. Programs that wish ps to display other information may modify
  45  * it; normally ps_argvstr points to the argv vector, and ps_nargvstr
  46  * is the same as the program's argc. The fields ps_envstr and ps_nenvstr
  47  * are the equivalent for the environment.
  48  */
  49 struct ps_strings {
  50         char    **ps_argvstr;   /* first of 0 or more argument strings */
  51         unsigned int ps_nargvstr; /* the number of argument strings */
  52         char    **ps_envstr;    /* first of 0 or more environment strings */
  53         unsigned int ps_nenvstr; /* the number of environment strings */
  54 };
  55
  56 /*
  57  * Address of ps_strings structure (in user space).
  58  */
  59 #define PS_STRINGS      (USRSTACK - sizeof(struct ps_strings))
  60 #define SPARE_USRSPACE  4096
  61
  62 struct image_params;
  63
  64 struct execsw {
  65         int (*ex_imgact)(struct image_params *);
  66         const char *ex_name;
  67 };
  68
  69 #include <machine/exec.h>
  70
  71 #ifdef _KERNEL
  72 #include <sys/cdefs.h>
  73
  74 int exec_map_first_page(struct image_params *);
  75 void exec_unmap_first_page(struct image_params *);
  76
  77 int exec_register(const struct execsw *);
  78 int exec_unregister(const struct execsw *);
  79
  80 /*
  81  * note: name##_mod cannot be const storage because the
  82  * linker_file_sysinit() function modifies _file in the
  83  * moduledata_t.
  84  */
  85
  86 #include <sys/module.h>
  87
  88 #define EXEC_SET(name, execsw_arg) \
  89         static int __CONCAT(name,_modevent)(module_t mod, int type, \
  90             void *data) \
  91         { \
  92                 struct execsw *exec = (struct execsw *)data; \
  93                 int error = 0; \
  94                 switch (type) { \
  95                 case MOD_LOAD: \
  96                         /* printf(#name " module loaded\n"); */ \
  97                         error = exec_register(exec); \
  98                         if (error) \
  99                                 printf(__XSTRING(name) "register failed\n"); \
 100                         break; \
 101                 case MOD_UNLOAD: \
 102                         /* printf(#name " module unloaded\n"); */ \
 103                         error = exec_unregister(exec); \
 104                         if (error) \
 105                                 printf(__XSTRING(name) " unregister failed\n");\
 106                         break; \
 107                 default: \
 108                         error = EOPNOTSUPP; \
 109                         break; \
 110                 } \
 111                 return error; \
 112         } \
 113         static moduledata_t __CONCAT(name,_mod) = { \
 114                 __XSTRING(name), \
 115                 __CONCAT(name,_modevent), \
 116                 (void *)& execsw_arg \
 117         }; \
 118         DECLARE_MODULE_TIED(name, __CONCAT(name,_mod), SI_SUB_EXEC, \
 119             SI_ORDER_ANY)
 120 #endif
 121
 122 #endif