include/utmpx.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2010 Ed Schouten <ed@FreeBSD.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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  * $FreeBSD$
  29  */
  30
  31 #ifndef _UTMPX_H_
  32 #define _UTMPX_H_
  33
  34 #include <sys/cdefs.h>
  35 #include <sys/_timeval.h>
  36 #include <sys/_types.h>
  37
  38 #ifndef _PID_T_DECLARED
  39 typedef __pid_t         pid_t;
  40 #define _PID_T_DECLARED
  41 #endif
  42
  43 struct utmpx {
  44         short           ut_type;        /* Type of entry. */
  45         struct timeval  ut_tv;          /* Time entry was made. */
  46         char            ut_id[8];       /* Record identifier. */
  47         pid_t           ut_pid;         /* Process ID. */
  48         char            ut_user[32];    /* User login name. */
  49         char            ut_line[16];    /* Device name. */
  50 #if __BSD_VISIBLE
  51         char            ut_host[128];   /* Remote hostname. */
  52 #else
  53         char            __ut_host[128];
  54 #endif
  55         char            __ut_spare[64];
  56 };
  57
  58 #define EMPTY           0       /* No valid user accounting information. */
  59 #define BOOT_TIME       1       /* Time of system boot. */
  60 #define OLD_TIME        2       /* Time when system clock changed. */
  61 #define NEW_TIME        3       /* Time after system clock changed. */
  62 #define USER_PROCESS    4       /* A process. */
  63 #define INIT_PROCESS    5       /* A process spawned by the init process. */
  64 #define LOGIN_PROCESS   6       /* The session leader of a logged-in user. */
  65 #define DEAD_PROCESS    7       /* A session leader who has exited. */
  66 #if __BSD_VISIBLE
  67 #define SHUTDOWN_TIME   8       /* Time of system shutdown. */
  68 #endif
  69
  70 #if __BSD_VISIBLE
  71 #define UTXDB_ACTIVE    0       /* Active login sessions. */
  72 #define UTXDB_LASTLOGIN 1       /* Last login sessions. */
  73 #define UTXDB_LOG       2       /* Log indexed by time. */
  74 #endif
  75
  76 __BEGIN_DECLS
  77 void    endutxent(void);
  78 struct utmpx *getutxent(void);
  79 struct utmpx *getutxid(const struct utmpx *);
  80 struct utmpx *getutxline(const struct utmpx *);
  81 struct utmpx *pututxline(const struct utmpx *);
  82 void    setutxent(void);
  83
  84 #if __BSD_VISIBLE
  85 struct utmpx *getutxuser(const char *);
  86 int     setutxdb(int, const char *);
  87 #endif
  88 __END_DECLS
  89
  90 #endif /* !_UTMPX_H_ */