Copyright (c) 2006 The NetBSD Foundation, Inc.
All rights reserved.
This code is derived from software contributed to The NetBSD Foundation
by Julio M. Merino Vidal.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
.Dd May 20, 2023 .Dt OPTSTR 9 .Os .Sh NAME .Nm optstr_get , .Nm optstr_get_string , .Nm optstr_get_number , .Nm optstr_get_number_binary , .Nm optstr_get_number_hex , .Nm optstr_get_macaddr .Nd Options string management .Sh SYNOPSIS n sys/optstr.h .Ft bool .Fn optstr_get "const char *optstr" "const char *key" "char *buf" "size_t bufsize" .Ft bool .Fn optstr_get_string "const char *optstr" "const char *key" "char **result" .Ft bool .Fn optstr_get_number "const char *optstr" "const char *key" "unsigned long *result" .Ft bool .Fn optstr_get_number_binary "const char *optstr" "const char *key" "unsigned long *result" .Ft bool .Fn optstr_get_number_hex "const char *optstr" "const char *key" "unsigned long *result" .Ft bool .Fn optstr_get_macaddr "const char *optstr" "const char *key" "uint8_t result[ETHER_ADDR_LEN]" .Sh DESCRIPTION An options string is a list of key/value pairs represented in textual form. Each pair is expressed as .Sq 'key=value' and is separated from other pairs by one or more spaces. For example: d -literal key1=value1 key2=value2 key3=value3 .Ed
p Options strings are used to pass information between userland programs and the kernel in a binary-agnostic way. This makes them endianness and ABI independent. .Sh FUNCTIONS The following functions are provided to manage options strings: l -tag -width compact t Fn optstr_get "optstr" "key" "buf" "bufsize" Scans the .Va optstr options string looking for the key .Va key and stores its value in the buffer pointed to by .Va buf copying a maximum of .Va bufsize bytes. Returns .Sq true if the key was found or .Sq false otherwise, in which case .Va buf is left unmodified. .El
p The .Fn optstr_get_ITEM family of functions provide the ability to scan for the key, and return the value converted to an appropriate type.
p l -tag -width compact t Fn optstr_get_string "optstr" "key" "result" t Fn optstr_get_number "optstr" "key" "result" t Fn optstr_get_number_binary "optstr" "key" "result" t Fn optstr_get_number_hex "optstr" "key" "result" t Fn optstr_get_macaddr "optstr" "key" "result"
p These functions scan the .Va optstr options string looking for the key .Va key and returns the key value converted as per the function name in .Va result . All functions return .Sq true if the key was found or .Sq false otherwise, in which case .Va result is left unmodified. .El .Sh CODE REFERENCES The options string management functions are implemented within the files
a sys/kern/subr_optstr.c and
a sys/sys/optstr.h . .Sh HISTORY Options strings appeared in .Nx 4.0 .