138451Smsmith/* 238451Smsmith * Copyright (c) 1998 Michael Smith. 338451Smsmith * All rights reserved. 438451Smsmith * 538451Smsmith * Redistribution and use in source and binary forms, with or without 638451Smsmith * modification, are permitted provided that the following conditions 738451Smsmith * are met: 838451Smsmith * 1. Redistributions of source code must retain the above copyright 938451Smsmith * notice, this list of conditions and the following disclaimer. 1038451Smsmith * 2. Redistributions in binary form must reproduce the above copyright 1138451Smsmith * notice, this list of conditions and the following disclaimer in the 1238451Smsmith * documentation and/or other materials provided with the distribution. 1338451Smsmith * 1438451Smsmith * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1538451Smsmith * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1638451Smsmith * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1738451Smsmith * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1838451Smsmith * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1938451Smsmith * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2038451Smsmith * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2138451Smsmith * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2238451Smsmith * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2338451Smsmith * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2438451Smsmith * SUCH DAMAGE. 2538451Smsmith * 2650476Speter * $FreeBSD$ 2738451Smsmith * From $NetBSD: stand.h,v 1.22 1997/06/26 19:17:40 drochner Exp $ 2838451Smsmith */ 2938451Smsmith 3038451Smsmith/*- 3138451Smsmith * Copyright (c) 1993 3238451Smsmith * The Regents of the University of California. All rights reserved. 3338451Smsmith * 3438451Smsmith * Redistribution and use in source and binary forms, with or without 3538451Smsmith * modification, are permitted provided that the following conditions 3638451Smsmith * are met: 3738451Smsmith * 1. Redistributions of source code must retain the above copyright 3838451Smsmith * notice, this list of conditions and the following disclaimer. 3938451Smsmith * 2. Redistributions in binary form must reproduce the above copyright 4038451Smsmith * notice, this list of conditions and the following disclaimer in the 4138451Smsmith * documentation and/or other materials provided with the distribution. 4238451Smsmith * 4. Neither the name of the University nor the names of its contributors 4338451Smsmith * may be used to endorse or promote products derived from this software 4438451Smsmith * without specific prior written permission. 4538451Smsmith * 4638451Smsmith * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 4738451Smsmith * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 4838451Smsmith * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 4938451Smsmith * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 5038451Smsmith * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 5138451Smsmith * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 5238451Smsmith * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 5338451Smsmith * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 5438451Smsmith * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 5538451Smsmith * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 5638451Smsmith * SUCH DAMAGE. 5738451Smsmith * 5838451Smsmith * @(#)stand.h 8.1 (Berkeley) 6/11/93 5938451Smsmith */ 6038451Smsmith 61146327Sobrien#ifndef STAND_H 62146327Sobrien#define STAND_H 63146327Sobrien 6438451Smsmith#include <sys/types.h> 6538451Smsmith#include <sys/cdefs.h> 6638451Smsmith#include <sys/stat.h> 6759766Sjlemon#include <sys/dirent.h> 68223905Savatar 69223905Savatar/* this header intentionally exports NULL from <string.h> */ 7064185Sjhb#include <string.h> 7138451Smsmith 72135576Sstefanf#define CHK(fmt, args...) printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args) 73135576Sstefanf#define PCHK(fmt, args...) {printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args); getchar();} 7439665Smsmith 7538451Smsmith/* Avoid unwanted userlandish components */ 7655206Speter#define _KERNEL 7738451Smsmith#include <sys/errno.h> 7855206Speter#undef _KERNEL 7938451Smsmith 8038451Smsmith/* special stand error codes */ 8138451Smsmith#define EADAPT (ELAST+1) /* bad adaptor */ 8238451Smsmith#define ECTLR (ELAST+2) /* bad controller */ 8338451Smsmith#define EUNIT (ELAST+3) /* bad unit */ 8438451Smsmith#define ESLICE (ELAST+4) /* bad slice */ 8538451Smsmith#define EPART (ELAST+5) /* bad partition */ 8638451Smsmith#define ERDLAB (ELAST+6) /* can't read disk label */ 8738451Smsmith#define EUNLAB (ELAST+7) /* unlabeled disk */ 8838451Smsmith#define EOFFSET (ELAST+8) /* relative seek not supported */ 8938451Smsmith#define ESALAST (ELAST+8) /* */ 9038451Smsmith 9138451Smsmithstruct open_file; 9238451Smsmith 9338451Smsmith/* 9438451Smsmith * This structure is used to define file system operations in a file system 9538451Smsmith * independent way. 9638451Smsmith * 9738451Smsmith * XXX note that filesystem providers should export a pointer to their fs_ops 9838451Smsmith * struct, so that consumers can reference this and thus include the 9938451Smsmith * filesystems that they require. 10038451Smsmith */ 10138451Smsmithstruct fs_ops { 10239468Smsmith const char *fs_name; 10339468Smsmith int (*fo_open)(const char *path, struct open_file *f); 10438451Smsmith int (*fo_close)(struct open_file *f); 10538451Smsmith int (*fo_read)(struct open_file *f, void *buf, 10638451Smsmith size_t size, size_t *resid); 10738451Smsmith int (*fo_write)(struct open_file *f, void *buf, 10838451Smsmith size_t size, size_t *resid); 10938451Smsmith off_t (*fo_seek)(struct open_file *f, off_t offset, int where); 11038451Smsmith int (*fo_stat)(struct open_file *f, struct stat *sb); 11159766Sjlemon int (*fo_readdir)(struct open_file *f, struct dirent *d); 11238451Smsmith}; 11338451Smsmith 11438451Smsmith/* 11538451Smsmith * libstand-supplied filesystems 11638451Smsmith */ 11738451Smsmithextern struct fs_ops ufs_fsops; 11838451Smsmithextern struct fs_ops tftp_fsops; 11938451Smsmithextern struct fs_ops nfs_fsops; 12038451Smsmithextern struct fs_ops cd9660_fsops; 121235537Sgberextern struct fs_ops nandfs_fsops; 122108100Sjakeextern struct fs_ops gzipfs_fsops; 12383610Ssobomaxextern struct fs_ops bzipfs_fsops; 12438451Smsmithextern struct fs_ops dosfs_fsops; 12559766Sjlemonextern struct fs_ops ext2fs_fsops; 12692494Ssobomaxextern struct fs_ops splitfs_fsops; 12738451Smsmith 12838451Smsmith/* where values for lseek(2) */ 12938451Smsmith#define SEEK_SET 0 /* set file offset to offset */ 13038451Smsmith#define SEEK_CUR 1 /* set file offset to current plus offset */ 13138451Smsmith#define SEEK_END 2 /* set file offset to EOF plus offset */ 13238451Smsmith 13338451Smsmith/* 13438451Smsmith * Device switch 13538451Smsmith */ 13638451Smsmithstruct devsw { 13739468Smsmith const char dv_name[8]; 13838451Smsmith int dv_type; /* opaque type constant, arch-dependant */ 13938451Smsmith int (*dv_init)(void); /* early probe call */ 14064185Sjhb int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, 14164185Sjhb char *buf, size_t *rsize); 14238451Smsmith int (*dv_open)(struct open_file *f, ...); 14338451Smsmith int (*dv_close)(struct open_file *f); 14438451Smsmith int (*dv_ioctl)(struct open_file *f, u_long cmd, void *data); 14540774Smsmith void (*dv_print)(int verbose); /* print device information */ 14664185Sjhb void (*dv_cleanup)(void); 14738451Smsmith}; 14838451Smsmith 14959766Sjlemon/* 15059766Sjlemon * libstand-supplied device switch 15159766Sjlemon */ 15259766Sjlemonextern struct devsw netdev; 15359766Sjlemon 15438451Smsmithextern int errno; 15538451Smsmith 15638451Smsmithstruct open_file { 15738451Smsmith int f_flags; /* see F_* below */ 15838451Smsmith struct devsw *f_dev; /* pointer to device operations */ 15938451Smsmith void *f_devdata; /* device specific data */ 16038451Smsmith struct fs_ops *f_ops; /* pointer to file system operations */ 16138451Smsmith void *f_fsdata; /* file system specific data */ 16265470Smsmith off_t f_offset; /* current file offset */ 16365470Smsmith char *f_rabuf; /* readahead buffer pointer */ 16465470Smsmith size_t f_ralen; /* valid data in readahead buffer */ 16565470Smsmith off_t f_raoffset; /* consumer offset in readahead buffer */ 16665470Smsmith#define SOPEN_RASIZE 512 16738451Smsmith}; 16838451Smsmith 169192679Sdfr#define SOPEN_MAX 64 17038451Smsmithextern struct open_file files[]; 17138451Smsmith 17238451Smsmith/* f_flags values */ 17338451Smsmith#define F_READ 0x0001 /* file opened for reading */ 17438451Smsmith#define F_WRITE 0x0002 /* file opened for writing */ 17538451Smsmith#define F_RAW 0x0004 /* raw device open - no file system */ 17638451Smsmith#define F_NODEV 0x0008 /* network open - no device */ 17738451Smsmith 17855181Speter#define isascii(c) (((c) & ~0x7F) == 0) 17938451Smsmith 18076579Sdcsstatic __inline int isupper(int c) 18176579Sdcs{ 18276579Sdcs return c >= 'A' && c <= 'Z'; 18376579Sdcs} 18476579Sdcs 18576579Sdcsstatic __inline int islower(int c) 18676579Sdcs{ 18776579Sdcs return c >= 'a' && c <= 'z'; 18876579Sdcs} 18976579Sdcs 19076579Sdcsstatic __inline int isspace(int c) 19176579Sdcs{ 19276579Sdcs return c == ' ' || (c >= 0x9 && c <= 0xd); 19376579Sdcs} 19476579Sdcs 19576579Sdcsstatic __inline int isdigit(int c) 19676579Sdcs{ 19776579Sdcs return c >= '0' && c <= '9'; 19876579Sdcs} 19976579Sdcs 20076579Sdcsstatic __inline int isxdigit(int c) 20176579Sdcs{ 20276579Sdcs return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'); 20376579Sdcs} 20476579Sdcs 20576579Sdcsstatic __inline int isalpha(int c) 20676579Sdcs{ 20776579Sdcs return isupper(c) || islower(c); 20876579Sdcs} 20976579Sdcs 21076579Sdcsstatic __inline int isalnum(int c) 21176579Sdcs{ 21276579Sdcs return isalpha(c) || isdigit(c); 21376579Sdcs} 21476579Sdcs 21551169Sdfrstatic __inline int toupper(int c) 21651169Sdfr{ 21751169Sdfr return islower(c) ? c - 'a' + 'A' : c; 21851169Sdfr} 21951169Sdfr 22051169Sdfrstatic __inline int tolower(int c) 22151169Sdfr{ 22251169Sdfr return isupper(c) ? c - 'A' + 'a' : c; 22351169Sdfr} 22451169Sdfr 22539665Smsmith/* sbrk emulation */ 22639665Smsmithextern void setheap(void *base, void *top); 22739665Smsmithextern char *sbrk(int incr); 22838451Smsmith 22939665Smsmith/* Matt Dillon's zalloc/zmalloc */ 23039665Smsmithextern void *malloc(size_t bytes); 23139665Smsmithextern void free(void *ptr); 23239665Smsmith/*#define free(p) {CHK("free %p", p); free(p);} */ /* use for catching guard violations */ 23339665Smsmithextern void *calloc(size_t n1, size_t n2); 23439665Smsmithextern void *realloc(void *ptr, size_t size); 23539665Smsmithextern void *reallocf(void *ptr, size_t size); 23639665Smsmithextern void mallocstats(void); 23739665Smsmith 238100392Speterextern int printf(const char *fmt, ...) __printflike(1, 2); 239102227Smikeextern void vprintf(const char *fmt, __va_list); 240100392Speterextern int sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3); 241273664Sianextern int snprintf(char *buf, size_t size, const char *cfmt, ...) __printflike(3, 4); 242102227Smikeextern void vsprintf(char *buf, const char *cfmt, __va_list); 24338451Smsmith 244278602Sianextern void twiddle(u_int callerdiv); 245278602Sianextern void twiddle_divisor(u_int globaldiv); 24638451Smsmith 24738451Smsmithextern void ngets(char *, int); 24838451Smsmith#define gets(x) ngets((x), 0) 24938451Smsmithextern int fgetstr(char *buf, int size, int fd); 25038451Smsmith 25138451Smsmithextern int open(const char *, int); 25238451Smsmith#define O_RDONLY 0x0 25387632Sjhb#define O_WRONLY 0x1 25438451Smsmith#define O_RDWR 0x2 25538451Smsmithextern int close(int); 25638451Smsmithextern void closeall(void); 25738451Smsmithextern ssize_t read(int, void *, size_t); 25838451Smsmithextern ssize_t write(int, void *, size_t); 25959766Sjlemonextern struct dirent *readdirfd(int); 26038451Smsmith 26138451Smsmithextern void srandom(u_long seed); 26238451Smsmithextern u_long random(void); 26338451Smsmith 26438451Smsmith/* imports from stdlib, locally modified */ 26538451Smsmithextern long strtol(const char *, char **, int); 266246931Skientzleextern unsigned long strtoul(const char *, char **, int); 26738451Smsmithextern char *optarg; /* getopt(3) external variables */ 26842511Smsmithextern int optind, opterr, optopt, optreset; 26938451Smsmithextern int getopt(int, char * const [], const char *); 27038451Smsmith 27138451Smsmith/* pager.c */ 27238451Smsmithextern void pager_open(void); 27338451Smsmithextern void pager_close(void); 27438451Smsmithextern int pager_output(const char *lines); 27539468Smsmithextern int pager_file(const char *fname); 27638451Smsmith 27740891Smsmith/* No signal state to preserve */ 27840891Smsmith#define setjmp _setjmp 27940891Smsmith#define longjmp _longjmp 28040891Smsmith 28138451Smsmith/* environment.c */ 28238451Smsmith#define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */ 28338451Smsmith#define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */ 28438451Smsmith#define EV_NOHOOK (1<<2) /* don't call hook when setting */ 28538451Smsmith 28638451Smsmithstruct env_var; 28738451Smsmithtypedef char *(ev_format_t)(struct env_var *ev); 288121532Spetertypedef int (ev_sethook_t)(struct env_var *ev, int flags, 289121532Speter const void *value); 29038451Smsmithtypedef int (ev_unsethook_t)(struct env_var *ev); 29138451Smsmith 29238451Smsmithstruct env_var 29338451Smsmith{ 29438451Smsmith char *ev_name; 29538451Smsmith int ev_flags; 29638451Smsmith void *ev_value; 29738451Smsmith ev_sethook_t *ev_sethook; 29838451Smsmith ev_unsethook_t *ev_unsethook; 29938451Smsmith struct env_var *ev_next, *ev_prev; 30038451Smsmith}; 30138451Smsmithextern struct env_var *environ; 30238451Smsmith 30338451Smsmithextern struct env_var *env_getenv(const char *name); 30464185Sjhbextern int env_setenv(const char *name, int flags, 30564185Sjhb const void *value, ev_sethook_t sethook, 30664185Sjhb ev_unsethook_t unsethook); 30738451Smsmithextern char *getenv(const char *name); 30864185Sjhbextern int setenv(const char *name, const char *value, 30964185Sjhb int overwrite); 31038451Smsmithextern int putenv(const char *string); 31138451Smsmithextern int unsetenv(const char *name); 31238451Smsmith 31338451Smsmithextern ev_sethook_t env_noset; /* refuse set operation */ 31438451Smsmithextern ev_unsethook_t env_nounset; /* refuse unset operation */ 31538451Smsmith 31638451Smsmith/* BCD conversions (undocumented) */ 31738451Smsmithextern u_char const bcd2bin_data[]; 31838451Smsmithextern u_char const bin2bcd_data[]; 31938451Smsmithextern char const hex2ascii_data[]; 32038451Smsmith 32138451Smsmith#define bcd2bin(bcd) (bcd2bin_data[bcd]) 32238451Smsmith#define bin2bcd(bin) (bin2bcd_data[bin]) 32338451Smsmith#define hex2ascii(hex) (hex2ascii_data[hex]) 32438451Smsmith 32538451Smsmith/* min/max (undocumented) */ 32638451Smsmithstatic __inline int imax(int a, int b) { return (a > b ? a : b); } 32738451Smsmithstatic __inline int imin(int a, int b) { return (a < b ? a : b); } 32838451Smsmithstatic __inline long lmax(long a, long b) { return (a > b ? a : b); } 32938451Smsmithstatic __inline long lmin(long a, long b) { return (a < b ? a : b); } 33038451Smsmithstatic __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); } 33138451Smsmithstatic __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); } 33238451Smsmithstatic __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); } 33338451Smsmithstatic __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); } 33438451Smsmithstatic __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); } 33538451Smsmithstatic __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); } 33638451Smsmith 33738451Smsmith 33838451Smsmith/* null functions for device/filesystem switches (undocumented) */ 33938451Smsmithextern int nodev(void); 34038451Smsmithextern int noioctl(struct open_file *, u_long, void *); 34138451Smsmithextern void nullsys(void); 34238451Smsmith 34339468Smsmithextern int null_open(const char *path, struct open_file *f); 34438451Smsmithextern int null_close(struct open_file *f); 34555137Speterextern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid); 34655137Speterextern int null_write(struct open_file *f, void *buf, size_t size, size_t *resid); 34738451Smsmithextern off_t null_seek(struct open_file *f, off_t offset, int where); 34838451Smsmithextern int null_stat(struct open_file *f, struct stat *sb); 34959766Sjlemonextern int null_readdir(struct open_file *f, struct dirent *d); 35038451Smsmith 35159766Sjlemon 35238451Smsmith/* 35338451Smsmith * Machine dependent functions and data, must be provided or stubbed by 35438451Smsmith * the consumer 35538451Smsmith */ 35638451Smsmithextern int getchar(void); 35738451Smsmithextern int ischar(void); 35838451Smsmithextern void putchar(int); 35939672Sdfrextern int devopen(struct open_file *, const char *, const char **); 36038451Smsmithextern int devclose(struct open_file *f); 361124570Sjhbextern void panic(const char *, ...) __dead2 __printflike(1, 2); 36238451Smsmithextern struct fs_ops *file_system[]; 36338451Smsmithextern struct devsw *devsw[]; 36438451Smsmith 36590868Smike/* 36690868Smike * Expose byteorder(3) functions. 36790868Smike */ 36891959Smike#ifndef _BYTEORDER_PROTOTYPED 36991959Smike#define _BYTEORDER_PROTOTYPED 37091959Smikeextern uint32_t htonl(uint32_t); 37191959Smikeextern uint16_t htons(uint16_t); 37291959Smikeextern uint32_t ntohl(uint32_t); 37391959Smikeextern uint16_t ntohs(uint16_t); 37491959Smike#endif 37591959Smike 37691959Smike#ifndef _BYTEORDER_FUNC_DEFINED 37791959Smike#define _BYTEORDER_FUNC_DEFINED 37890868Smike#define htonl(x) __htonl(x) 37990868Smike#define htons(x) __htons(x) 38090868Smike#define ntohl(x) __ntohl(x) 38190868Smike#define ntohs(x) __ntohs(x) 38291959Smike#endif 38390868Smike 384100394Spetervoid *Malloc(size_t, const char *, int); 385100394Spetervoid *Calloc(size_t, size_t, const char *, int); 386100394Spetervoid *Realloc(void *, size_t, const char *, int); 387100394Spetervoid Free(void *, const char *, int); 38839672Sdfr 389100394Speter#if 1 390100394Speter#define malloc(x) Malloc(x, __FILE__, __LINE__) 391100394Speter#define calloc(x, y) Calloc(x, y, __FILE__, __LINE__) 392100394Speter#define free(x) Free(x, __FILE__, __LINE__) 393100394Speter#define realloc(x, y) Realloc(x, y, __FILE__, __LINE__) 394100394Speter#else 395102216Sscottl#define malloc(x) Malloc(x, NULL, 0) 396100394Speter#define calloc(x, y) Calloc(x, y, NULL, 0) 397100394Speter#define free(x) Free(x, NULL, 0) 398100394Speter#define realloc(x, y) Realloc(x, y, NULL, 0) 39939672Sdfr#endif 400146327Sobrien 401146327Sobrien#endif /* STAND_H */ 402