include/utmpx.h

   1 /*
   2  * Copyright (c) 2004-2006 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*      $NetBSD: utmpx.h,v 1.11 2003/08/26 16:48:32 wiz Exp $    */
  24
  25 /*-
  26  * Copyright (c) 2002 The NetBSD Foundation, Inc.
  27  * All rights reserved.
  28  *
  29  * This code is derived from software contributed to The NetBSD Foundation
  30  * by Christos Zoulas.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice, this list of conditions and the following disclaimer.
  37  * 2. Redistributions in binary form must reproduce the above copyright
  38  *    notice, this list of conditions and the following disclaimer in the
  39  *    documentation and/or other materials provided with the distribution.
  40  * 3. All advertising materials mentioning features or use of this software
  41  *    must display the following acknowledgement:
  42  *        This product includes software developed by the NetBSD
  43  *        Foundation, Inc. and its contributors.
  44  * 4. Neither the name of The NetBSD Foundation nor the names of its
  45  *    contributors may be used to endorse or promote products derived
  46  *    from this software without specific prior written permission.
  47  *
  48  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  49  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  50  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  51  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  52  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  53  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  54  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  55  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  56  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  57  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  58  * POSSIBILITY OF SUCH DAMAGE.
  59  */
  60 #ifndef _UTMPX_H_
  61 #define _UTMPX_H_
  62
  63 #include <_types.h>
  64 #include <sys/time.h>
  65 #include <sys/cdefs.h>
  66 #include <Availability.h>
  67
  68 #ifndef _PID_T
  69 #define _PID_T
  70 typedef __darwin_pid_t     pid_t;
  71 #endif
  72
  73 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
  74 #ifndef _UID_T
  75 #define _UID_T
  76 typedef __darwin_uid_t     uid_t;
  77 #endif
  78 #endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */
  79
  80 #define _PATH_UTMPX             "/var/run/utmpx"
  81
  82 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
  83 #define UTMPX_FILE      _PATH_UTMPX
  84 #endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */
  85
  86 #define _UTX_USERSIZE   256     /* matches MAXLOGNAME */
  87 #define _UTX_LINESIZE   32
  88 #define _UTX_IDSIZE     4
  89 #define _UTX_HOSTSIZE   256
  90
  91 #define EMPTY           0
  92 #define RUN_LVL         1
  93 #define BOOT_TIME       2
  94 #define OLD_TIME        3
  95 #define NEW_TIME        4
  96 #define INIT_PROCESS    5
  97 #define LOGIN_PROCESS   6
  98 #define USER_PROCESS    7
  99 #define DEAD_PROCESS    8
 100
 101 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 102 #define ACCOUNTING      9
 103 #define SIGNATURE       10
 104 #define SHUTDOWN_TIME   11
 105
 106 #define UTMPX_AUTOFILL_MASK                     0x8000
 107 #define UTMPX_DEAD_IF_CORRESPONDING_MASK        0x4000
 108
 109 /* notify(3) change notification name */
 110 #define UTMPX_CHANGE_NOTIFICATION               "com.apple.system.utmpx"
 111 #endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */
 112
 113 /*
 114  * The following structure describes the fields of the utmpx entries
 115  * stored in _PATH_UTMPX. This is not the format the
 116  * entries are stored in the files, and application should only access
 117  * entries using routines described in getutxent(3).
 118  */
 119
 120 #ifdef _UTMPX_COMPAT
 121 #define ut_user ut_name
 122 #define ut_xtime ut_tv.tv_sec
 123 #endif /* _UTMPX_COMPAT */
 124
 125 struct utmpx {
 126         char ut_user[_UTX_USERSIZE];    /* login name */
 127         char ut_id[_UTX_IDSIZE];        /* id */
 128         char ut_line[_UTX_LINESIZE];    /* tty name */
 129         pid_t ut_pid;                   /* process id creating the entry */
 130         short ut_type;                  /* type of this entry */
 131         struct timeval ut_tv;           /* time entry was created */
 132         char ut_host[_UTX_HOSTSIZE];    /* host name */
 133         __uint32_t ut_pad[16];          /* reserved for future use */
 134 };
 135
 136 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 137 struct lastlogx {
 138         struct timeval ll_tv;           /* time entry was created */
 139         char ll_line[_UTX_LINESIZE];    /* tty name */
 140         char ll_host[_UTX_HOSTSIZE];    /* host name */
 141 };
 142 #endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */
 143
 144 __BEGIN_DECLS
 145
 146 void    endutxent(void);
 147
 148 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 149 void    endutxent_wtmp(void) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 150 struct lastlogx *
 151         getlastlogx(uid_t, struct lastlogx *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 152 struct lastlogx *
 153         getlastlogxbyname(const char*, struct lastlogx *)__OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 154 #ifdef UNIFDEF_LEGACY_UTMP_APIS
 155 struct utmp;    /* forward reference */
 156 void    getutmp(const struct utmpx *, struct utmp *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 157 void    getutmpx(const struct utmp *, struct utmpx *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 158 #endif /* UNIFDEF_LEGACY_UTMP_APIS */
 159 #endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */
 160
 161 struct utmpx *
 162         getutxent(void);
 163
 164 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 165 struct utmpx *
 166         getutxent_wtmp(void) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 167 #endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */
 168
 169 struct utmpx *
 170         getutxid(const struct utmpx *);
 171 struct utmpx *
 172         getutxline(const struct utmpx *);
 173 struct utmpx *
 174         pututxline(const struct utmpx *);
 175 void    setutxent(void);
 176
 177 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 178 void    setutxent_wtmp(int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 179 int     utmpxname(const char *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 180 int     wtmpxname(const char *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 181 #endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */
 182
 183 __END_DECLS
 184
 185 #endif /* !_UTMPX_H_ */