svcadm(8)을 검색하려면 섹션에서 8 을 선택하고, 맨 페이지 이름에 svcadm을 입력하고 검색을 누른다.
Intro(3)
Intro(3) Library Interfaces and Headers Intro(3)
NAME
Intro, intro - introduction to functions and libraries
DESCRIPTION
This section describes functions found in various Oracle Solaris li‐
braries, other than those functions described in Section 2 of this man‐
ual that directly invoke UNIX system primitives. Pages are grouped by
library and are identified by the library name (or an abbreviation of
the library name) after the section number. Collections of related li‐
braries are grouped into volumes as described below. The first volume
contains pages describing the contents of each shared library and each
header used by the functions, macros, and external variables described
in the remaining volumes.
Function declarations can be obtained from the #include files indicated
on each page. The C compilation system automatically links programs
(but not shared objects) with the standard C library, libc. The C++
compilation system additionally links the appropriate standard C++ li‐
braries. All other libraries must be explicitly linked using -l options
as specified. All libraries provided by the operating system are imple‐
mented as shared objects.
Library Interfaces and Headers
This volume describes the contents of each shared library and each
header used by functions, macros, and external variables described in
the remaining volumes.
(3LIB)
The libraries described in this section are implemented as shared
objects.
Descriptions of shared objects can include a definition of the
global symbols that define the shared objects' public interface,
for example SUNWpublic. Other interfaces can exist within the
shared object, for example SUNWprivate. The public interface pro‐
vides a stable, committed set of symbols for application develop‐
ment. The private interfaces are for internal use only, and could
change at any time.
(3HEAD)
The headers described in this section are used by functions,
macros, and external variables. Headers contain function proto‐
types, definitions of symbolic constants, common structures, pre‐
processor macros, and defined types. Each function described in the
remaining five volumes specifies the headers that an application
must include in order to use that function. In most cases only one
header is required. These headers are present on an application de‐
velopment system; they do have to be present on the target execu‐
tion system.
Basic Library Functions
The functions described in this volume are the core C library functions
that are basic to application development.
(3C)
These functions, together with those of Section 2, constitute the
standard C library, libc, which is automatically linked by the C
compilation system when building a program. Specify -lc on the cc
command line to link with this library when building a shared ob‐
ject. See libc(3LIB) for a discussion. Some functions behave dif‐
ferently in standard-conforming environments. This behavior is
noted on the individual manual pages. See standards(7).
The libpthread and libthread libraries are filter libraries on libc
used to support programs built on older versions of Solaris. See
MULTITHREADED APPLICATIONS, below.
The following libraries are also now filter libraries on libc used
to support programs built on older versions of Solaris, and thus no
longer need to be specified while linking programs:
libaio asynchronous I/O library
libcmd command utility library
libdl dynamic linking library
libdoor doors library
libintl internationalization library
libnsl network services library
librt POSIX.1b Realtime Extensions library
libsched scheduling library
libsecdb security attributes database library
libsendfile sendfile library
libsocket sockets library
libw wide character library
libxnet X/Open Networking library
(3C_DB)
These functions constitute the threads debugging library, libc_db.
Specify -lc_db on the cc command line to link with this library.
See libc_db(3LIB).
(3MALLOC)
These functions constitute the various alternative memory alloca‐
tion libraries. Specify the listed link option on the cc command
line to link with each library. See the ALTERNATIVE IMPLEMENTATIONS
section of malloc(3C) for an overview and comparison of all of
these libraries.
tab(); lw(1.76i) lw(1.76i) lw(1.99i) lw(1.76i) lw(1.76i) lw(1.99i)
LibraryLink optionSee _ libc-lclibc(3LIB) libmalloc-lmalloclibmal‐
loc(3LIB) libadimalloc-ladimalloclibadimalloc(3LIB) libbsdmalloc-
lbsdmalloclibbsdmalloc(3LIB) libmapmalloc-lmapmalloclibmapmal‐
loc(3LIB) libmtmalloc-lmtmalloclibmtmalloc(3LIB) libumem-lumem‐
libumem(3LIB) watchmallocN/Awatchmalloc(3MALLOC)
Note that libadimalloc is only usable on ADI capable processors.
watchmalloc is not normally linked when building software, but may
be used by setting the LD_PRELOAD environment variable when running
a program.
Networking Library Functions
The functions described in this volume comprise the various networking
libraries.
(3COMMPUTIL)
These functions constitute the communication protocol parser utili‐
ties library, libcommputil. Specify -lcommputil on the cc command
line to link with this library. See libcommputil(3LIB).
(3DLPI)
These functions constitute the data link provider interface li‐
brary, libdlpi. Specify -ldlpi on the cc command line to link with
this library. See libdlpi(3LIB).
(3GSS)
These functions constitute the generic security services library.
Specify -lgss on the cc command line to link with this library. See
libgss(3LIB).
(3NSL)
Functions previously documented in the network service library
(3NSL), have been moved to the standard C library. They are now
documented in the 3C section. The libnsl library is implemented as
a filter on libc(3LIB) to support objects built on older versions
of Solaris. There is no need for a new application to link with
this library.
(3RESOLV)
These functions constitute the Domain Name System (DNS) resolver
library, libresolv. Specify -lresolv on the cc command line to link
with this library. See libresolv(3LIB).
(3RPC)
These functions constitute the remote procedure call libraries, li‐
brpcsvc and librpcsoc. The latter is provided for compatibility
only; new applications should not link to it. Specify -lrpcsvc or
-lrpcsoc on the cc command line to link with these libraries. See
librpcsvc(3LIB).
(3SIP)
These functions constitute the Session Initiation Protocol library,
libsip. Specify -lsip on the cc command line to link with this li‐
brary. See libsip(3LIB).
(3SOCKET)
Functions previously documented in the socket library (3SOCKET),
have been moved to the standard C library. They are now documented
in the 3C section. The libsocket library is implemented as a filter
on libc(3LIB) to support objects built on older versions of So‐
laris. There is no need for a new application to link with this li‐
brary.
(3XNET)
Functions previously documented in the X/Open networking library
(3XNET), have been moved to the standard C library. They are now
documented in the 3C section. The libxnet library is implemented as
a filter on libc(3LIB) to support objects built on older versions
of Solaris. There is no need for a new application to link with
this library.
Curses Library Functions
The functions described in this volume comprise the libraries that pro‐
vide graphics and character screen updating capabilities.
(3CURSES)
The functions constitute the following libraries:
libcurses
These functions constitute the curses library, libcurses. Spec‐
ify -lcurses on the cc command line to link with this library.
See libcurses(3LIB).
libform
These functions constitute the forms library, libform. Specify
-lform on the cc command line to link with this library. See
libform(3LIB).
libmenu
These functions constitute the menus library, libmenu. Specify
-lmenu on the cc command line to link with this library. See
libmenu(3LIB).
libpanel
These functions constitute the panels library, libpanel. Spec‐
ify -lpanel on the cc command line to link with this library.
See libpanel(3LIB).
(3XCURSES)
These functions constitute the X/Open curses library, located in
/usr/xpg4/lib/libcurses.so. This library provides a set of interna‐
tionalized functions and macros for creating and modifying input
and output to a terminal screen. Included in this library are func‐
tions for creating windows, highlighting text, writing to the
screen, reading from user input, and moving the cursor. X/Open
Curses is designed to optimize screen update activities. The X/Open
Curses library conforms fully with Issue 4 of the X/Open Extended
Curses specification. See libcurses(3XCURSES).
DAX Library Functions
The functions described in this volume comprise the following special‐
ized libraries:
(3DAX)
These functions constitute the DAX (Data Analytics Accelerator) li‐
brary, libdax. Specify -ldax on the cc command line to link with
this library. See libdax(3LIB).
Extended Library Functions, Vol. 1
The functions described in this volume comprise the following special‐
ized libraries:
(3CFGADM)
These functions constitute the configuration administration li‐
brary, libcfgadm. Specify -lcfgadm on the cc command line to link
with this library. See libcfgadm(3LIB).
(3CONTRACT)
These functions constitute the contract management library, libcon‐
tract. Specify -lcontract on the cc command line to link with this
library. See libcontract(3LIB).
(3CPC)
These functions constitute the CPU performance counter library,
libcpc, and the process context library, libpctx. Specify -lcpc or
-lpctx on the cc command line to link with these libraries. See
libcpc(3LIB) and libpctx(3LIB).
(3DEVID)
These functions constitute the device ID library, libdevid. Specify
-ldevid on the cc command line to link with this library. See lib‐
devid(3LIB).
(3DEVINFO)
These functions constitute the device information library, libdev‐
info. Specify -ldevinfo on the cc command line to link with this
library. See libdevinfo(3LIB).
(3ELF)
These functions constitute the Extensible Linking Format (ELF) ac‐
cess library, libelf. This library provides the interface for the
creation and analyses of "elf" files; executables, objects, and
shared objects. Specify -lelf on the cc command line to link with
this library. See libelf(3LIB).
(3EXACCT)
These functions constitute the extended accounting access library,
libexacct, and the project database access library, libproject.
Specify -lexacct or -lproject on the cc command line to link with
these libraries. See libexacct(3LIB) and libproject(3LIB).
(3FCOE)
These functions constitute the Fibre Channel over Ethernet port
management library, libfcoe. Specify -lfcoe on the cc command line
to link with this library. See libfcoe(3LIB).
(3FM)
These functions constitute the fault management events library,
libfmevent. Specify -lfmevent on the cc command line to link with
this library. See libfmevent(3LIB).
(3FSTYP)
These functions constitute the file system type identification li‐
brary, libfstyp. Specify -lfstyp on the cc command line to link
with this library. See libfstyp(3LIB).
Extended Library Functions, Vol. 2
The functions described in this volume comprise the following special‐
ized libraries:
(3DTRACE)
These functions constitute the DTrace dynamic tracing software li‐
brary, libdtrace. Specify -ldtrace on the cc command line to link
with this library. See libdtrace(3LIB).
(3GEN)
These functions constitute the string pattern-matching and pathname
manipulation library, libgen. Specify -lgen on the cc command line
to link with this library. See libgen(3LIB).
(3HBAAPI)
These functions constitute the common Fibre Channel HBA information
library, libhbaapi. Specify -lhbaapi on the cc command line to link
with this library. See libhbaapi(3LIB).
(3IMA)
These functions constitute the iSCSI Management library, libima.
Specify -lma on the cc command line to link with this library. See
libima(3LIB).
(3ISCSIT)
These functions constitute the iSCSI Management library for COMSTAR
iSCSI target ports, libiscsit. Specify -liscsit on the cc command
line to link with this library. See libiscsit(3LIB).
(3KSTAT)
These functions constitute the version 1 kernel statistics library,
libkstat. Specify -lkstat on the cc command line to link with this
library. This library has been deprecated in favor of libkstat2 and
should not be used in newly written code. See libkstat(3LIB).
(3KSTAT2)
These functions constitute the version 2 kernel statistics library,
libkstat2. Specify -lkstat2 on the cc command line to link with
this library. See libkstat2(3LIB).
(3KVM)
The functions in the libkvm library access the kernel's virtual
memory. Specify -lkvm on the cc command line to link with this li‐
brary. See libkvm(3LIB).
(3LAYOUT)
These functions constitute the layout service library, liblayout.
Specify -llayout on the cc command line to link with this library.
See liblayout(3LIB).
(3LGRP)
These functions constitute the locality group library, liblgrp.
Specify -llgrp on the cc command line to link with this library.
See liblgrp(3LIB).
(3M)
These functions constitute the mathematical library, libm. Specify
-lm on the cc command line to link with this library. See
libm(3LIB).
(3MAIL)
These functions constitute the user mailbox management library,
libmail. Specify -lmail on the cc command line to link with this
library. See libmail(3LIB).
(3MP)
These functions constitute the multiple precision integer mathemat‐
ics library, libmp. Specify -lmp on the cc command line to link
with this library. See libmp(3LIB).
(3MPAPI)
These functions constitute the Common Multipath Management library,
libMPAPI. Specify -lMPAPI on the cc command line to link with this
library. See libMPAPI(3LIB).
(3MVEC)
These functions constitute the vector mathematics library, libmvec.
Specify -lmvec on the cc command line to link with this library.
See libmvec(3LIB).
(3SANDBOX)
These functions constitute the sandbox library, libsandbox. Specify
-lsandbox on the cc command line to link with this library. See
libsandbox(3LIB).
Extended Library Functions, Vol. 3
The functions described in this volume comprise the following special‐
ized libraries:
(3NVPAIR)
These functions constitute the name-value pair library, libnvpair.
Specify -lnvpair on the cc command line to link with this library.
See libnvpair(3LIB).
(3PAM)
These functions constitute the Pluggable Authentication Module li‐
brary, libpam. Specify -lpam on the cc command line to link with
this library. See libpam(3LIB).
(3PICL)
These functions constitute the PICL library, libpicl. Specify
-lpicl on the cc command line to link with this library. See
libpicl(3LIB) and libpicl(3PICL).
(3PICLTREE)
These functions constitute the PICL plug-in library, libpicltree.
Specify -lpicltree on the cc command line to link with this li‐
brary. See libpicltree(3LIB) and libpicltree(3PICLTREE).
(3POOL)
These functions constitute the pool configuration manipulation li‐
brary, libpool. Specify -lpool on the cc command line to link with
this library. See libpool(3LIB).
(3PROC)
These functions constitute the Process Control library, libproc.
Specify -lproc on the cc command line to link with this library.
See libproc(3LIB).
(3PROJECT)
These functions constitute the project database access library,
libproject. Specify -lproject on the cc command line to link with
this library. See libproject(3LIB).
(3REPARSE)
These functions constitute the reparse point library, libreparse.
Specify -lreparse on the cc command line to link with this library.
See libreparse(3LIB).
Extended Library Functions, Vol. 4
The functions described in this volume comprise the following special‐
ized libraries:
(3SCF)
These functions constitute the service configuration facility li‐
brary, libscf. Specify -lscf on the cc command line to link with
this library. See libscf(3LIB).
(3SEC)
These functions constitute the file access control library, libsec.
Specify -lsec on the cc command line to link with this library. See
libsec(3LIB).
(3SRPT)
These functions constitute the SRP Target Management library, lib‐
srpt. Specify -lsrpt on the cc command line to link with this li‐
brary. See libsrpt(3LIB).
(3SSTORE)
These functions constitute the Statistics Store library, libsstore.
Specify -lsstore on the cc command line to link with this library.
See libsstore(3LIB).
(3STMF)
These functions constitute the SCSI Target Mode Framework library,
libstmf. Specify -lstmf on the cc command line to link with this
library. See libstmf(3LIB).
(3SUNMATH)
These functions constitute the Sun legacy mathematical library,
libsunmath. Specify -lsunmath on the cc command line to link with
this library. For more information, see the libsunmath(3LIB) man
page.
(3SYSEVENT)
These functions constitute the system event library, libsysevent.
Specify -lsysevent on the cc command line to link with this li‐
brary. See libsysevent(3LIB).
(3SYSOBJ)
These functions constitute the system object database library, lib‐
sysobj. Specify -lsysobj on the cc command line to link with this
library. See libsysobj(3LIB).
(3TECLA)
These functions constitute the interactive command-line input li‐
brary, libtecla. Specify -ltecla on the cc command line to link
with this library. See libtecla(3LIB).
(3TSOL)
These functions constitute the Trusted Extensions library, libtsol,
and the Trusted Extensions network library, libtsnet. Specify -lt‐
sol or -ltsnet on the cc command line to link with these libraries.
See libtsol(3LIB) and libtsnet(3LIB).
(3UUID)
These functions constitute the universally unique identifier li‐
brary, libuuid. Specify -luuid on the cc command line to link with
this library. See libuuid(3LIB).
(3VOLMGT)
These functions constitute the volume management library, lib‐
volmgt. Specify -lvolmgt on the cc command line to link with this
library. See libvolmgt(3LIB).
(3ZONESTAT)
These functions constitute the zones statistics library, libzones‐
tat. Specify -lzonestat on the cc command line to link with this
library. See libzonestat(3LIB).
DEFINITIONS
A character is any bit pattern able to fit into a byte on the machine.
In some international languages, however, a "character" might require
more than one byte, and is represented as a multibyte character.
The null character is a character with value 0, conventionally repre‐
sented in the C language as \0. A character array is a sequence of
characters. A null-terminated character array (a string) is a sequence
of characters, the last of which is the null character. The null string
is a character array containing only the terminating null character. A
null pointer is the value that is obtained by casting 0 into a pointer.
C guarantees that this value will not match that of any legitimate
pointer, so many functions that return pointers return NULL to indicate
an error. The macro NULL is defined in <stddef.h>. Types of the form
size_t are defined in the appropriate headers.
See the Definitions section of Intro(2) for additional definitions used
in this section.
MULTITHREADED APPLICATIONS
Both POSIX threads and Solaris threads can be used within the same ap‐
plication. Their implementations are completely compatible with each
other; however, only POSIX threads guarantee portability to other
POSIX-conforming environments. See threads(7).
The libpthread(3LIB) and libthread(3LIB) libraries are implemented as
filters on libc(3LIB) to support objects built on older versions of So‐
laris. There is no need for a multithreaded application to link with
these libraries.
In the default compilation environment, when neither _POSIX_C_SOURCE
nor _XOPEN_SOURCE is defined, all functions as specified by the latest
POSIX standard are visible to code being compiled, along with all other
functions and names provided by Solaris. For Oracle Solaris 11.4, this
corresponds to The Open Group, Single UNIX Specification, Version 4,
December 2010 (IEEE Std 1003.1-2008, aka XPG7, UNIX V7). The default
compilation environment is equivalent to:
cc -D_POSIX_C_SOURCE=200809L -D__EXTENSIONS__ ...
or
cc -D_XOPEN_SOURCE=700 -D__EXTENSIONS__ ...
Prior to Oracle Solaris 11.4, the default compilation environment made
the Draft-6 POSIX.1c-1995 (POSIX Threads) versions of several inter‐
faces visible to code being compiled, rather than the final
POSIX.1c-1995 versions. To allow applications that were written to use
the obsolete Draft-6 interfaces to continue to be compiled and run, the
__USE_DRAFT6_PROTOTYPES__ macro must be defined:
cc -D__USE_DRAFT6_PROTOTYPES__ ...
Support for the Draft-6 interfaces is provided for source compatibility
only and might not be supported in future releases. Old applications
should be converted to use the standard definitions.
Unsafe interfaces should be called only from the main thread to ensure
the application's safety.
MT-Safe interfaces are denoted in the ATTRIBUTES section of the func‐
tions and libraries manual pages (see attributes(7)). If a manual page
does not state explicitly that an interface is MT-Safe, the user should
assume that the interface is unsafe.
REALTIME APPLICATIONS
The environment variable LD_BIND_NOW must be set to a non-null value to
enable early binding. See When Relocations Are Performed in Oracle So‐
laris 11.4 Linkers and Libraries Guide for additional information.
FILES
INCDIR usually /usr/include
LIBDIR usually either /lib or /usr/lib (32-bit) or either
/lib/64 or /usr/lib/64 (64-bit)
LIBDIR/*.so shared libraries
ACKNOWLEDGMENTS
Oracle gratefully acknowledges The Open Group for permission to repro‐
duce portions of its copyrighted documentation. Original documentation
from The Open Group can be obtained online at https://www.open‐
group.org/
The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their documenta‐
tion.
In the following statement, the phrase "this text" refers to portions
of the system documentation.
Portions of this text are reprinted and reproduced in electronic form
in the Oracle Solaris 11 Reference Manual, from IEEE Std 1003.1, 2004
Edition, Standard for Information Technology -- Portable Operating Sys‐
tem Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy be‐
tween these versions and the original IEEE and The Open Group Standard,
the original IEEE and The Open Group Standard is the referee document.
This notice shall appear on any product containing this material.
SEE ALSO
ar(1), ld(1), ld.so.1(1), Intro(2), fork(2), stdio(3C), std‐
def.h(3HEAD), attributes(7), standards(7), threads(7)
Oracle Solaris 11.4 Linkers and Libraries Guide
Appendix E, Security Considerations When Using C Functions, in Devel‐
oper's Guide to Oracle Solaris 11.4 Security
DIAGNOSTICS
For functions that return floating-point values, error handling varies
according to compilation mode. Under the -Xt (default) option to cc,
these functions return the conventional values 0, ±HUGE, or NaN when
the function is undefined for the given arguments or when the value is
not representable. In the -Xa and -Xc compilation modes, ±HUGE_VAL is
returned instead of ±HUGE. (HUGE_VAL and HUGE are defined in <math.h>
to be infinity and the largest-magnitude single-precision number, re‐
spectively.)
NOTES
None of the functions, external variables, or macros should be rede‐
fined in the user's programs. Any other name can be redefined without
affecting the behavior of other library functions, but such redefini‐
tion might conflict with a declaration in an included header.
The headers in INCDIR provide function prototypes (function declara‐
tions including the types of arguments) for most of the functions
listed in this manual. Function prototypes allow the compiler to check
for correct usage of these functions in the user's program. The lint
program checker can also be used and will report discrepancies even if
the headers are not included with #include statements. Definitions for
Sections 2 and 3C are checked automatically. Other definitions can be
included by using the -l option to lint. (For example, -lm includes de‐
finitions for libm.) Use of lint is highly recommended.
Users should carefully note the difference between STREAMS and a
stream. STREAMS is a set of kernel mechanisms that support the develop‐
ment of network services and data communication drivers. It is composed
of utility routines, kernel facilities, and a set of data structures. A
stream is a file with its associated buffering. It is declared to be a
pointer to a type FILE defined in <stdio.h>.
In detailed definitions of components, it is sometimes necessary to re‐
fer to symbolic names that are implementation-specific, but which are
not necessarily expected to be accessible to an application program.
Many of these symbolic names describe boundary conditions and system
limits.
In this section, for readability, these implementation-specific values
are given symbolic names. These names always appear enclosed in curly
brackets to distinguish them from symbolic names of other implementa‐
tion-specific constants that are accessible to application programs by
headers. These names are not necessarily accessible to an application
program through a header, although they can be defined in the documen‐
tation for a particular system.
In general, a portable application program should not refer to these
symbolic names in its code. For example, an application program would
not be expected to test the length of an argument list given to a rou‐
tine to determine if it was greater than {ARG_MAX}.
Oracle Solaris 11.4 27 Aug 2025 Intro(3)