include/utmpx.h

   1 /*-
   2  * Copyright (c) 2010 Ed Schouten <ed@FreeBSD.org>
   3  * 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  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _UTMPX_H_
  30 #define _UTMPX_H_
  31
  32 #include <sys/cdefs.h>
  33 #include <sys/_timeval.h>
  34 #include <sys/_types.h>
  35
  36 #ifndef _PID_T_DECLARED
  37 typedef __pid_t         pid_t;
  38 #define _PID_T_DECLARED
  39 #endif
  40
  41 struct utmpx {
  42         short           ut_type;        /* Type of entry. */
  43         struct timeval  ut_tv;          /* Time entry was made. */
  44         char            ut_id[8];       /* Record identifier. */
  45         pid_t           ut_pid;         /* Process ID. */
  46         char            ut_user[32];    /* User login name. */
  47         char            ut_line[16];    /* Device name. */
  48 #if __BSD_VISIBLE
  49         char            ut_host[128];   /* Remote hostname. */
  50 #else
  51         char            __ut_host[128];
  52 #endif
  53         char            __ut_spare[64];
  54 };
  55
  56 #define EMPTY           0       /* No valid user accounting information. */
  57 #define BOOT_TIME       1       /* Time of system boot. */
  58 #define OLD_TIME        2       /* Time when system clock changed. */
  59 #define NEW_TIME        3       /* Time after system clock changed. */
  60 #define USER_PROCESS    4       /* A process. */
  61 #define INIT_PROCESS    5       /* A process spawned by the init process. */
  62 #define LOGIN_PROCESS   6       /* The session leader of a logged-in user. */
  63 #define DEAD_PROCESS    7       /* A session leader who has exited. */
  64 #if __BSD_VISIBLE
  65 #define SHUTDOWN_TIME   8       /* Time of system shutdown. */
  66 #endif
  67
  68 #if __BSD_VISIBLE
  69 #define UTXDB_ACTIVE    0       /* Active login sessions. */
  70 #define UTXDB_LASTLOGIN 1       /* Last login sessions. */
  71 #define UTXDB_LOG       2       /* Log indexed by time. */
  72 #endif
  73
  74 __BEGIN_DECLS
  75 void    endutxent(void);
  76 struct utmpx *getutxent(void);
  77 struct utmpx *getutxid(const struct utmpx *);
  78 struct utmpx *getutxline(const struct utmpx *);
  79 struct utmpx *pututxline(const struct utmpx *);
  80 void    setutxent(void);
  81
  82 #if __BSD_VISIBLE
  83 struct utmpx *getutxuser(const char *);
  84 int     setutxdb(int, const char *);
  85 #endif
  86 __END_DECLS
  87
  88 #endif /* !_UTMPX_H_ */