lib/libc/gen/gethostid.3

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)gethostid.3 8.1 (Berkeley) 6/2/93
  29 .\" $FreeBSD: src/lib/libc/compat-43/gethostid.3,v 1.5.2.6 2003/03/15 15:11:05 trhodes Exp $
  30 .\"
  31 .Dd November 26, 2016
  32 .Dt GETHOSTID 3
  33 .Os
  34 .Sh NAME
  35 .Nm gethostid ,
  36 .Nm sethostid
  37 .Nd get/set unique identifier of current host
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In unistd.h
  42 .Ft long
  43 .Fn gethostid void
  44 .Ft void
  45 .Fn sethostid "long hostid"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn sethostid
  49 function
  50 establishes a 32-bit identifier for the
  51 current processor that is intended to be unique among all
  52 .Ux
  53 systems in existence.  This is normally a DARPA Internet
  54 address for the local machine.  This call is allowed only to the
  55 super-user and is normally performed at boot time.
  56 .Pp
  57 The
  58 .Fn gethostid
  59 function
  60 returns the 32-bit identifier for the current processor.
  61 .Pp
  62 This function has been deprecated.
  63 The hostid should be set or retrieved by use of
  64 .Xr sysctl 3 .
  65 .Sh SEE ALSO
  66 .Xr gethostname 3 ,
  67 .Xr sysctl 3 ,
  68 .Xr sysctl 8
  69 .Sh HISTORY
  70 The
  71 .Fn gethostid
  72 and
  73 .Fn sethostid
  74 syscalls appeared in
  75 .Bx 4.2
  76 and were dropped in
  77 .Bx 4.4 .
  78 .Sh BUGS
  79 32 bits for the identifier is too small.