xref: /freebsd/stand/libsa/stand.h (revision 510e473ff3a6d4620c603c1b9ba06fb2bf5745fd)
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 dosfs_fsops;
134 extern struct fs_ops ext2fs_fsops;
135 extern struct fs_ops splitfs_fsops;
136 extern struct fs_ops pkgfs_fsops;
137 extern struct fs_ops efihttp_fsops;
138 
139 /* where values for lseek(2) */
140 #define	SEEK_SET	0	/* set file offset to offset */
141 #define	SEEK_CUR	1	/* set file offset to current plus offset */
142 #define	SEEK_END	2	/* set file offset to EOF plus offset */
143 
144 /*
145  * Device switch
146  */
147 #define DEV_NAMLEN	8		/* Length of name of device class */
148 #define DEV_DEVLEN	128		/* Length of longest device instance name */
149 struct devdesc;
150 struct devsw {
151     const char	dv_name[DEV_NAMLEN];
152     int		dv_type;		/* opaque type constant */
153 #define DEVT_NONE	0
154 #define DEVT_DISK	1
155 #define DEVT_NET	2
156 #define DEVT_CD		3
157 #define DEVT_ZFS	4
158 #define DEVT_FD		5
159     int		(*dv_init)(void);	/* early probe call */
160     int		(*dv_strategy)(void *devdata, int rw, daddr_t blk,
161 			size_t size, char *buf, size_t *rsize);
162     int		(*dv_open)(struct open_file *f, ...);
163     int		(*dv_close)(struct open_file *f);
164     int		(*dv_ioctl)(struct open_file *f, u_long cmd, void *data);
165     int		(*dv_print)(int verbose);	/* print device information */
166     void	(*dv_cleanup)(void);
167     char *	(*dv_fmtdev)(struct devdesc *);
168     int		(*dv_parsedev)(struct devdesc **, const char *, const char **);
169     bool	(*dv_match)(struct devsw *, const char *);
170 };
171 
172 /*
173  * libsa-supplied device switch
174  */
175 extern struct devsw netdev;
176 
177 extern int errno;
178 
179 /*
180  * Generic device specifier; architecture-dependent versions may be larger, but
181  * should be allowed to overlap. The larger device specifiers store more data
182  * than can fit in the generic one that's gleaned after parsing the device
183  * string, or used in some cases to indicate wildcards that match a variety of
184  * situations based on what's on the drive itself rather than what the progammer
185  * might know in advance. Information about open files is stored in d_opendata,
186  * though what's passed into the open routine may differ from what's present
187  * after the open on some configurations.
188  */
189 struct devdesc {
190     struct devsw	*d_dev;
191     int			d_unit;
192     void		*d_opendata;
193 };
194 
195 char *devformat(struct devdesc *d);
196 int devparse(struct devdesc **, const char *, const char **);
197 int devinit(void);
198 void	dev_cleanup(void);
199 
200 struct open_file {
201     int			f_flags;	/* see F_* below */
202     struct devsw	*f_dev;		/* pointer to device operations */
203     void		*f_devdata;	/* device specific data */
204     struct fs_ops	*f_ops;		/* pointer to file system operations */
205     void		*f_fsdata;	/* file system specific data */
206     off_t		f_offset;	/* current file offset */
207     char		*f_rabuf;	/* readahead buffer pointer */
208     size_t		f_ralen;	/* valid data in readahead buffer */
209     off_t		f_raoffset;	/* consumer offset in readahead buffer */
210     int			f_id;		/* file number */
211     TAILQ_ENTRY(open_file) f_link;	/* next entry */
212 #define SOPEN_RASIZE	512
213 };
214 
215 typedef TAILQ_HEAD(file_list, open_file) file_list_t;
216 extern file_list_t files;
217 extern struct open_file *fd2open_file(int);
218 
219 /* f_flags values */
220 #define	F_READ		0x0001	/* file opened for reading */
221 #define	F_WRITE		0x0002	/* file opened for writing */
222 #define	F_RAW		0x0004	/* raw device open - no file system */
223 #define F_NODEV		0x0008	/* network open - no device */
224 #define	F_MASK		0xFFFF
225 /* Mode modifier for strategy() */
226 #define	F_NORA		(0x01 << 16)	/* Disable Read-Ahead */
227 
228 #define isascii(c)	(((c) & ~0x7F) == 0)
229 
isupper(int c)230 static __inline int isupper(int c)
231 {
232     return c >= 'A' && c <= 'Z';
233 }
234 
islower(int c)235 static __inline int islower(int c)
236 {
237     return c >= 'a' && c <= 'z';
238 }
239 
isspace(int c)240 static __inline int isspace(int c)
241 {
242     return c == ' ' || (c >= 0x9 && c <= 0xd);
243 }
244 
isdigit(int c)245 static __inline int isdigit(int c)
246 {
247     return c >= '0' && c <= '9';
248 }
249 
isxdigit(int c)250 static __inline int isxdigit(int c)
251 {
252     return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F');
253 }
254 
isalpha(int c)255 static __inline int isalpha(int c)
256 {
257     return isupper(c) || islower(c);
258 }
259 
isalnum(int c)260 static __inline int isalnum(int c)
261 {
262     return isalpha(c) || isdigit(c);
263 }
264 
iscntrl(int c)265 static __inline int iscntrl(int c)
266 {
267 	return (c >= 0 && c < ' ') || c == 127;
268 }
269 
isgraph(int c)270 static __inline int isgraph(int c)
271 {
272 	return c >= '!' && c <= '~';
273 }
274 
ispunct(int c)275 static __inline int ispunct(int c)
276 {
277 	return (c >= '!' && c <= '/') || (c >= ':' && c <= '@') ||
278 	    (c >= '[' && c <= '`') || (c >= '{' && c <= '~');
279 }
280 
isprint(int c)281 static __inline int isprint(int c)
282 {
283 	return (c >= ' ') && (c <= '~');
284 }
285 
toupper(int c)286 static __inline int toupper(int c)
287 {
288     return islower(c) ? c - 'a' + 'A' : c;
289 }
290 
tolower(int c)291 static __inline int tolower(int c)
292 {
293     return isupper(c) ? c - 'A' + 'a' : c;
294 }
295 
296 /* sbrk emulation */
297 extern void	setheap(void *base, void *top);
298 extern char	*sbrk(int incr);
299 
300 extern int	printf(const char *fmt, ...) __printflike(1, 2);
301 extern int	asprintf(char **buf, const char *cfmt, ...) __printflike(2, 3);
302 extern int	sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3);
303 extern int	snprintf(char *buf, size_t size, const char *cfmt, ...) __printflike(3, 4);
304 extern int	vprintf(const char *fmt, __va_list);
305 extern int	vsprintf(char *buf, const char *cfmt, __va_list);
306 extern int	vsnprintf(char *buf, size_t size, const char *cfmt, __va_list);
307 
308 extern void	twiddle(u_int callerdiv);
309 extern void	twiddle_divisor(u_int globaldiv);
310 
311 extern void	ngets(char *, int);
312 #define gets(x)	ngets((x), 0)
313 extern int	fgetstr(char *buf, int size, int fd);
314 
315 extern int	mount(const char *dev, const char *path, int flags, void *data);
316 extern int	unmount(const char *dev, int flags);
317 extern int	open(const char *, int);
318 #define	O_RDONLY	0x0
319 #define O_WRONLY	0x1
320 #define O_RDWR		0x2
321 #define O_ACCMODE	0x3
322 /* NOT IMPLEMENTED */
323 #define	O_CREAT		0x0200		/* create if nonexistent */
324 #define	O_TRUNC		0x0400		/* truncate to zero length */
325 extern int	close(int);
326 extern void	closeall(void);
327 extern ssize_t	read(int, void *, size_t);
328 extern ssize_t	write(int, const void *, size_t);
329 extern int	ioctl(int, u_long, void *);
330 extern struct	dirent *readdirfd(int);
331 extern void	preload(int);
332 
333 extern void	srandom(unsigned int);
334 extern long	random(void);
335 
336 /* imports from stdlib, locally modified */
337 extern char	*optarg;			/* getopt(3) external variables */
338 extern int	optind, opterr, optopt, optreset;
339 extern int	getopt(int, char * const [], const char *);
340 
341 /* pager.c */
342 extern void	pager_open(void);
343 extern void	pager_close(void);
344 extern int	pager_output(const char *lines);
345 extern int	pager_file(const char *fname);
346 
347 /* No signal state to preserve */
348 #define setjmp	_setjmp
349 #define longjmp	_longjmp
350 
351 /* environment.c */
352 #define EV_DYNAMIC	(1<<0)		/* value was dynamically allocated, free if changed/unset */
353 #define EV_VOLATILE	(1<<1)		/* value is volatile, make a copy of it */
354 #define EV_NOHOOK	(1<<2)		/* don't call hook when setting */
355 #define EV_NOKENV	(1<<3)		/* don't add to kenv (loader-only) */
356 
357 struct env_var;
358 typedef char	*(ev_format_t)(struct env_var *ev);
359 typedef int	(ev_sethook_t)(struct env_var *ev, int flags,
360 		    const void *value);
361 typedef int	(ev_unsethook_t)(struct env_var *ev);
362 
363 struct env_var
364 {
365     char		*ev_name;
366     int			ev_flags;
367     void		*ev_value;
368     ev_sethook_t	*ev_sethook;
369     ev_unsethook_t	*ev_unsethook;
370     struct env_var	*ev_next, *ev_prev;
371 };
372 extern struct env_var	*environ;
373 
374 extern struct env_var	*env_getenv(const char *name);
375 extern int		env_setenv(const char *name, int flags,
376 				   const void *value, ev_sethook_t sethook,
377 				   ev_unsethook_t unsethook);
378 extern void		env_discard(struct env_var *);
379 extern char		*getenv(const char *name);
380 extern int		setenv(const char *name, const char *value,
381 			       int overwrite);
382 extern int		putenv(char *string);
383 extern int		unsetenv(const char *name);
384 
385 extern ev_sethook_t	env_noset;		/* refuse set operation */
386 extern ev_unsethook_t	env_nounset;		/* refuse unset operation */
387 
388 /* stdlib.h routines */
389 extern int		abs(int a);
390 extern void		abort(void) __dead2;
391 extern long		strtol(const char * __restrict, char ** __restrict, int);
392 extern long long	strtoll(const char * __restrict, char ** __restrict, int);
393 extern unsigned long	strtoul(const char * __restrict, char ** __restrict, int);
394 extern unsigned long long strtoull(const char * __restrict, char ** __restrict, int);
395 
396 /* BCD conversions (undocumented) */
397 extern u_char const	bcd2bin_data[];
398 extern u_char const	bin2bcd_data[];
399 extern char const	hex2ascii_data[];
400 
401 #define	bcd2bin(bcd)	(bcd2bin_data[bcd])
402 #define	bin2bcd(bin)	(bin2bcd_data[bin])
403 #define	hex2ascii(hex)	(hex2ascii_data[hex])
404 #define	validbcd(bcd)	(bcd == 0 || (bcd > 0 && bcd <= 0x99 && bcd2bin_data[bcd] != 0))
405 
406 /* min/max (undocumented) */
imax(int a,int b)407 static __inline int imax(int a, int b) { return (a > b ? a : b); }
imin(int a,int b)408 static __inline int imin(int a, int b) { return (a < b ? a : b); }
lmax(long a,long b)409 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
lmin(long a,long b)410 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
max(u_int a,u_int b)411 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
min(u_int a,u_int b)412 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
qmax(quad_t a,quad_t b)413 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
qmin(quad_t a,quad_t b)414 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
ulmax(u_long a,u_long b)415 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
ulmin(u_long a,u_long b)416 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
417 
418 /* null functions for device/filesystem switches (undocumented) */
419 extern int	nodev(void);
420 extern int	noioctl(struct open_file *, u_long, void *);
421 extern void	nullsys(void);
422 
423 extern int	null_open(const char *path, struct open_file *f);
424 extern int	null_close(struct open_file *f);
425 extern int	null_read(struct open_file *f, void *buf, size_t size, size_t *resid);
426 extern int	null_write(struct open_file *f, const void *buf, size_t size, size_t *resid);
427 extern off_t	null_seek(struct open_file *f, off_t offset, int where);
428 extern int	null_stat(struct open_file *f, struct stat *sb);
429 extern int	null_readdir(struct open_file *f, struct dirent *d);
430 
431 
432 /*
433  * Machine dependent functions and data, must be provided or stubbed by
434  * the consumer
435  */
436 extern void		exit(int) __dead2;
437 extern int		getchar(void);
438 extern int		ischar(void);
439 extern void		putchar(int);
440 extern int		devopen(struct open_file *, const char *, const char **);
441 extern int		devclose(struct open_file *f);
442 extern void		panic(const char *, ...) __dead2 __printflike(1, 2);
443 extern void		panic_action(void) __weak_symbol __dead2;
444 extern time_t		getsecs(void);
445 extern struct fs_ops	*file_system[];
446 extern struct fs_ops	*exclusive_file_system;
447 extern struct devsw	*devsw[];
448 
449 /*
450  * Time routines
451  */
452 time_t time(time_t *);
453 
454 /*
455  * Expose byteorder(3) functions.
456  */
457 #ifndef _BYTEORDER_PROTOTYPED
458 #define	_BYTEORDER_PROTOTYPED
459 extern uint32_t		htonl(uint32_t);
460 extern uint16_t		htons(uint16_t);
461 extern uint32_t		ntohl(uint32_t);
462 extern uint16_t		ntohs(uint16_t);
463 #endif
464 
465 #ifndef _BYTEORDER_FUNC_DEFINED
466 #define	_BYTEORDER_FUNC_DEFINED
467 #define	htonl(x)	__htonl(x)
468 #define	htons(x)	__htons(x)
469 #define	ntohl(x)	__ntohl(x)
470 #define	ntohs(x)	__ntohs(x)
471 #endif
472 
473 void *Malloc(size_t, const char *, int);
474 void *Memalign(size_t, size_t, const char *, int);
475 void *Calloc(size_t, size_t, const char *, int);
476 void *Realloc(void *, size_t, const char *, int);
477 void *Reallocf(void *, size_t, const char *, int);
478 void Free(void *, const char *, int);
479 extern void	mallocstats(void);
480 
481 const char *x86_hypervisor(void);
482 
483 #ifdef USER_MALLOC
484 extern void *malloc(size_t);
485 extern void *memalign(size_t, size_t);
486 extern void *calloc(size_t, size_t);
487 extern void free(void *);
488 extern void *realloc(void *, size_t);
489 extern void *reallocf(void *, size_t);
490 #elif defined(DEBUG_MALLOC)
491 #define malloc(x)	Malloc(x, __FILE__, __LINE__)
492 #define memalign(x, y)	Memalign(x, y, __FILE__, __LINE__)
493 #define calloc(x, y)	Calloc(x, y, __FILE__, __LINE__)
494 #define free(x)		Free(x, __FILE__, __LINE__)
495 #define realloc(x, y)	Realloc(x, y, __FILE__, __LINE__)
496 #define reallocf(x, y)	Reallocf(x, y, __FILE__, __LINE__)
497 #else
498 #define malloc(x)	Malloc(x, NULL, 0)
499 #define memalign(x, y)	Memalign(x, y, NULL, 0)
500 #define calloc(x, y)	Calloc(x, y, NULL, 0)
501 #define free(x)		Free(x, NULL, 0)
502 #define realloc(x, y)	Realloc(x, y, NULL, 0)
503 #define reallocf(x, y)	Reallocf(x, y, NULL, 0)
504 #endif
505 
506 /*
507  * va <-> pa routines. MD code must supply.
508  */
509 caddr_t ptov(uintptr_t);
510 
511 /* dev_net.c */
512 bool is_tftp(void);
513 
514 /* features.c */
515 typedef void (feature_iter_fn)(void *, const char *, const char *, bool);
516 
517 extern void feature_enable(uint32_t);
518 extern bool feature_name_is_enabled(const char *);
519 extern void feature_iter(feature_iter_fn *, void *);
520 
521 /*
522  * Note that these should also be added to the mapping table in features.c,
523  * which the interpreter may query to provide details from.  The name with
524  * FEATURE_ removed is assumed to be the name we'll provide in the loader
525  * features table, just to simplify reasoning about these.
526  */
527 #define	FEATURE_EARLY_ACPI	0x0001
528 
529 /* hexdump.c */
530 void	hexdump(caddr_t region, size_t len);
531 
532 /* nvstore.c */
533 typedef int (nvstore_getter_cb_t)(void *, const char *, void **);
534 typedef int (nvstore_setter_cb_t)(void *, int, const char *,
535     const void *, size_t);
536 typedef int (nvstore_setter_str_cb_t)(void *, const char *, const char *,
537     const char *);
538 typedef int (nvstore_unset_cb_t)(void *, const char *);
539 typedef int (nvstore_print_cb_t)(void *, void *);
540 typedef int (nvstore_iterate_cb_t)(void *, int (*)(void *, void *));
541 
542 typedef struct nvs_callbacks {
543 	nvstore_getter_cb_t	*nvs_getter;
544 	nvstore_setter_cb_t	*nvs_setter;
545 	nvstore_setter_str_cb_t *nvs_setter_str;
546 	nvstore_unset_cb_t	*nvs_unset;
547 	nvstore_print_cb_t	*nvs_print;
548 	nvstore_iterate_cb_t	*nvs_iterate;
549 } nvs_callbacks_t;
550 
551 int nvstore_init(const char *, nvs_callbacks_t *, void *);
552 int nvstore_fini(const char *);
553 void *nvstore_get_store(const char *);
554 int nvstore_print(void *);
555 int nvstore_get_var(void *, const char *, void **);
556 int nvstore_set_var(void *, int, const char *, void *, size_t);
557 int nvstore_set_var_from_string(void *, const char *, const char *,
558     const char *);
559 int nvstore_unset_var(void *, const char *);
560 
561 /* tslog.c */
562 #define TSRAW(a, b, c) tslog(a, b, c)
563 #define TSENTER() TSRAW("ENTER", __func__, NULL)
564 #define TSENTER2(x) TSRAW("ENTER", __func__, x)
565 #define TSEXIT() TSRAW("EXIT", __func__, NULL)
566 #define TSLINE() TSRAW("EVENT", __FILE__, __XSTRING(__LINE__))
567 void tslog(const char *, const char *, const char *);
568 void tslog_setbuf(void * buf, size_t len);
569 void tslog_getbuf(void ** buf, size_t * len);
570 
571 __END_DECLS
572 
573 /* define _DEBUG_LEVEL n or _DEBUG_LEVEL_VAR before include */
574 #ifndef DEBUG_PRINTF
575 # if defined(_DEBUG_LEVEL) || defined(_DEBUG_LEVEL_VAR)
576 #   ifndef _DEBUG_LEVEL_VAR
577 #     define _DEBUG_LEVEL_VAR _debug
578 static int _debug = _DEBUG_LEVEL;
579 #   endif
580 #   define DEBUG_PRINTF(n, args) if (_DEBUG_LEVEL_VAR >= n) printf args
581 # else
582 #   define DEBUG_PRINTF(n, args)
583 # endif
584 #endif
585 
586 #endif	/* STAND_H */
587