xref: /freebsd/stand/libsa/stand.h (revision c61ee49cd06a610193493f033f04d38cf61f11e2)
1 /*
2  * Copyright (c) 1998 Michael Smith.
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  * From	$NetBSD: stand.h,v 1.22 1997/06/26 19:17:40 drochner Exp $
26  */
27 
28 /*-
29  * Copyright (c) 1993
30  *	The Regents of the University of California.  All rights reserved.
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. Neither the name of the University nor the names of its contributors
41  *    may be used to endorse or promote products derived from this software
42  *    without specific prior written permission.
43  *
44  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
45  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
47  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
48  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
49  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
50  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
52  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
53  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
54  * SUCH DAMAGE.
55  */
56 
57 #ifndef	STAND_H
58 #define	STAND_H
59 
60 #include <sys/types.h>
61 #include <sys/stat.h>
62 #include <sys/dirent.h>
63 #include <sys/queue.h>
64 
65 /* this header intentionally exports NULL from <string.h> */
66 #include <string.h>
67 #define strcoll(a, b)	strcmp((a), (b))
68 
69 #define CHK(fmt, args...)	printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args)
70 #define PCHK(fmt, args...)	{printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args); getchar();}
71 
72 #include <sys/errno.h>
73 
74 /* special stand error codes */
75 #define	EADAPT	(ELAST+1)	/* bad adaptor */
76 #define	ECTLR	(ELAST+2)	/* bad controller */
77 #define	EUNIT	(ELAST+3)	/* bad unit */
78 #define ESLICE	(ELAST+4)	/* bad slice */
79 #define	EPART	(ELAST+5)	/* bad partition */
80 #define	ERDLAB	(ELAST+6)	/* can't read disk label */
81 #define	EUNLAB	(ELAST+7)	/* unlabeled disk */
82 #define	EOFFSET	(ELAST+8)	/* relative seek not supported */
83 #define	ESALAST	(ELAST+8)	/* */
84 
85 /*
86  * LUA needs sig_atomic_t. This is defined to be long or int on all our
87  * platforms. On all but powerpc, these are all the same thing as long. 64-bit
88  * powerpc defines this as int, but long can also be accessed atomically. It's
89  * also OK because we don't have signal handlers in the boot loader.
90  */
91 typedef long sig_atomic_t;
92 
93 __BEGIN_DECLS
94 
95 struct open_file;
96 
97 #define FS_OPS_NO_DEVOPEN 1
98 
99 /*
100  * This structure is used to define file system operations in a file system
101  * independent way.
102  *
103  * XXX note that filesystem providers should export a pointer to their fs_ops
104  *     struct, so that consumers can reference this and thus include the
105  *     filesystems that they require.
106  */
107 struct fs_ops {
108     const char	*fs_name;
109     int		fs_flags;
110     int		(*fo_open)(const char *path, struct open_file *f);
111     int		(*fo_close)(struct open_file *f);
112     int		(*fo_read)(struct open_file *f, void *buf,
113 			   size_t size, size_t *resid);
114     int		(*fo_write)(struct open_file *f, const void *buf,
115 			    size_t size, size_t *resid);
116     off_t	(*fo_seek)(struct open_file *f, off_t offset, int where);
117     int		(*fo_stat)(struct open_file *f, struct stat *sb);
118     int		(*fo_readdir)(struct open_file *f, struct dirent *d);
119     int		(*fo_preload)(struct open_file *f);
120     int		(*fo_mount)(const char *, const char *, void **);
121     int		(*fo_unmount)(const char *, void *);
122 };
123 
124 /*
125  * libsa-supplied filesystems
126  */
127 extern struct fs_ops ufs_fsops;
128 extern struct fs_ops tftp_fsops;
129 extern struct fs_ops nfs_fsops;
130 extern struct fs_ops cd9660_fsops;
131 extern struct fs_ops gzipfs_fsops;
132 extern struct fs_ops bzipfs_fsops;
133 extern struct fs_ops xzfs_fsops;
134 extern struct fs_ops zstdfs_fsops;
135 extern struct fs_ops dosfs_fsops;
136 extern struct fs_ops ext2fs_fsops;
137 extern struct fs_ops splitfs_fsops;
138 extern struct fs_ops pkgfs_fsops;
139 extern struct fs_ops efihttp_fsops;
140 
141 /* where values for lseek(2) */
142 #define	SEEK_SET	0	/* set file offset to offset */
143 #define	SEEK_CUR	1	/* set file offset to current plus offset */
144 #define	SEEK_END	2	/* set file offset to EOF plus offset */
145 
146 /*
147  * Device switch
148  */
149 #define DEV_NAMLEN	8		/* Length of name of device class */
150 #define DEV_DEVLEN	128		/* Length of longest device instance name */
151 struct devdesc;
152 struct devsw {
153     const char	dv_name[DEV_NAMLEN];
154     int		dv_type;		/* opaque type constant */
155 #define DEVT_NONE	0
156 #define DEVT_DISK	1
157 #define DEVT_NET	2
158 #define DEVT_CD		3
159 #define DEVT_ZFS	4
160 #define DEVT_FD		5
161     int		(*dv_init)(void);	/* early probe call */
162     int		(*dv_strategy)(void *devdata, int rw, daddr_t blk,
163 			size_t size, char *buf, size_t *rsize);
164     int		(*dv_open)(struct open_file *f, ...);
165     int		(*dv_close)(struct open_file *f);
166     int		(*dv_ioctl)(struct open_file *f, u_long cmd, void *data);
167     int		(*dv_print)(int verbose);	/* print device information */
168     void	(*dv_cleanup)(void);
169     char *	(*dv_fmtdev)(struct devdesc *);
170     int		(*dv_parsedev)(struct devdesc **, const char *, const char **);
171     bool	(*dv_match)(struct devsw *, const char *);
172 };
173 
174 /*
175  * libsa-supplied device switch
176  */
177 extern struct devsw netdev;
178 
179 extern int errno;
180 
181 /*
182  * Generic device specifier; architecture-dependent versions may be larger, but
183  * should be allowed to overlap. The larger device specifiers store more data
184  * than can fit in the generic one that's gleaned after parsing the device
185  * string, or used in some cases to indicate wildcards that match a variety of
186  * situations based on what's on the drive itself rather than what the progammer
187  * might know in advance. Information about open files is stored in d_opendata,
188  * though what's passed into the open routine may differ from what's present
189  * after the open on some configurations.
190  */
191 struct devdesc {
192     struct devsw	*d_dev;
193     int			d_unit;
194     void		*d_opendata;
195 };
196 
197 char *devformat(struct devdesc *d);
198 int devparse(struct devdesc **, const char *, const char **);
199 int devinit(void);
200 void	dev_cleanup(void);
201 
202 struct open_file {
203     int			f_flags;	/* see F_* below */
204     struct devsw	*f_dev;		/* pointer to device operations */
205     void		*f_devdata;	/* device specific data */
206     struct fs_ops	*f_ops;		/* pointer to file system operations */
207     void		*f_fsdata;	/* file system specific data */
208     off_t		f_offset;	/* current file offset */
209     char		*f_rabuf;	/* readahead buffer pointer */
210     size_t		f_ralen;	/* valid data in readahead buffer */
211     off_t		f_raoffset;	/* consumer offset in readahead buffer */
212     int			f_id;		/* file number */
213     TAILQ_ENTRY(open_file) f_link;	/* next entry */
214 #define SOPEN_RASIZE	512
215 };
216 
217 typedef TAILQ_HEAD(file_list, open_file) file_list_t;
218 extern file_list_t files;
219 extern struct open_file *fd2open_file(int);
220 
221 /* f_flags values */
222 #define	F_READ		0x0001	/* file opened for reading */
223 #define	F_WRITE		0x0002	/* file opened for writing */
224 #define	F_RAW		0x0004	/* raw device open - no file system */
225 #define F_NODEV		0x0008	/* network open - no device */
226 #define	F_MASK		0xFFFF
227 /* Mode modifier for strategy() */
228 #define	F_NORA		(0x01 << 16)	/* Disable Read-Ahead */
229 
230 #define isascii(c)	(((c) & ~0x7F) == 0)
231 
isupper(int c)232 static __inline int isupper(int c)
233 {
234     return c >= 'A' && c <= 'Z';
235 }
236 
islower(int c)237 static __inline int islower(int c)
238 {
239     return c >= 'a' && c <= 'z';
240 }
241 
isspace(int c)242 static __inline int isspace(int c)
243 {
244     return c == ' ' || (c >= 0x9 && c <= 0xd);
245 }
246 
isdigit(int c)247 static __inline int isdigit(int c)
248 {
249     return c >= '0' && c <= '9';
250 }
251 
isxdigit(int c)252 static __inline int isxdigit(int c)
253 {
254     return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F');
255 }
256 
isalpha(int c)257 static __inline int isalpha(int c)
258 {
259     return isupper(c) || islower(c);
260 }
261 
isalnum(int c)262 static __inline int isalnum(int c)
263 {
264     return isalpha(c) || isdigit(c);
265 }
266 
iscntrl(int c)267 static __inline int iscntrl(int c)
268 {
269 	return (c >= 0 && c < ' ') || c == 127;
270 }
271 
isgraph(int c)272 static __inline int isgraph(int c)
273 {
274 	return c >= '!' && c <= '~';
275 }
276 
ispunct(int c)277 static __inline int ispunct(int c)
278 {
279 	return (c >= '!' && c <= '/') || (c >= ':' && c <= '@') ||
280 	    (c >= '[' && c <= '`') || (c >= '{' && c <= '~');
281 }
282 
isprint(int c)283 static __inline int isprint(int c)
284 {
285 	return (c >= ' ') && (c <= '~');
286 }
287 
toupper(int c)288 static __inline int toupper(int c)
289 {
290     return islower(c) ? c - 'a' + 'A' : c;
291 }
292 
tolower(int c)293 static __inline int tolower(int c)
294 {
295     return isupper(c) ? c - 'A' + 'a' : c;
296 }
297 
298 /* sbrk emulation */
299 extern void	setheap(void *base, void *top);
300 extern char	*sbrk(int incr);
301 
302 extern int	printf(const char *fmt, ...) __printflike(1, 2);
303 extern int	asprintf(char **buf, const char *cfmt, ...) __printflike(2, 3);
304 extern int	sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3);
305 extern int	snprintf(char *buf, size_t size, const char *cfmt, ...) __printflike(3, 4);
306 extern int	vprintf(const char *fmt, __va_list);
307 extern int	vsprintf(char *buf, const char *cfmt, __va_list);
308 extern int	vsnprintf(char *buf, size_t size, const char *cfmt, __va_list);
309 
310 extern void	twiddle(u_int callerdiv);
311 extern void	twiddle_divisor(u_int globaldiv);
312 
313 extern void	ngets(char *, int);
314 #define gets(x)	ngets((x), 0)
315 extern int	fgetstr(char *buf, int size, int fd);
316 
317 extern int	mount(const char *dev, const char *path, int flags, void *data);
318 extern int	unmount(const char *dev, int flags);
319 extern int	open(const char *, int);
320 #define	O_RDONLY	0x0
321 #define O_WRONLY	0x1
322 #define O_RDWR		0x2
323 #define O_ACCMODE	0x3
324 /* NOT IMPLEMENTED */
325 #define	O_CREAT		0x0200		/* create if nonexistent */
326 #define	O_TRUNC		0x0400		/* truncate to zero length */
327 extern int	close(int);
328 extern void	closeall(void);
329 extern ssize_t	read(int, void *, size_t);
330 extern ssize_t	write(int, const void *, size_t);
331 extern int	ioctl(int, u_long, void *);
332 extern struct	dirent *readdirfd(int);
333 extern void	preload(int);
334 
335 extern void	srandom(unsigned int);
336 extern long	random(void);
337 
338 /* imports from stdlib, locally modified */
339 extern char	*optarg;			/* getopt(3) external variables */
340 extern int	optind, opterr, optopt, optreset;
341 extern int	getopt(int, char * const [], const char *);
342 
343 /* pager.c */
344 extern void	pager_open(void);
345 extern void	pager_close(void);
346 extern int	pager_output(const char *lines);
347 extern int	pager_file(const char *fname);
348 
349 /* No signal state to preserve */
350 #define setjmp	_setjmp
351 #define longjmp	_longjmp
352 
353 /* environment.c */
354 #define EV_DYNAMIC	(1<<0)		/* value was dynamically allocated, free if changed/unset */
355 #define EV_VOLATILE	(1<<1)		/* value is volatile, make a copy of it */
356 #define EV_NOHOOK	(1<<2)		/* don't call hook when setting */
357 #define EV_NOKENV	(1<<3)		/* don't add to kenv (loader-only) */
358 
359 struct env_var;
360 typedef char	*(ev_format_t)(struct env_var *ev);
361 typedef int	(ev_sethook_t)(struct env_var *ev, int flags,
362 		    const void *value);
363 typedef int	(ev_unsethook_t)(struct env_var *ev);
364 
365 struct env_var
366 {
367     char		*ev_name;
368     int			ev_flags;
369     void		*ev_value;
370     ev_sethook_t	*ev_sethook;
371     ev_unsethook_t	*ev_unsethook;
372     struct env_var	*ev_next, *ev_prev;
373 };
374 extern struct env_var	*environ;
375 
376 extern struct env_var	*env_getenv(const char *name);
377 extern int		env_setenv(const char *name, int flags,
378 				   const void *value, ev_sethook_t sethook,
379 				   ev_unsethook_t unsethook);
380 extern void		env_discard(struct env_var *);
381 extern char		*getenv(const char *name);
382 extern int		setenv(const char *name, const char *value,
383 			       int overwrite);
384 extern int		putenv(char *string);
385 extern int		unsetenv(const char *name);
386 extern bool		is_restricted_var(const char *name);
387 extern void		set_check_restricted(bool);
388 extern int		boot_setenv(const char *name, const char *value);
389 
390 extern ev_sethook_t	env_noset;		/* refuse set operation */
391 extern ev_unsethook_t	env_nounset;		/* refuse unset operation */
392 
393 /* stdlib.h routines */
394 extern int		abs(int a);
395 extern void		abort(void) __dead2;
396 extern long		strtol(const char * __restrict, char ** __restrict, int);
397 extern long long	strtoll(const char * __restrict, char ** __restrict, int);
398 extern unsigned long	strtoul(const char * __restrict, char ** __restrict, int);
399 extern unsigned long long strtoull(const char * __restrict, char ** __restrict, int);
400 
401 /* BCD conversions (undocumented) */
402 extern u_char const	bcd2bin_data[];
403 extern u_char const	bin2bcd_data[];
404 extern char const	hex2ascii_data[];
405 
406 #define	bcd2bin(bcd)	(bcd2bin_data[bcd])
407 #define	bin2bcd(bin)	(bin2bcd_data[bin])
408 #define	hex2ascii(hex)	(hex2ascii_data[hex])
409 #define	validbcd(bcd)	(bcd == 0 || (bcd > 0 && bcd <= 0x99 && bcd2bin_data[bcd] != 0))
410 
411 /* min/max (undocumented) */
imax(int a,int b)412 static __inline int imax(int a, int b) { return (a > b ? a : b); }
imin(int a,int b)413 static __inline int imin(int a, int b) { return (a < b ? a : b); }
lmax(long a,long b)414 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
lmin(long a,long b)415 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
max(u_int a,u_int b)416 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
min(u_int a,u_int b)417 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
qmax(quad_t a,quad_t b)418 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
qmin(quad_t a,quad_t b)419 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
ulmax(u_long a,u_long b)420 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
ulmin(u_long a,u_long b)421 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
422 
423 /* null functions for device/filesystem switches (undocumented) */
424 extern int	nodev(void);
425 extern int	noioctl(struct open_file *, u_long, void *);
426 extern void	nullsys(void);
427 
428 extern int	null_open(const char *path, struct open_file *f);
429 extern int	null_close(struct open_file *f);
430 extern int	null_read(struct open_file *f, void *buf, size_t size, size_t *resid);
431 extern int	null_write(struct open_file *f, const void *buf, size_t size, size_t *resid);
432 extern off_t	null_seek(struct open_file *f, off_t offset, int where);
433 extern int	null_stat(struct open_file *f, struct stat *sb);
434 extern int	null_readdir(struct open_file *f, struct dirent *d);
435 
436 
437 /*
438  * Machine dependent functions and data, must be provided or stubbed by
439  * the consumer
440  */
441 extern void		exit(int) __dead2;
442 extern int		getchar(void);
443 extern int		ischar(void);
444 extern void		putchar(int);
445 extern int		devopen(struct open_file *, const char *, const char **);
446 extern int		devclose(struct open_file *f);
447 extern void		panic(const char *, ...) __dead2 __printflike(1, 2);
448 extern void		panic_action(void) __weak_symbol __dead2;
449 extern time_t		getsecs(void);
450 extern struct fs_ops	*file_system[];
451 extern struct fs_ops	*exclusive_file_system;
452 extern struct devsw	*devsw[];
453 
454 /*
455  * Time routines
456  */
457 time_t time(time_t *);
458 
459 /*
460  * Expose byteorder(3) functions.
461  */
462 #ifndef _BYTEORDER_PROTOTYPED
463 #define	_BYTEORDER_PROTOTYPED
464 extern uint32_t		htonl(uint32_t);
465 extern uint16_t		htons(uint16_t);
466 extern uint32_t		ntohl(uint32_t);
467 extern uint16_t		ntohs(uint16_t);
468 #endif
469 
470 #ifndef _BYTEORDER_FUNC_DEFINED
471 #define	_BYTEORDER_FUNC_DEFINED
472 #define	htonl(x)	__htonl(x)
473 #define	htons(x)	__htons(x)
474 #define	ntohl(x)	__ntohl(x)
475 #define	ntohs(x)	__ntohs(x)
476 #endif
477 
478 void *Malloc(size_t, const char *, int);
479 void *Memalign(size_t, size_t, const char *, int);
480 void *Calloc(size_t, size_t, const char *, int);
481 void *Realloc(void *, size_t, const char *, int);
482 void *Reallocf(void *, size_t, const char *, int);
483 void Free(void *, const char *, int);
484 extern void	mallocstats(void);
485 
486 const char *x86_hypervisor(void);
487 
488 #ifdef USER_MALLOC
489 extern void *malloc(size_t);
490 extern void *memalign(size_t, size_t);
491 extern void *calloc(size_t, size_t);
492 extern void free(void *);
493 extern void *realloc(void *, size_t);
494 extern void *reallocf(void *, size_t);
495 #elif defined(DEBUG_MALLOC)
496 #define malloc(x)	Malloc(x, __FILE__, __LINE__)
497 #define memalign(x, y)	Memalign(x, y, __FILE__, __LINE__)
498 #define calloc(x, y)	Calloc(x, y, __FILE__, __LINE__)
499 #define free(x)		Free(x, __FILE__, __LINE__)
500 #define realloc(x, y)	Realloc(x, y, __FILE__, __LINE__)
501 #define reallocf(x, y)	Reallocf(x, y, __FILE__, __LINE__)
502 #else
503 #define malloc(x)	Malloc(x, NULL, 0)
504 #define memalign(x, y)	Memalign(x, y, NULL, 0)
505 #define calloc(x, y)	Calloc(x, y, NULL, 0)
506 #define free(x)		Free(x, NULL, 0)
507 #define realloc(x, y)	Realloc(x, y, NULL, 0)
508 #define reallocf(x, y)	Reallocf(x, y, NULL, 0)
509 #endif
510 
511 /*
512  * va <-> pa routines. MD code must supply.
513  */
514 caddr_t ptov(uintptr_t);
515 
516 /* dev_net.c */
517 bool is_tftp(void);
518 
519 /* features.c */
520 typedef void (feature_iter_fn)(void *, const char *, const char *, bool);
521 
522 extern void feature_enable(uint32_t);
523 extern bool feature_name_is_enabled(const char *);
524 extern void feature_iter(feature_iter_fn *, void *);
525 
526 /*
527  * Note that these should also be added to the mapping table in features.c,
528  * which the interpreter may query to provide details from.  The name with
529  * FEATURE_ removed is assumed to be the name we'll provide in the loader
530  * features table, just to simplify reasoning about these.
531  */
532 #define	FEATURE_EARLY_ACPI	0x0001
533 
534 /* hexdump.c */
535 void	hexdump(caddr_t region, size_t len);
536 
537 /* nvstore.c */
538 typedef int (nvstore_getter_cb_t)(void *, const char *, void **);
539 typedef int (nvstore_setter_cb_t)(void *, int, const char *,
540     const void *, size_t);
541 typedef int (nvstore_setter_str_cb_t)(void *, const char *, const char *,
542     const char *);
543 typedef int (nvstore_unset_cb_t)(void *, const char *);
544 typedef int (nvstore_print_cb_t)(void *, void *);
545 typedef int (nvstore_iterate_cb_t)(void *, int (*)(void *, void *));
546 
547 typedef struct nvs_callbacks {
548 	nvstore_getter_cb_t	*nvs_getter;
549 	nvstore_setter_cb_t	*nvs_setter;
550 	nvstore_setter_str_cb_t *nvs_setter_str;
551 	nvstore_unset_cb_t	*nvs_unset;
552 	nvstore_print_cb_t	*nvs_print;
553 	nvstore_iterate_cb_t	*nvs_iterate;
554 } nvs_callbacks_t;
555 
556 int nvstore_init(const char *, nvs_callbacks_t *, void *);
557 int nvstore_fini(const char *);
558 void *nvstore_get_store(const char *);
559 int nvstore_print(void *);
560 int nvstore_get_var(void *, const char *, void **);
561 int nvstore_set_var(void *, int, const char *, void *, size_t);
562 int nvstore_set_var_from_string(void *, const char *, const char *,
563     const char *);
564 int nvstore_unset_var(void *, const char *);
565 
566 /* tslog.c */
567 #define TSRAW(a, b, c) tslog(a, b, c)
568 #define TSENTER() TSRAW("ENTER", __func__, NULL)
569 #define TSENTER2(x) TSRAW("ENTER", __func__, x)
570 #define TSEXIT() TSRAW("EXIT", __func__, NULL)
571 #define TSLINE() TSRAW("EVENT", __FILE__, __XSTRING(__LINE__))
572 void tslog(const char *, const char *, const char *);
573 void tslog_setbuf(void * buf, size_t len);
574 void tslog_getbuf(void ** buf, size_t * len);
575 
576 __END_DECLS
577 
578 /* define _DEBUG_LEVEL n or _DEBUG_LEVEL_VAR before include */
579 #ifndef DEBUG_PRINTF
580 # if defined(_DEBUG_LEVEL) || defined(_DEBUG_LEVEL_VAR)
581 #   ifndef _DEBUG_LEVEL_VAR
582 #     define _DEBUG_LEVEL_VAR _debug
583 static int _debug = _DEBUG_LEVEL;
584 #   endif
585 #   define DEBUG_PRINTF(n, args) if (_DEBUG_LEVEL_VAR >= n) printf args
586 # else
587 #   define DEBUG_PRINTF(n, args)
588 # endif
589 #endif
590 
591 #endif	/* STAND_H */
592