1/*	$NetBSD: hlfsd.h,v 1.1.1.2 2009/03/20 20:26:55 christos Exp $	*/
2
3/*
4 * Copyright (c) 1997-2009 Erez Zadok
5 * Copyright (c) 1989 Jan-Simon Pendry
6 * Copyright (c) 1989 Imperial College of Science, Technology & Medicine
7 * Copyright (c) 1989 The Regents of the University of California.
8 * All rights reserved.
9 *
10 * This code is derived from software contributed to Berkeley by
11 * Jan-Simon Pendry at Imperial College, London.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 * 1. Redistributions of source code must retain the above copyright
17 *    notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 *    notice, this list of conditions and the following disclaimer in the
20 *    documentation and/or other materials provided with the distribution.
21 * 3. All advertising materials mentioning features or use of this software
22 *    must display the following acknowledgment:
23 *      This product includes software developed by the University of
24 *      California, Berkeley and its contributors.
25 * 4. Neither the name of the University nor the names of its contributors
26 *    may be used to endorse or promote products derived from this software
27 *    without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 * SUCH DAMAGE.
40 *
41 *
42 * File: am-utils/hlfsd/hlfsd.h
43 *
44 * HLFSD was written at Columbia University Computer Science Department, by
45 * Erez Zadok <ezk@cs.columbia.edu> and Alexander Dupuy <dupuy@cs.columbia.edu>
46 * It is being distributed under the same terms and conditions as amd does.
47 */
48
49#ifndef _HLFSD_HLFS_H
50#define _HLFSD_HLFS_H
51
52/*
53 * MACROS AND CONSTANTS:
54 */
55
56#define HLFSD_VERSION	"hlfsd 1.2 (1993-2002)"
57#define PERS_SPOOLMODE	0755
58#define OPEN_SPOOLMODE	01777
59#define DOTSTRING	"."
60
61/*
62 * ROOTID and SLINKID are the fixed "faked" node IDs (inodes) for
63 * the '.' (also '..') and the one symlink within the hlfs.
64 * They must always be unique, and should never match what a UID
65 * could be.
66 * They used to be -1 and -2, respectively.
67 *
68 * I used to cast these to (uid_t) but it failed to compile
69 * with /opt/SUNWspro/bin/cc because uid_t is long, while struct fattr's
70 * uid field is u_int.  Then it failed to compile on some linux systems
71 * which define uid_t to be unsigned short, so I used the lowest common
72 * size which is unsigned short.
73 */
74/*
75 * XXX: this will cause problems to systems with UIDs greater than
76 * MAX_UNSIGNED_SHORT-3.
77 */
78#define ROOTID		(((unsigned short) ~0) - 1)
79#define SLINKID		(((unsigned short) ~0) - 2)
80#ifndef INVALIDID
81/* this is also defined in include/am_utils.h */
82# define INVALIDID	(((unsigned short) ~0) - 3)
83#endif /* not INVALIDID */
84
85#define DOTCOOKIE	1
86#define DOTDOTCOOKIE	2
87#define SLINKCOOKIE	3
88
89#define ALT_SPOOLDIR "/var/hlfs" /* symlink to use if others fail */
90#define HOME_SUBDIR ".hlfsdir"	/* dirname in user's home dir */
91#define DEFAULT_DIRNAME "/hlfs/home"
92#define DEFAULT_INTERVAL 900	/* secs b/t re-reads of the password maps */
93#define DEFAULT_CACHE_INTERVAL 300 /* secs during which assume a link is up */
94#define DEFAULT_HLFS_GROUP	"hlfs"	/* Group name for special hlfs_gid */
95
96#define PROGNAMESZ	(MAXHOSTNAMELEN - 5)
97
98#ifdef HAVE_SYSLOG
99# define DEFAULT_LOGFILE "syslog"
100#else /* not HAVE)_SYSLOG */
101# define DEFAULT_LOGFILE 0
102#endif /* not HAVE)_SYSLOG */
103
104
105/*
106 * TYPEDEFS:
107 */
108typedef struct uid2home_t uid2home_t;
109typedef struct username2uid_t username2uid_t;
110
111
112/*
113 * STRUCTURES:
114 */
115struct uid2home_t {
116  uid_t uid;			/* XXX: with or without UID_OFFSET? */
117  pid_t child;
118  char *home;			/* really allocated */
119  char *uname;			/* an xref ptr to username2uid_t->username */
120  u_long last_access_time;
121  int last_status;		/* 0=used $HOME/.hlfsspool; !0=used alt dir */
122};
123
124struct username2uid_t {
125  char *username;		/* really allocated */
126  uid_t uid;			/* XXX: with or without UID_OFFSET? */
127  char *home;			/* an xref ptr to uid2home_t->home */
128};
129
130/*
131 * EXTERNALS:
132 */
133extern RETSIGTYPE cleanup(int);
134extern RETSIGTYPE interlock(int);
135extern SVCXPRT *nfs_program_2_transp;	/* For quick_reply() */
136extern SVCXPRT *nfsxprt;
137extern char *alt_spooldir;
138extern char *home_subdir;
139extern char *homedir(int, int);
140extern char *mailbox(int, char *);
141extern char *passwdfile;
142extern char *slinkname;
143extern gid_t hlfs_gid;
144extern u_int cache_interval;
145extern int noverify;
146extern int serverpid;
147extern int untab_index(char *username);
148extern am_nfs_fh *root_fhp;
149extern am_nfs_fh root;
150extern nfstime startup;
151extern uid2home_t *plt_search(u_int);
152extern username2uid_t *untab;	/* user name table */
153extern void fatal(char *);
154extern void plt_init(void);
155extern void hlfsd_init_filehandles(void);
156
157#if defined(DEBUG) || defined(DEBUG_PRINT)
158extern void plt_dump(uid2home_t *, pid_t);
159extern void plt_print(int);
160#endif /* defined(DEBUG) || defined(DEBUG_PRINT) */
161
162#endif /* _HLFSD_HLFS_H */
163