1 .\" Copyright (c) Michael Smith
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd support library for standalone executables
38 library provides a set of supporting functions for standalone
39 applications, mimicking where possible the standard
43 The following sections group these functions by kind.
44 Unless specifically described here, see the corresponding section 3
45 manpages for the given functions.
47 String functions are available as documented in
55 .Fn malloc "size_t size"
60 bytes of memory from the heap using a best-fit algorithm.
66 Free the allocated object at
70 .Fn setheap "void *start" "void *limit"
74 This function must be called before calling
81 will be used for the heap; attempting to allocate beyond this will result
88 Provides the behaviour of
90 i.e., returns the highest point that the heap has reached.
92 be used during testing to determine the actual heap usage.
98 A set of functions are provided for manipulating a flat variable space similar
99 to the traditional shell-supported environment.
100 Major enhancements are support
101 for set/unset hook functions.
105 .Fn getenv "const char *name"
109 .Fn setenv "const char *name" "const char *value" "int overwrite"
113 .Fn putenv "char *string"
117 .Fn unsetenv "const char *name"
120 These functions behave similarly to their standard library counterparts.
122 .Ft "struct env_var *"
123 .Fn env_getenv "const char *name"
126 Looks up a variable in the environment and returns its entire
130 .Fn env_setenv "const char *name" "int flags" "const void *value" "ev_sethook_t sethook" "ev_unsethook_t unsethook"
133 Creates a new or sets an existing environment variable called
135 If creating a new variable, the
139 arguments may be specified.
141 The set hook is invoked whenever an attempt
142 is made to set the variable, unless the EV_NOHOOK flag is set.
144 a set hook will validate the
146 argument, and then call
148 again with EV_NOHOOK set to actually save the value.
149 The predefined function
151 may be specified to refuse all attempts to set a variable.
153 The unset hook is invoked when an attempt is made to unset a variable.
155 returns zero, the variable will be unset.
156 The predefined function
158 may be used to prevent a variable being unset.
160 .Sh STANDARD LIBRARY SUPPORT
168 .Fn getopt "int argc" "char * const *argv" "const char *optstring"
172 .Fn strtol "const char *nptr" "char **endptr" "int base"
176 .Fn strtoll "const char *nptr" "char **endptr" "int base"
180 .Fn strtoul "const char *nptr" "char **endptr" "int base"
184 .Fn strtoull "const char *nptr" "char **endptr" "int base"
188 .Fn srandom "unsigned int seed"
196 .Fn strerror "int error"
199 Returns error messages for the subset of errno values supported by
201 .It Fn assert expression
207 .Fn setjmp "jmp_buf env"
211 .Fn longjmp "jmp_buf env" "int val"
218 respectively as there is no signal state to manipulate.
229 Read characters from the console into
231 All of the standard cautions apply to this function.
234 .Fn ngets "char *buf" "int size"
239 - 1 characters from the console into
243 is less than 1, the function's behaviour is as for
247 .Fn fgetstr "char *buf" "int size" "int fd"
250 Read a line of at most
254 Line terminating characters are stripped, and the buffer is always
257 Returns the number of characters in
259 if successful, or -1 if a read error occurs.
262 .Fn printf "const char *fmt" "..."
266 .Fn vprintf "const char *fmt" "va_list ap"
270 .Fn sprintf "char *buf" "const char *fmt" "..."
274 .Fn vsprintf "char *buf" "const char *fmt" "va_list ap"
277 The *printf functions implement a subset of the standard
279 family functionality and some extensions.
280 The following standard conversions
281 are supported: c,d,n,o,p,s,u,x.
282 The following modifiers are supported:
283 +,-,#,*,0,field width,precision,l.
287 conversion is provided to decode error registers.
289 .Bd -ragged -offset indent
297 where <base> is the output expressed as a control character, e.g.\& \e10 gives
298 octal, \e20 gives hex.
299 Each <arg> is a sequence of characters, the first of
300 which gives the bit number to be inspected (origin 1) and the next characters
301 (up to a character less than 32) give the text to be displayed if the bit is set.
303 .Bd -ragged -offset indent
307 .Qq \e10\e2BITTWO\e1BITONE
311 would give the output
312 .Bd -ragged -offset indent
318 conversion provides a hexdump facility, e.g.
319 .Bd -ragged -offset indent
325 .Qq XX:XX:XX:XX:XX:XX
327 .Bd -ragged -offset indent
337 .Sh CHARACTER TESTS AND CONVERSIONS
396 .Fn open "const char *path" "int flags"
399 Similar to the behaviour as specified in
401 except that file creation is not supported, so the mode parameter is not
405 argument may be one of O_RDONLY, O_WRONLY and O_RDWR.
406 Only UFS currently supports writing.
416 Close all open files.
419 .Fn read "int fd" "void *buf" "size_t len"
423 .Fn write "int fd" "void *buf" "size_t len"
426 (No file systems currently support writing.)
429 .Fn lseek "int fd" "off_t offset" "int whence"
432 Files being automatically uncompressed during reading cannot seek backwards
433 from the current point.
436 .Fn stat "const char *path" "struct stat *sb"
440 .Fn fstat "int fd" "struct stat *sb"
447 functions only fill out the following fields in the
449 structure: st_mode,st_nlink,st_uid,st_gid,st_size.
452 file system cannot provide meaningful values for this call, and the
454 file system always reports files having uid/gid of zero.
459 library supplies a simple internal pager to ease reading the output of large
467 Initialises the pager and tells it that the next line output will be the top of the
469 The environment variable LINES is consulted to determine the number of
470 lines to be displayed before pausing.
479 .Fn pager_output "const char *lines"
482 Sends the lines in the
484 -terminated buffer at
487 Newline characters are counted in order to determine the number
488 of lines being output (wrapped lines are not accounted for).
491 function will return zero when all of the lines have been output, or nonzero
492 if the display was paused and the user elected to quit.
495 .Fn pager_file "const char *fname"
498 Attempts to open and display the file
500 Returns -1 on error, 0 at EOF, or 1 if the user elects to quit while reading.
506 .Fn devformat "struct devdesc *"
509 Format the specified device as a string.
512 .Fn devparse "struct devdesc **dev" "const char *devdesc" "const char **path"
518 .Sq device:[/path/to/file] .
521 table is used to match the start of the
527 is non-NULL, then it will be called to parse the rest of the string and allocate
531 If NULL, then a default routine will be called that will allocate a simple
533 parse a unit number and ensure there's no trailing characters.
536 is non-NULL, then a pointer to the remainder of the
538 string after the device specification is written.
544 Successive calls emit the characters in the sequence |,/,-,\\ followed by a
545 backspace in order to provide reassurance to the user.
547 .Sh REQUIRED LOW-LEVEL SUPPORT
548 The following resources are consumed by
550 - stack, heap, console and devices.
552 The stack must be established before
554 functions can be invoked.
555 Stack requirements vary depending on the functions
556 and file systems used by the consumer and the support layer functions detailed
559 The heap must be established before calling
565 Heap usage will vary depending on the number of simultaneously open files,
566 as well as client behaviour.
567 Automatic decompression will allocate more
568 than 64K of data per open file.
570 Console access is performed via the
575 functions detailed below.
577 Device access is initiated via
579 and is performed through the
584 functions in the device switch structure that
588 The consumer must provide the following support functions:
595 Return a character from the console, used by
604 Returns nonzero if a character is waiting from the console.
610 Write a character to the console, used by
617 and thus by many other functions for debugging and informational output.
620 .Fn devopen "struct open_file *of" "const char *name" "const char **file"
623 Open the appropriate device for the file named in
627 a pointer to the remaining body of
629 which does not refer to the device.
634 will be set to point to the
636 structure for the opened device if successful.
637 Device identifiers must
638 always precede the path component, but may otherwise be arbitrarily formatted.
641 and thus for all device-related I/O.
644 .Fn devclose "struct open_file *of"
647 Close the device allocated for
649 The device driver itself will already have been called for the close; this call
650 should clean up any allocation made by devopen only.
661 .Fn panic "const char *msg" "..."
664 Signal a fatal and unrecoverable error condition.
670 .Sh INTERNAL FILE SYSTEMS
671 Internal file systems are enabled by the consumer exporting the array
672 .Vt struct fs_ops *file_system[] ,
673 which should be initialised with pointers
677 The following file system handlers are supplied by
679 the consumer may supply other file systems of their own:
680 .Bl -hang -width ".Va cd9660_fsops"
686 Linux ext2fs file system.
688 File access via TFTP.
692 ISO 9660 (CD-ROM) file system.
694 Stacked file system supporting gzipped files.
695 When trying the gzipfs file system,
699 to the end of the filename, and then tries to locate the file using the other
701 Placement of this file system in the
703 array determines whether gzipped files will be opened in preference to non-gzipped
705 It is only possible to seek a gzipped file forwards, and
709 on gzipped files will report an invalid length.
714 .Xr bzip2 1 Ns -compressed
720 pointers should be terminated with a NULL.
722 Devices are exported by the supporting code via the array
723 .Vt struct devsw *devsw[]
724 which is a NULL terminated array of pointers to device switch structures.
726 The driver needs to provide a common set of entry points that are
729 to interface with the device.
732 const char dv_name[DEV_NAMLEN];
734 int (*dv_init)(void);
735 int (*dv_strategy)(void *devdata, int rw, daddr_t blk,
736 size_t size, char *buf, size_t *rsize);
737 int (*dv_open)(struct open_file *f, ...);
738 int (*dv_close)(struct open_file *f);
739 int (*dv_ioctl)(struct open_file *f, u_long cmd, void *data);
740 int (*dv_print)(int verbose);
741 void (*dv_cleanup)(void);
742 char * (*dv_fmtdev)(struct devdesc *);
743 int (*dv_parsedev)(struct devdesc **dev, const char *devpart,
747 .Bl -tag -width ".Fn dv_strategy"
752 The supported types are:
753 .Bl -tag -width "DEVT_NONE"
761 Each type may have its own associated (struct type_devdesc),
762 which has the generic (struct devdesc) as its first member.
764 Driver initialization routine.
765 This routine should probe for available units.
766 Drivers are responsible for maintaining lists of units for later enumeration.
767 No other driver routines may be called before
771 The driver open routine.
773 The driver close routine.
775 The driver ioctl routine.
777 Prints information about the available devices.
778 Information should be presented with
781 Cleans up any memory used by the device before the next stage is run.
783 Converts the specified devdesc to the canonical string representation
786 Parses the device portion of a file path.
791 of device name, possibly followed by a colon and a path within the device.
794 is, by convention, the part of the device specification that follows the
799 is parsing the string
805 The parsing routine is expected to allocate a new
807 or subclass and return it in
810 This routine should set
812 to point to the portion of the string after device specification, or
814 in the earlier example.
815 Generally, code needing to parse a path will use
817 instead of calling this routine directly.
822 library contains contributions from many sources, including:
837 .An Matthew Dillon Aq Mt dillon@backplane.com
840 The reorganisation and port to
842 the environment functions and this manpage were written by
843 .An Mike Smith Aq Mt msmith@FreeBSD.org .
845 The lack of detailed memory usage data is unhelpful.