lib/libc/sys/exec_sys_register.2

   1 .\"
   2 .\" Copyright (c) 2016
   3 .\"     The DragonFly Project.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   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
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\" 3. Neither the name of The DragonFly Project nor the names of its
  16 .\"    contributors may be used to endorse or promote products derived
  17 .\"    from this software without specific, prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .Dd March 7, 2016
  33 .Dt EXEC_SYS_REGISTER 2
  34 .Os
  35 .Sh NAME
  36 .Nm exec_sys_register ,
  37 .Nm exec_sys_unregister
  38 .Nd register/unregister for resident execution
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In sys/resident.h
  43 .Ft int
  44 .Fn exec_sys_register "void *entry"
  45 .Ft int
  46 .Fn exec_sys_unregister "int id"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn exec_sys_register
  50 system call registers the binary of the calling process for resident
  51 execution.
  52 This snapshots the vmspace and causes future
  53 .Fn exec Ns s
  54 of the specified binary to use the snapshot directly rather than load
  55 and relocate a new copy.
  56 .Pp
  57 The
  58 .Fn exec_sys_unregister
  59 system call unregisters a resident binary identified by
  60 .Ar id ,
  61 or the binary of the calling process if
  62 .Ar id
  63 is -1 ,
  64 or all registered binaries if
  65 .Ar id
  66 is -2.
  67 .Pp
  68 Both can only be done by the superuser.
  69 .Sh RETURN VALUES
  70 .Rv -std exec_sys_register exec_sys_unregister
  71 .Sh ERRORS
  72 The
  73 .Fn exec_sys_register
  74 system call will fail if one of the following occurs:
  75 .Bl -tag -width Er
  76 .It Bq Er EEXIST
  77 The binary is already resident.
  78 .It Bq Er ENOENT
  79 No associated vnode exists.
  80 .It Bq Er EPERM
  81 The caller does not have sufficient permissions.
  82 .El
  83 .Pp
  84 The
  85 .Fn exec_sys_unregister
  86 system call will fail if one of the following occurs:
  87 .Bl -tag -width Er
  88 .It Bq Er ENOENT
  89 The specified
  90 .Fa id
  91 could not be found.
  92 .It Bq Er EPERM
  93 The caller does not have sufficient permissions.
  94 .El
  95 .Sh SEE ALSO
  96 .Xr resident 8
  97 .Sh HISTORY
  98 The
  99 .Nm
 100 and
 101 .Nm exec_sys_unregister
 102 system calls first appeared in
 103 .Dx 1.0 .
 104 .Sh AUTHORS
 105 .An -nosplit
 106 The
 107 .Nm
 108 and
 109 .Nm exec_sys_unregister
 110 system calls were written by
 111 .An Matthew Dillon
 112 and this manual page was written by
 113 .An Sascha Wildner .