lib/libstand/libstand.3

   1 .\" Copyright (c) Michael Smith
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  12 .\"
  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
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/lib/libstand/libstand.3,v 1.5.2.11 2002/06/26 19:14:43 schweikh Exp $
  26 .\"
  27 .Dd January 2, 2013
  28 .Dt LIBSTAND 3
  29 .Os
  30 .Sh NAME
  31 .Nm libstand
  32 .Nd support library for standalone executables
  33 .Sh LIBRARY
  34 .Lb libstand
  35 .Sh SYNOPSIS
  36 .In stand.h
  37 .Sh DESCRIPTION
  38 .Nm
  39 provides a set of supporting functions for standalone
  40 applications, mimicking where possible the standard
  41 .Bx
  42 programming
  43 environment.
  44 The following sections group these functions by kind.
  45 Unless specifically described here, see the corresponding section 3
  46 manpages for the given functions.
  47 .Sh STRING FUNCTIONS
  48 String functions are available as documented in
  49 .Xr string 3
  50 and
  51 .Xr bstring 3 .
  52 .Sh MEMORY ALLOCATION
  53 .Bl -hang -width 10n
  54 .It Xo
  55 .Ft "void *"
  56 .Fn malloc "size_t size"
  57 .Xc
  58 .Pp
  59 Allocate
  60 .Fa size
  61 bytes of memory from the heap using a best-fit algorithm.
  62 .It Xo
  63 .Ft void
  64 .Fn free "void *ptr"
  65 .Xc
  66 .Pp
  67 Free the allocated object at
  68 .Fa ptr .
  69 .It Xo
  70 .Ft void
  71 .Fn setheap "void *start" "void *limit"
  72 .Xc
  73 .Pp
  74 Initialise the heap.
  75 This function must be called before calling
  76 .Fn alloc
  77 for the first time.
  78 The region between
  79 .Fa start
  80 and
  81 .Fa limit
  82 will be used for the heap; attempting to allocate beyond this will result
  83 in a panic.
  84 .It Xo
  85 .Ft "char *"
  86 .Fn sbrk "int junk"
  87 .Xc
  88 .Pp
  89 Provides the behaviour of
  90 .Fn sbrk 0 ,
  91 i.e.\& returns the highest point that the heap has reached.
  92 This value can
  93 be used during testing to determine the actual heap usage.
  94 The
  95 .Fa junk
  96 argument is ignored.
  97 .El
  98 .Sh ENVIRONMENT
  99 A set of functions are provided for manipulating a flat variable space similar
 100 to the traditional shell-supported environment.
 101 Major enhancements are support
 102 for set/unset hook functions.
 103 .Bl -hang -width 10n
 104 .It Xo
 105 .Ft "char *"
 106 .Fn getenv "const char *name"
 107 .Xc
 108 .It Xo
 109 .Ft int
 110 .Fn setenv "const char *name" "char *value" "int overwrite"
 111 .Xc
 112 .It Xo
 113 .Ft int
 114 .Fn putenv "const char *string"
 115 .Xc
 116 .It Xo
 117 .Ft int
 118 .Fn unsetenv "const char *name"
 119 .Xc
 120 .Pp
 121 These functions behave similarly to their standard library counterparts.
 122 .It Xo
 123 .Ft "struct env_var *"
 124 .Fn env_getenv "const char *name"
 125 .Xc
 126 .Pp
 127 Looks up a variable in the environment and returns its entire
 128 data structure.
 129 .It Xo
 130 .Ft int
 131 .Fn env_setenv "const char *name" "int flags" "char *value" "ev_sethook_t sethook" "ev_unsethook_t unsethook"
 132 .Xc
 133 .Pp
 134 Creates a new or sets an existing environment variable called
 135 .Fa name .
 136 If creating a new variable, the
 137 .Fa sethook
 138 and
 139 .Fa unsethook
 140 arguments may be specified.
 141 .Pp
 142 The set hook is invoked whenever an attempt
 143 is made to set the variable, unless the
 144 .Dv EV_NOHOOK
 145 flag is set.
 146 Typically
 147 a set hook will validate the
 148 .Fa value
 149 argument, and then call
 150 .Fn env_setenv
 151 again with
 152 .Dv EV_NOHOOK
 153 set to actually save the value.
 154 The predefined function
 155 .Fn env_noset
 156 may be specified to refuse all attempts to set a variable.
 157 .Pp
 158 The unset hook is invoked when an attempt is made to unset a variable.
 159 If it
 160 returns zero, the  variable will be unset.
 161 The predefined function
 162 .Fn env_nounset
 163 may be used to prevent a variable being unset.
 164 .El
 165 .Sh STANDARD LIBRARY SUPPORT
 166 .Bl -hang -width 10n
 167 .It Xo
 168 .Ft int
 169 .Fn getopt "int argc" "char * const *argv" "const char *optstring"
 170 .Xc
 171 .It Xo
 172 .Ft long
 173 .Fn strtol "const char *nptr" "char **endptr" "int base"
 174 .Xc
 175 .It Xo
 176 .Ft void
 177 .Fn srandom "unsigned long seed"
 178 .Xc
 179 .It Xo
 180 .Ft "unsigned long"
 181 .Fn random void
 182 .Xc
 183 .It Xo
 184 .Ft "char *"
 185 .Fn strerror "int error"
 186 .Xc
 187 .Pp
 188 Returns error messages for the subset of
 189 .Va errno
 190 values supported by
 191 .Nm .
 192 .It Fn assert expression
 193 .Pp
 194 Requires
 195 .In assert.h .
 196 .It Xo
 197 .Ft int
 198 .Fn setjmp "jmp_buf env"
 199 .Xc
 200 .It Xo
 201 .Ft void
 202 .Fn longjmp "jmp_buf env" "int val"
 203 .Xc
 204 .Pp
 205 Defined as
 206 .Fn _setjmp
 207 and
 208 .Fn _longjmp
 209 respectively as there is no signal state to manipulate.
 210 Requires
 211 .In setjmp.h .
 212 .El
 213 .Sh CHARACTER I/O
 214 .Bl -hang -width 10n
 215 .It Xo
 216 .Ft void
 217 .Fn gets "char *buf"
 218 .Xc
 219 .Pp
 220 Read characters from the console into
 221 .Fa buf .
 222 All of the standard cautions apply to this function.
 223 .It Xo
 224 .Ft void
 225 .Fn ngets "char *buf" "size_t size"
 226 .Xc
 227 .Pp
 228 Read at most
 229 .Fa size
 230 - 1 characters from the console into
 231 .Fa buf .
 232 If
 233 .Fa size
 234 is less than 1, the function's behaviour is as for
 235 .Fn gets .
 236 .It Xo
 237 .Ft char *
 238 .Fn fgets "char *buf" "int size" "int fd"
 239 .Xc
 240 .Pp
 241 Read a line of at most
 242 .Fa size Ns -1
 243 characters into
 244 .Fa buf .
 245 Line terminating characters are not stripped,
 246 and the buffer is always nul-terminated.
 247 Upon successful completion a pointer to the string is returned.
 248 If end-of-file occurs before any characters are read,
 249 NULL is returned and the buffer contents remain unchanged.
 250 If an error occurs,
 251 NULL is returned and the buffer contents are indeterminate.
 252 .It Xo
 253 .Ft int
 254 .Fn fgetstr "char *buf" "int size" "int fd"
 255 .Xc
 256 .Pp
 257 Read a line of at most
 258 .Fa size
 259 characters into
 260 .Fa buf .
 261 Line terminating characters are stripped, and the buffer is always
 262 nul-terminated.
 263 Returns the number of characters in
 264 .Fa buf
 265 if successful, or -1 if a read error occurs.
 266 .It Xo
 267 .Ft int
 268 .Fn printf "const char *fmt" "..."
 269 .Xc
 270 .It Xo
 271 .Ft void
 272 .Fn vprintf "const char *fmt" "va_list ap"
 273 .Xc
 274 .It Xo
 275 .Ft int
 276 .Fn sprintf "char *buf" "const char *fmt" "..."
 277 .Xc
 278 .It Xo
 279 .Ft void
 280 .Fn vsprintf "char *buf" "const char *fmt" "va_list ap"
 281 .Xc
 282 .Pp
 283 The *printf functions implement a subset of the standard
 284 .Fn printf
 285 family functionality and some extensions.
 286 The following standard conversions
 287 are supported:
 288 .Cm c , d , n , o , p , s , u , x .
 289 The following modifiers are supported:
 290 .Cm + , - , # , * , 0 , field width,  precision,  l .
 291 .Pp
 292 The
 293 .Cm b
 294 conversion is provided to decode error registers.
 295 Its usage is:
 296 .Bd -ragged -offset indent
 297 printf(
 298 .Qq reg=%b\en ,
 299 regval,
 300 .Qq <base><arg>*
 301 );
 302 .Ed
 303 .Pp
 304 where <base> is the output expressed as a control character, e.g.\& \e10 gives
 305 octal, \e20 gives hex.
 306 Each <arg> is a sequence of characters, the first of
 307 which gives the bit number to be inspected (origin 1) and the next characters
 308 (up to a character less than 32) give the text to be displayed if the bit is set.
 309 Thus
 310 .Bd -ragged -offset indent
 311 printf(
 312 .Qq reg=%b\en ,
 313 3,
 314 .Qq \e10\e2BITTWO\e1BITONE\en
 315 );
 316 .Ed
 317 .Pp
 318 would give the output
 319 .Bd -ragged -offset indent
 320 reg=3<BITTWO,BITONE>
 321 .Ed
 322 .El
 323 .Sh CHARACTER TESTS AND CONVERSIONS
 324 .Bl -hang -width 10n
 325 .It Xo
 326 .Ft int
 327 .Fn isupper "int c"
 328 .Xc
 329 .It Xo
 330 .Ft int
 331 .Fn islower "int c"
 332 .Xc
 333 .It Xo
 334 .Ft int
 335 .Fn isspace "int c"
 336 .Xc
 337 .It Xo
 338 .Ft int
 339 .Fn isdigit "int c"
 340 .Xc
 341 .It Xo
 342 .Ft int
 343 .Fn isxdigit "int c"
 344 .Xc
 345 .It Xo
 346 .Ft int
 347 .Fn isascii "int c"
 348 .Xc
 349 .It Xo
 350 .Ft int
 351 .Fn isalpha "int c"
 352 .Xc
 353 .It Xo
 354 .Ft int
 355 .Fn toupper "int c"
 356 .Xc
 357 .It Xo
 358 .Ft int
 359 .Fn tolower "int c"
 360 .Xc
 361 .El
 362 .Sh FILE I/O
 363 .Bl -hang -width 10n
 364 .It Xo
 365 .Ft int
 366 .Fn open "const char *path" "int flags"
 367 .Xc
 368 .Pp
 369 Similar to the behaviour as specified in
 370 .Xr open 2 ,
 371 except that file creation is not supported, so the mode parameter is not
 372 required.
 373 The
 374 .Fa flags
 375 argument may be one of
 376 .Dv O_RDONLY ,
 377 .Dv O_WRONLY
 378 and
 379 .Dv O_RDWR
 380 (although no filesystems currently support writing).
 381 .It Xo
 382 .Ft int
 383 .Fn close "int fd"
 384 .Xc
 385 .It Xo
 386 .Ft void
 387 .Fn closeall void
 388 .Xc
 389 .Pp
 390 Close all open files.
 391 .It Xo
 392 .Ft ssize_t
 393 .Fn read "int fd" "void *buf" "size_t len"
 394 .Xc
 395 .It Xo
 396 .Ft ssize_t
 397 .Fn write "int fd" "void *buf" "size_t len"
 398 .Xc
 399 .Pp
 400 (No filesystems currently support writing.)
 401 .It Xo
 402 .Ft off_t
 403 .Fn lseek "int fd" "off_t offset" "int whence"
 404 .Xc
 405 .Pp
 406 Files being automatically uncompressed during reading cannot seek backwards
 407 from the current point.
 408 .It Xo
 409 .Ft int
 410 .Fn stat "const char *path" "struct stat *sb"
 411 .Xc
 412 .It Xo
 413 .Ft int
 414 .Fn fstat "int fd" "struct stat *sb"
 415 .Xc
 416 .Pp
 417 The
 418 .Fn stat
 419 and
 420 .Fn fstat
 421 functions only fill out the following fields in the
 422 .Fa sb
 423 structure:
 424 .Fa st_mode , st_nlink , st_uid , st_gid , st_size .
 425 The
 426 .Nm tftp
 427 filesystem cannot provide meaningful values for this call, and the
 428 .Nm cd9660
 429 filesystem always reports files having uid/gid of zero.
 430 .El
 431 .Sh PAGER
 432 .Nm
 433 supplies a simple internal pager to ease reading the output of large commands.
 434 .Bl -hang -width 10n
 435 .It Xo
 436 .Ft void
 437 .Fn pager_open
 438 .Xc
 439 .Pp
 440 Initialises the pager and tells it that the next line output will be the
 441 top of the display.
 442 The environment variable LINES is consulted to determine the number of
 443 lines to be displayed before pausing.
 444 .It Xo
 445 .Ft void
 446 .Fn pager_close void
 447 .Xc
 448 .Pp
 449 Closes the pager.
 450 .It Xo
 451 .Ft int
 452 .Fn pager_output "char *lines"
 453 .Xc
 454 .Pp
 455 Sends the lines in the nul-terminated buffer at
 456 .Fa lines
 457 to the pager.
 458 Newline characters are counted in order to determine the number
 459 of lines being output (wrapped lines are not accounted for).
 460 .Fn pager_output
 461 will return zero when all of the lines have been output, or nonzero if the
 462 display was paused and the user elected to quit.
 463 .It Xo
 464 .Ft int
 465 .Fn pager_file "char *fname"
 466 .Xc
 467 .Pp
 468 Attempts to open and display the file
 469 .Fa fname .
 470 Returns -1 on error, 0 at
 471 .Dv EOF ,
 472 or 1 if the user elects to quit while reading.
 473 .El
 474 .Sh NETWORK
 475 .Bl -hang -width 10n
 476 .It Xo
 477 .Ft "char *"
 478 .Fn ether_sprintf "u_char *ap"
 479 .Xc
 480 .Pp
 481 Convert an ethernet address to its human readable notation as specified in IEEE 802.
 482 .El
 483 .Sh MISC
 484 .Bl -hang -width 10n
 485 .It Xo
 486 .Ft void
 487 .Fn twiddle void
 488 .Xc
 489 .Pp
 490 Successive calls emit the characters in the sequence |, /, -, \\ followed by a
 491 backspace in order to provide reassurance to the user.
 492 .El
 493 .Sh REQUIRED LOW-LEVEL SUPPORT
 494 The following resources are consumed by
 495 .Nm
 496 - stack, heap, console and devices.
 497 .Pp
 498 The stack must be established before
 499 .Nm
 500 functions can be invoked.
 501 Stack requirements vary depending on the functions
 502 and filesystems used by the consumer and the support layer functions detailed
 503 below.
 504 .Pp
 505 The heap must be established before calling
 506 .Fn alloc
 507 or
 508 .Fn open
 509 by calling
 510 .Fn setheap .
 511 Heap usage will vary depending on the number of simultaneously open files,
 512 as well as client behaviour.
 513 Automatic decompression will allocate more
 514 than 64K of data per open file.
 515 .Pp
 516 Console access is performed via the
 517 .Fn getchar ,
 518 .Fn putchar
 519 and
 520 .Fn ischar
 521 functions detailed below.
 522 .Pp
 523 Device access is initiated via
 524 .Fn devopen
 525 and is performed through the
 526 .Fn dv_strategy ,
 527 .Fn dv_ioctl
 528 and
 529 .Fn dv_close
 530 functions in the device switch structure that
 531 .Fn devopen
 532 returns.
 533 .Pp
 534 The consumer must provide the following support functions:
 535 .Bl -hang -width 10n
 536 .It Xo
 537 .Ft int
 538 .Fn getchar void
 539 .Xc
 540 .Pp
 541 Return a character from the console, used by
 542 .Fn gets ,
 543 .Fn ngets
 544 and pager functions.
 545 .It Xo
 546 .Ft int
 547 .Fn ischar void
 548 .Xc
 549 .Pp
 550 Returns nonzero if a character is waiting from the console.
 551 .It Xo
 552 .Ft void
 553 .Fn putchar int
 554 .Xc
 555 .Pp
 556 Write a character to the console, used by
 557 .Fn gets ,
 558 .Fn ngets ,
 559 .Fn *printf ,
 560 .Fn panic
 561 and
 562 .Fn twiddle
 563 and thus by many other functions for debugging and informational output.
 564 .It Xo
 565 .Ft int
 566 .Fn devopen "struct open_file *of" "const char *name" "char **file"
 567 .Xc
 568 .Pp
 569 Open the appropriate device for the file named in
 570 .Fa name ,
 571 returning in
 572 .Fa file
 573 a pointer to the remaining body of
 574 .Fa name
 575 which does not refer to the device.
 576 The
 577 .Va f_dev
 578 field in
 579 .Fa of
 580 will be set to point to the
 581 .Vt devsw
 582 structure for the opened device if successful.
 583 Device identifiers must
 584 always precede the path component, but may otherwise be arbitrarily formatted.
 585 Used by
 586 .Fn open
 587 and thus for all device-related I/O.
 588 .It Xo
 589 .Ft int
 590 .Fn devclose "struct open_file *of"
 591 .Xc
 592 .Pp
 593 Close the device allocated for
 594 .Fa of .
 595 The device driver itself will already have been called for the close;
 596 this call should clean up any allocation made by
 597 .Fn devopen
 598 only.
 599 .It Xo
 600 .Ft void
 601 .Fn panic "const char *msg" "..."
 602 .Xc
 603 .Pp
 604 Signal a fatal and unrecoverable error condition.
 605 The
 606 .Fa msg ...
 607 arguments are as for
 608 .Fn printf .
 609 .El
 610 .Sh INTERNAL FILESYSTEMS
 611 Internal filesystems are enabled by the consumer exporting the array
 612 .Vt struct fs_ops *file_system[] ,
 613 which should be initialised with pointers
 614 to
 615 .Vt struct fs_ops
 616 structures.
 617 The following filesystem handlers are supplied by
 618 .Nm ,
 619 the consumer may supply other filesystems of their own:
 620 .Bl -hang -width ".Va cd9660_fsops"
 621 .It Va ufs_fsops
 622 The
 623 .Bx
 624 .Xr UFS 5 .
 625 .It Va hammer_fsops
 626 .Xr HAMMER 5
 627 filesystem.
 628 .It Va ext2fs_fsops
 629 Linux ext2fs filesystem.
 630 .It Va msdos_fsops
 631 MS-DOS filesystem.
 632 .It Va tftp_fsops
 633 File access via TFTP.
 634 .It Va nfs_fsops
 635 File access via NFS.
 636 .It Va cd9660_fsops
 637 ISO 9660 (CD-ROM) filesystem.
 638 .It Va zipfs_fsops
 639 Stacked filesystem supporting gzipped files.
 640 When trying the zipfs filesystem,
 641 .Nm
 642 appends
 643 .Li .gz
 644 to the end of the filename, and then tries to locate the file using the other
 645 filesystems.
 646 Placement of this filesystem in the
 647 .Va file_system[]
 648 array determines whether gzipped files will be opened in preference to non-gzipped
 649 files.
 650 It is only possible to seek a gzipped file forwards, and
 651 .Fn stat
 652 and
 653 .Fn fstat
 654 on gzipped files will report an invalid length.
 655 .It Va bzipfs_fsops
 656 The same as
 657 .Va zipfs_fsops ,
 658 but for
 659 .Xr bzip2 1 Ns -compressed
 660 files.
 661 .El
 662 .Pp
 663 The array of
 664 .Vt struct fs_ops
 665 pointers should be terminated with a NULL.
 666 .Sh DEVICES
 667 Devices are exported by the supporting code via the array
 668 .Vt struct devsw *devsw[]
 669 which is a NULL terminated array of pointers to device switch structures.
 670 .Sh HISTORY
 671 .Nm
 672 contains contributions from many sources, including:
 673 .Bl -bullet -compact
 674 .It
 675 .Nm libsa
 676 from
 677 .Nx
 678 .It
 679 .Nm libc
 680 and
 681 .Nm libkern
 682 from
 683 .Fx 3.0 .
 684 .It
 685 .Nm zalloc
 686 from
 687 .An Matthew Dillon Aq dillon@backplane.com
 688 .El
 689 .Pp
 690 The reorganisation and port to
 691 .Fx 3.0 ,
 692 the environment functions and this manpage were written by
 693 .An Mike Smith Aq msmith@FreeBSD.org .
 694 .Sh BUGS
 695 The lack of detailed memory usage data is unhelpful.