[apple/libc.git] / include / utmpx.h

/*
 * Copyright (c) 2004-2006 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*	$NetBSD: utmpx.h,v 1.11 2003/08/26 16:48:32 wiz Exp $	 */

/*-
 * Copyright (c) 2002 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Christos Zoulas.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *        This product includes software developed by the NetBSD
 *        Foundation, Inc. and its contributors.
 * 4. Neither the name of The NetBSD Foundation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef	_UTMPX_H_
#define	_UTMPX_H_

#include <_types.h>
#include <sys/time.h>

#ifndef _PID_T
#define _PID_T
typedef __darwin_pid_t     pid_t;
#endif

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
#ifndef _UID_T
#define _UID_T
typedef __darwin_uid_t     uid_t;
#endif
#endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */

#define	_PATH_UTMPX		"/var/run/utmpx"

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
#define	UTMPX_FILE	_PATH_UTMPX
#endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */

#define _UTX_USERSIZE	256	/* matches MAXLOGNAME */
#define _UTX_LINESIZE	32
#define	_UTX_IDSIZE	4
#define _UTX_HOSTSIZE	256

#define EMPTY		0
#define RUN_LVL		1
#define BOOT_TIME	2
#define OLD_TIME	3
#define NEW_TIME	4
#define INIT_PROCESS	5
#define LOGIN_PROCESS	6
#define USER_PROCESS	7
#define DEAD_PROCESS	8

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
#define ACCOUNTING	9
#define SIGNATURE	10
#define SHUTDOWN_TIME	11

#define UTMPX_AUTOFILL_MASK			0x8000
#define UTMPX_DEAD_IF_CORRESPONDING_MASK	0x4000

/* notify(3) change notification name */
#define UTMPX_CHANGE_NOTIFICATION		"com.apple.system.utmpx"
#endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */

/*
 * The following structure describes the fields of the utmpx entries
 * stored in _PATH_UTMPX. This is not the format the
 * entries are stored in the files, and application should only access
 * entries using routines described in getutxent(3).
 */

#ifdef _UTMPX_COMPAT
#define ut_user ut_name
#define ut_xtime ut_tv.tv_sec
#endif /* _UTMPX_COMPAT */

struct utmpx {
	char ut_user[_UTX_USERSIZE];	/* login name */
	char ut_id[_UTX_IDSIZE];	/* id */
	char ut_line[_UTX_LINESIZE];	/* tty name */
	pid_t ut_pid;			/* process id creating the entry */
	short ut_type;			/* type of this entry */
	struct timeval ut_tv;		/* time entry was created */
	char ut_host[_UTX_HOSTSIZE];	/* host name */
	__uint32_t ut_pad[16];		/* reserved for future use */
};

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
struct lastlogx {
	struct timeval ll_tv;		/* time entry was created */
	char ll_line[_UTX_LINESIZE];	/* tty name */
	char ll_host[_UTX_HOSTSIZE];	/* host name */
};
#endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */

__BEGIN_DECLS

void	endutxent(void);

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
void	endutxent_wtmp(void);
struct lastlogx *
	getlastlogx(uid_t, struct lastlogx *);
struct lastlogx *
	getlastlogxbyname(const char*, struct lastlogx *);
struct utmp;	/* forward reference */
void	getutmp(const struct utmpx *, struct utmp *);
void	getutmpx(const struct utmp *, struct utmpx *);
#endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */

struct utmpx *
	getutxent(void);

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
struct utmpx *
	getutxent_wtmp(void);
#endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */

struct utmpx *
	getutxid(const struct utmpx *);
struct utmpx *
	getutxline(const struct utmpx *);
struct utmpx *
	pututxline(const struct utmpx *);
void	setutxent(void);

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
void	setutxent_wtmp(int);
int	utmpxname(const char *);
int	wtmpxname(const char *);
#endif /* !_POSIX_C_SOURCE || _DARWIN_C_SOURCE */

__END_DECLS

#endif /* !_UTMPX_H_ */
Commit	Line	Data
224c7076 A	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
66	#ifndef _PID_T
67	#define _PID_T
68	typedef __darwin_pid_t pid_t;
69	#endif
70
71	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
72	#ifndef _UID_T
73	#define _UID_T
74	typedef __darwin_uid_t uid_t;
75	#endif
76	#endif /* !_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE */
77
78	#define _PATH_UTMPX "/var/run/utmpx"
79
80	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
81	#define UTMPX_FILE _PATH_UTMPX
82	#endif /* !_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE */
83
84	#define _UTX_USERSIZE 256 /* matches MAXLOGNAME */
85	#define _UTX_LINESIZE 32
86	#define _UTX_IDSIZE 4
87	#define _UTX_HOSTSIZE 256
88
89	#define EMPTY 0
90	#define RUN_LVL 1
91	#define BOOT_TIME 2
92	#define OLD_TIME 3
93	#define NEW_TIME 4
94	#define INIT_PROCESS 5
95	#define LOGIN_PROCESS 6
96	#define USER_PROCESS 7
97	#define DEAD_PROCESS 8
98
99	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
100	#define ACCOUNTING 9
101	#define SIGNATURE 10
102	#define SHUTDOWN_TIME 11
103
104	#define UTMPX_AUTOFILL_MASK 0x8000
105	#define UTMPX_DEAD_IF_CORRESPONDING_MASK 0x4000
106
107	/* notify(3) change notification name */
108	#define UTMPX_CHANGE_NOTIFICATION "com.apple.system.utmpx"
109	#endif /* !_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE */
110
111	/*
112	* The following structure describes the fields of the utmpx entries
113	* stored in _PATH_UTMPX. This is not the format the
114	* entries are stored in the files, and application should only access
115	* entries using routines described in getutxent(3).
116	*/
117
118	#ifdef _UTMPX_COMPAT
119	#define ut_user ut_name
120	#define ut_xtime ut_tv.tv_sec
121	#endif /* _UTMPX_COMPAT */
122
123	struct utmpx {
124	char ut_user[_UTX_USERSIZE]; /* login name */
125	char ut_id[_UTX_IDSIZE]; /* id */
126	char ut_line[_UTX_LINESIZE]; /* tty name */
127	pid_t ut_pid; /* process id creating the entry */
128	short ut_type; /* type of this entry */
129	struct timeval ut_tv; /* time entry was created */
130	char ut_host[_UTX_HOSTSIZE]; /* host name */
131	__uint32_t ut_pad[16]; /* reserved for future use */
132	};
133
134	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
135	struct lastlogx {
136	struct timeval ll_tv; /* time entry was created */
137	char ll_line[_UTX_LINESIZE]; /* tty name */
138	char ll_host[_UTX_HOSTSIZE]; /* host name */
139	};
140	#endif /* !_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE */
141
142	__BEGIN_DECLS
143
144	void endutxent(void);
145
146	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
147	void endutxent_wtmp(void);
148	struct lastlogx *
149	getlastlogx(uid_t, struct lastlogx *);
150	struct lastlogx *
151	getlastlogxbyname(const char, struct lastlogx );
152	struct utmp; /* forward reference */
153	void getutmp(const struct utmpx , struct utmp );
154	void getutmpx(const struct utmp , struct utmpx );
155	#endif /* !_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE */
156
157	struct utmpx *
158	getutxent(void);
159
160	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
161	struct utmpx *
162	getutxent_wtmp(void);
163	#endif /* !_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE */
164
165	struct utmpx *
166	getutxid(const struct utmpx *);
167	struct utmpx *
168	getutxline(const struct utmpx *);
169	struct utmpx *
170	pututxline(const struct utmpx *);
171	void setutxent(void);
172
173	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
174	void setutxent_wtmp(int);
175	int utmpxname(const char *);
176	int wtmpxname(const char *);
177	#endif /* !_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE */
178
179	__END_DECLS
180
181	#endif /* !_UTMPX_H_ */