| Skip Navigation Links | |
| Exit Print View | |
 | man pages section 3: Library Interfaces and Headers Oracle Solaris 11 Information Library |
| Skip Navigation Links | |
| Exit Print View | |
| man pages section 3: Library Interfaces and Headers Oracle Solaris 11 Information Library |
- introduction to functions and libraries
This section describes functions found in various Solaris libraries, other than thosefunctions described in Section 2 of this manual that directly invoke UNIXsystem primitives. Function declarations can be obtained from the#include files indicatedon each page. Pages are grouped by library and are identified by thelibrary name (or an abbreviation of the library name) after the sectionnumber. Collections of related libraries are grouped into volumes as described below.The first volume contains pages describing the contents of each shared libraryand each header used by the functions, macros, and external variables described inthe remaining volumes.
This volume describes the contents of each shared library and each headerused by functions, macros, and external variables described in the remaining volumes.
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 exampleSUNW_1.1. Other interfaces can exist within the shared object, for exampleSUNWprivate.1.1. The public interface provides a stable, committed set of symbols for application development. The private interfaces are for internal use only, and could change at any time.
The headers described in this section are used by functions, macros, and external variables. Headers contain function prototypes, definitions of symbolic constants, common structures, preprocessor 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 development system; they do have to be present on the target execution system.
The functions described in this volume are the core C library functionsthat are basic to application development.
These functions, together with those of Section 2, constitute the standard C library,libc, which is automatically linked by the C compilation system. The standard C library is implemented as a shared object,libc.so. Seelibc(3LIB) and the “C Compilation System“ chapter of theANSI C Programmer's Guide for a discussion. Some functions behave differently in standard-conforming environments. This behavior is noted on the individual manual pages. Seestandards(5).
Thelibpthread andlibthread libraries are filter libraries onlibc that are used for building multithreaded applications:libpthread implements the POSIX (seestandards(5)) threads interface, whereaslibthread implements the Solaris threads interface. SeeMULTITHREADED APPLICATIONS, below.
These functions constitute the threads debugging library,libc_db. This library is implemented as a shared object,libc_db.so, but is not automatically linked by the C compilation system. Specify-lc_db on thecc command line to link with this library. Seelibc_db(3LIB).
These functions constitute the various memory allocation libraries:libmalloc,libbsdmalloc,libmapmalloc,libmtmalloc, andlibumem. Each of these libraries is implemented as a shared object (libmalloc.so,libbsdmalloc.so,libmapmalloc.so,libmtmalloc.so, andlibumem.so). These libraries are not automatically linked by the C compilation system. Specify-lmalloc,-lbsdmalloc,-lmapmalloc,-lmtmalloc, and-lumem to link with, respectively,libmalloc,libbsdmalloc,libmapmalloc,libmtmalloc, andlibumem. Seelibmalloc(3LIB),libbsdmalloc(3LIB),libmapmalloc(3LIB),libmtmalloc(3LIB), andlibumem(3LIB).
The functions described in this volume comprise the various networking libraries.
These functions constitute the communication protocol parser utilities library,libcommputil. This library is implemented as a shared object,libcommputil.so, but it is not automatically linked by the C compilation system. Specify-lcommputil on thecc command line to link with this library. Seelibcommputil(3LIB).
These functions constitute the data link provider interface library,libdlpi. This library is implemented as a shared object,libdlpi.so, but it is not automatically linked by the C compilation system. Specify-ldlpi on thecc command line to link with this library. Seelibdlpi(3LIB).
These functions constitute the DNS service discovery library,libdns_sd. This library is implemented as a shared object,libdns_sd.so, but it is not automatically linked by the C compilation system. Specify-ldns_sd on thecc command line to link with this library. Seelibdns_sd(3LIB).
These functions constitute the generic security services library. This library is implemented as a shared object,libgss.so, but it is not automatically linked by the C compilation system. Specify-lgss on thecc command line to link with this library. Seelibgss(3LIB).
These functions constitute the lightweight directory access protocol library,libldap. This library is implemented as a shared object,libldap.so, but is not automatically linked by the C compilation system. Specify-lldap on thecc command line to link with this library. Seeldap(3LDAP).
These functions constitute the network service library,libnsl. This library is implemented as a shared object,libnsl.so, but is not automatically linked by the C compilation system. Specify-lnsl on thecc command line to link with this library. Seelibnsl(3LIB).
Many base networking functions are also available in the X/Open networking interfaces library,libxnet. See section (3XNET) below for more information on thelibxnet interfaces.
These functions constitute the resolver library,libresolv. This library is implemented as a shared object,libresolv.so, but is not automatically linked by the C compilation system. Specify-lresolv on thecc command line to link with this library. Seelibresolv(3LIB).
These functions constitute the remote procedure call libraries,librpcsvc andlibrpcsoc. The latter is provided for compatibility only; new applications should not link to it. Both libraries are implemented as shared objects,librpcsvc.so andlibrpcsoc.so, respectively. Neither library is automatically linked by the C compilation system. Specify-lrpcsvc or-lrpcsoc on thecc command line to link with these libraries. Seelibrpcsvc(3LIB).
These functions constitute the simple authentication and security layer library,libsasl. This library is implemented as a shared object,libsasl.so, but it is not automatically linked by the C compilation system. Specify-lsasl on thecc command line to link with this library. Seelibsasl(3LIB).
These functions constitute the session initiation protocol library,libsip. This library is implemented as a shared object,libsip.so, but it is not automatically linked by the C compilation system. Specify-lsip on thecc command line to link with this library. Seelibsip(3LIB).
These functions constitute the service location protocol library,libslp. This library is implemented as a shared object,libslp.so, but it is not automatically linked by the C compilation system. Specify-lslp on thecc command line to link with this library. Seelibslp(3LIB).
These functions constitute the sockets library,libsocket. This library is implemented as a shared object,libsocket.so, but is not automatically linked by the C compilation system. Specify-lsocket on thecc command line to link with this library. Seelibsocket(3LIB).
These functions constitute X/Open networking interfaces which comply with the X/Open CAE Specification, Networking Services, Issue 4 (September, 1994). This library is implemented as a shared object,libxnet.so, but is not automatically linked by the C compilation system. Specify-lxnet on thecc command line to link with this library. Seelibxnet(3LIB) andstandards(5) for compilation information.
Under all circumstances, the use of the Sockets API is recommended overthe XTI and TLI APIs. If portability to other XPGV4v2 (seestandards(5))systems is a requirement, the application must use thelibxnet interfaces. If portabilityis not required, the sockets interfaces inlibsocket andlibnsl are recommendedover those inlibxnet. Between the XTI and TLI APIs, the XTIinterfaces (available withlibxnet) are recommended over the TLI interfaces (available withlibnsl).
The functions described in this volume comprise the libraries that provide graphicsand character screen updating capabilities.
The functions constitute the following libraries:
These functions constitute the curses library,libcurses. This library is implemented as a shared object,libcurses.so, but is not automatically linked by the C compilation system. Specify-lcurses on thecc command line to link with this library. Seelibcurses(3LIB).
These functions constitute the forms library,libform. This library is implemented as a shared object,libform.so, but is not automatically linked by the C compilation system. Specify-lform on thecc command line to link with this library. Seelibform(3LIB).
These functions constitute the menus library,libmenu. This library is implemented as a shared object,libmenu.so, but is not automatically linked by the C compilation system. Specify-lmenu on thecc command line to link with this library. Seelibmenu(3LIB).
These functions constitute the panels library,libpanel. This library is implemented as a shared object,libpanel.so, but is not automatically linked by the C compilation system. Specify-lpanel on thecc command line to link with this library. Seelibpanel(3LIB).
These functions constitute the grapnics library,libplot. This library is implemented as a shared object,libplot.so, but is not automatically linked by the C compilation system. Specify-lplot on thecc command line to link with this library. Seelibplot(3LIB).
These functions constitute the X/Open curses library, located in/usr/xpg4/lib/libcurses.so. This library provides a set of internationalized functions and macros for creating and modifying input and output to a terminal screen. Included in this library are functions 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. Seelibcurses(3XCURSES).
The functions described in this volume comprise the following specialized libraries:
These functions constitute the configuration administration library,libcfgadm. This library is implemented as a shared object,libcfgadm.so, but is not automatically linked by the C compilation system. Specify-lcfgadm on thecc command line to link with this library. Seelibcfgadm(3LIB).
These functions constitute the contract management library,libcontract. This library is implemented as a shared object,libcontract.so, but is not automatically linked by the C compilation system. Specify-lcontract on thecc command line to link with this library. Seelibcontract(3LIB).
These functions constitute the CPU performance counter library,libcpc, and the process context library,libpctx. These libraries are implemented as shared objects,libcpc.so andlibpctx.so, respectively, but are not automatically linked by the C compilation system. Specify-lcpc or-lpctx on thecc command line to link with these libraries. Seelibcpc(3LIB) andlibpctx(3LIB).
These functions constitute the direct access transport library,libdat. This library is implemented as a shared object,libdat.so, but is not automatically linked by the C compilation system. Specify-ldat on thecc command line to link with this library. Seelibdat(3LIB).
These functions constitute the device ID library,libdevid. This library is implemented as a shared object,libdevid.so, but is not automatically linked by the C compilation system. Specify-ldevid on thecc command line to link with this library. Seelibdevid(3LIB).
These functions constitute the device information library,libdevinfo. This library is implemented as a shared object,libdevinfo.so, but is not automatically linked by the C compilation system. Specify-ldevinfo on thecc command line to link with this library. Seelibdevinfo(3LIB).
These functions constitute the ELF access library,libelf, (Extensible Linking Format). This library provides the interface for the creation and analyses of “elf” files; executables, objects, and shared objects.libelf is implemented as a shared object,libelf.so, but is not automatically linked by the C compilation system. Specify-lelf on thecc command line to link with this library. Seelibelf(3LIB).
These functions constitute the extended accounting access library,libexacct, and the project database access library,libproject. These libraries are implemented as shared objects,libexacct.so andlibproject.so, respectively, but are not automatically linked by the C compilation system. Specify-lexacct or-lproject on thecc command line to link with these libraries. Seelibexacct(3LIB) andlibproject(3LIB).
These functions constitute the Fibre Channel over Ethernet port management library. This library is implemented as a shared object,libfcoe.so, but is not automatically linked by the C compilation system. Specify-lfcoe on thecc command line to link with this library. Seelibfcoe(3LIB).
These functions constitute the fault management events library. This library is implemented as a shared object,libfmevent.so, but is not automatically linked by the C compilation system. Specify-lfmevent on thecc command line to link with this library. Seelibfmevent(3LIB).
These functions constitute the file system type identification library. This library is implemented as a shared object,libfstyp.so, but is not automatically linked by the C compilation system. Specify-lfstyp on thecc command line to link with this library. Seelibfstyp(3LIB).
The functions described in this volume comprise the following specialized libraries:
These functions constitute the string pattern-matching and pathname manipulation library,libgen. This library is implemented as a shared object,libgen.so, but is not automatically linked by the C compilation system. Specify-lgen on thecc command line to link with this library. Seelibgen(3LIB).
These functions constitute the common fibre channel HBA information library,libhbaapi. This library is implemented as a shared object,libhbaapi.so, but is not automatically linked by the C compilation system. Specify-lhbaapi on thecc command line to link with this library. Seelibhbaapi(3LIB).
These functions constitute the iSCSI Management library,libiscsit. This library is implemented as a shared object,libiscsit.so, but is not automatically linked by the C compilation system. Specify-liscsit on thecc command line to link with this library. Seelibiscsit(3LIB).
These functions constitute the kernel statistics library, which is implemented as a shared object,libkstat.so, but is not automatically linked by the C compilation system. Specify-lkstat on thecc command line to link with this library. Seelibkstat(3LIB).
These functions allow access to the kernel's virtual memory library, which is implemented as a shared object,libkvm.so, but is not automatically linked by the C compilation system. Specify-lkvm on thecc command line to link with this library. Seelibkvm(3LIB).
These functions constitute the layout service library, which is implemented as a shared object,liblayout.so, but is not automatically linked by the C compilation system. Specify-llayout on thecc command line to link with this library. Seeliblayout(3LIB).
These functions constitute the locality group library, which is implemented as a shared object,liblgrp.so, but is not automatically linked by the C compilation system. Specify-llgrp on thecc command line to link with this library. Seeliblgrp(3LIB).
These functions constitute the mathematical library,libm. This library is implemented as a shared object,libm.so, but is not automatically linked by the C compilation system. Specify-lm on thecc command line to link with this library. Seelibm(3LIB).
These functions constitute the user mailbox management library,libmail. This library is implemented as a shared object,libmail.so, but is not automatically linked by the C compilation system. Specify-lmail on thecc command line to link with this library. Seelibmail(3LIB).
These functions constitute the integer mathematical library,libmp. This library is implemented as a shared object,libmp.so, but is not automatically linked by the C compilation system. Specify-lmp on thecc command line to link with this library. Seelibmp(3LIB).
These functions constitute the Common Mulitipath Management library,libMPAPI. This library is implemented as a shared object,libMPAPI.so, but is not automatically linked by the C compilation system. Specify-lMPAPI on thecc command line to link with this library. SeelibMPAPI(3LIB).
These functions constitute the vector mathematical library,libmvec. This library is implemented as a shared object,libmvec.so, but is not automatically linked by the C compilation system. Specify-lmvec on thecc command line to link with this library. Seelibmvec(3LIB).
The functions described in this volume comprise the following specialized libraries:
These functions constitute the name–value pair library,libnvpair. This library is implemented as a shared object,libnvpair.so, but is not automatically linked by the C compilation system. Specify-lnvpair on thecc command line to link with this library. Seelibnvpair(3LIB).
These functions constitute the pluggable uuthentication module library,libpam. This library is implemented as a shared object,libpam.so, but is not automatically linked by the C compilation system. Specify-lpam on thecc command line to link with this library. Seelibpam(3LIB).
These functions constitute the Free Standards Group Open Printing API (PAPI) library,libpapi. This library is implemented as a shared object,libpapi.so, but is not automatically linked by the C compilation system. Specify-lpapi on thecc command line to link with this library. Seelibpapi(3LIB).
These functions constitute the PICL library,libpicl. This library is implemented as a shared object,libpicl.so, but is not automatically linked by the C compilation system. Specify-lpicl on thecc command line to link with this library. Seelibpicl(3LIB) andlibpicl(3PICL).
These functions constitute the PICL plug-in library,libpicltree. This library is implemented as a shared object,libpicltree.so, but is not automatically linked by the C compilation system. Specify-lpicltree on thecc command line to link with this library. Seelibpicltree(3LIB) andlibpicltree(3PICLTREE).
These functions constitute the pool configuration manipulation library,libpool. This library is implemented as a shared object,libpool.so, but is not automatically linked by the C compilation system. Specify-lpool on thecc command line to link with this library. Seelibpool(3LIB).
These functions constitute the project database access library,libproject. This library is implemented as a shared object,libproject.so, but is not automatically linked by the C compilation system. Specify-lproject on thecc command line to link with this library. Seelibproject(3LIB).
These functions constitute the reparse point library,libreparse. This library is implemented as a shared object,libreparse.so, but is not automatically linked by the C compilation system. Specify-lreparse on thecc command line to link with this library. Seelibreparse(3LIB).
The functions described in this volume comprise the following specialized libraries:
These functions constitute the object-caching memory allocation library,libscf. This library is implemented as a shared object,libscf.so, but is not automatically linked by the C compilation system. Specify-lscf on thecc command line to link with this library. Seelibscf(3LIB).
These functions constitute the file access control library,libsec. This library is implemented as a shared object,libsec.so, but is not automatically linked by the C compilation system. Specify-lsec on thecc command line to link with this library. Seelibsec(3LIB).
These functions constitute the SNMP libraries,libssagent andlibssasnmp. These libraries are implemented as shared objects,libssagent.so andlibssasnmp.so, respectively, but are not automatically linked by the C compilation system. Specify-lssagent or-lssasnmp on thecc command line to link with these libraries. Seelibssagent(3LIB) andlibssasnmp(3LIB).
These functions constitute the SRP Target Management library,libsrpt. This library is implemented as a shared object,libsrpt.so, but is not automatically linked by the C compilation system. Specify-lsrpt on thecc command line to link with this library. Seelibsrpt(3LIB).
These functions constitute the SCSI Target Mode Framework library,libstmf. This library is implemented as a shared object,libstmf.so, but is not automatically linked by the C compilation system. Specify-lstmf on thecc command line to link with this library. Seelibstmf(3LIB).
These functions constitute the system event library,libsysevent. This library is implemented as a shared object,libsysevent.so, but is not automatically linked by the C compilation system. Specify-lsysevent on thecc command line to link with this library. Seelibsysevent(3LIB).
These functions constitute the interactive command-line input library,libtecla. This library is implemented as a shared object,libtecla.so, but is not automatically linked by the C compilation system. Specify-ltecla on thecc command line to link with this library. Seelibtecla(3LIB).
These functions constitute the Trusted Extensions library,libtsol, and the Trusted Extensions network library,libtsnet. These libraries are implemented as shared objects,libtsol.so andlibtsnet.so, but are not automatically linked by the C compilation system. Specify-ltsol or-ltsnet on thecc command line to link with these libraries. Seelibtsol(3LIB) andlibtsnet(3LIB).
These functions constitute the universally unique identifier library,libuuid. This library is implemented as a shared object,libuuid.so, but is not automatically linked by the C compilation system. Specify-luuid on thecc command line to link with this library. Seelibuuid(3LIB).
These functions constitute the volume management library,libvolmgt. This library is implemented as a shared object,libvolmgt.so, but is not automatically linked by the C compilation system. Specify-lvolmgt on thecc command line to link with this library. Seelibvolmgt(3LIB).
These functions constitute the product install registry library,libwsreg. This library is implemented as a shared object,libwsreg.so, but is not automatically linked by the C compilation system. Specify-lwsreg on thecc command line to link with this library. Seelibwsreg(3LIB).
These functions constitute the Trusted Extensions to the X windows library,libXtsol. This library is implemented as a shared object,libXtsol.so, but is not automatically linked by the C compilation system. Specify-lX11 and then-lXtsol on thecc command line to link with this library. SeelibXtsol(3LIB).
These functions constitute the zones statistics library,libzonestat. This library is implemented as a shared object,libzonestat.so, but is not automatically linked by the C compilation system. Specify-lzonestat on thecc command line to link with this library. Seelibzonestat(3LIB).
These functions constitute the mediaLib library,libmlib. This library is implemented as a shared object,libmlib.so, but is not automatically linked by the C compilation system. Specify-lmlib on thecc command line to link with this library. Seelibmlib(3LIB).
A character is any bit pattern able to fit into a byteon the machine. In some international languages, however, a “character” might requiremore than one byte, and is represented in multi-bytes.
The null character is a character with value 0, conventionally represented inthe C language as\ 0. A character array is a sequence ofcharacters. A null-terminated character array (astring) is a sequence of characters,the last of which is the null character. The null string is acharacter array containing only the terminating null character. A null pointer isthe value that is obtained by casting0 into a pointer. Cguarantees that this value will not match that of any legitimate pointer,so many functions that return pointers returnNULL to indicate an error. ThemacroNULL is defined in <stdio.h>. Types of the formsize_t aredefined in the appropriate headers.
Both POSIX threads and Solaris threads can be used within the sameapplication. Their implementations are completely compatible with each other; however, only POSIXthreads guarantee portability to other POSIX-conforming environments.
Thelibpthread(3LIB) andlibthread(3LIB) libraries are implemented as filters onlibc(3LIB).
When compiling a multithreaded application, the-mt option must be specified onthe command line.
There is no need for a multithreaded application to link with-lthread.An application must link with-lpthread only when POSIX semantics forfork(2)are desired. When an application is linked with-lpthread, a call tofork() assumes the behaviorfork1(2) rather than the default behavior that forks allthreads.
When compiling a POSIX-conforming application, either the_POSIX_C_SOURCE or_POSIX_PTHREAD_SEMANTICS option mustbe specified on the command line. For POSIX.1c-conforming applications, define the_POSIX_C_SOURCEflag to be >= 199506L:
cc-mt [flag... ]file...-D_POSIX_C_SOURCE=199506L-lpthread
For POSIX behavior with the Solarisfork() andfork1() distinction, compile asfollows:
cc-mt [flag... ]file...-D_POSIX_PTHREAD_SEMANTICS
For Solaris threads behavior, compile as follows:
cc-mt [flag... ]file...
Unsafe interfaces should be called only from the main thread to ensurethe application's safety.
MT-Safe interfaces are denoted in theATTRIBUTES section of the functions andlibraries manual pages (seeattributes(5)). If a manual page does not state explicitlythat an interface is MT-Safe, the user should assume that the interfaceis unsafe.
The environment variableLD_BIND_NOW must be set to a non-null value toenable early binding. Refer to the “When Relocations are Processed” chapter inLinker and Libraries Guide for additional information.
usually/usr/include
usually either/lib or/usr/lib (32–bit) or either/lib/64 or/usr/lib/64 (64–bit)
shared libraries
Oracle America, Inc. gratefully acknowledges The Open Group for permission to reproduceportions of its copyrighted documentation. Original documentation from The Open Group canbe obtained online athttp://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open Group, havegiven us permission to reprint portions of their documentation.
In the following statement, the phrase ``this text'' refers to portions ofthe system documentation.
Portions of this text are reprinted and reproduced in electronic form inthe SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard forInformation Technology -- Portable Operating System Interface (POSIX), The Open Group BaseSpecifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and ElectronicsEngineers, Inc and The Open Group. In the event of anydiscrepancy between these versions and the original IEEE and The Open GroupStandard, the original IEEE and The Open Group Standard is the refereedocument. The original Standard can be obtained online athttp://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
ar(1),ld(1),fork(2),stdio(3C),attributes(5),standards(5)
ANSI C Programmer's Guide
For functions that return floating-point values, error handling varies according to compilationmode. Under the-Xt (default) option tocc, these functions return theconventional values0,±HUGE, orNaN when the function is undefined for thegiven arguments or when the value is not representable. In the-Xaand-Xc compilation modes,±HUGE_VAL is returned instead of±HUGE. (HUGE_VAL andHUGE are defined inmath.h to be infinity and the largest-magnitude single-precision number,respectively.)
None of the functions, external variables, or macros should be redefined inthe user's programs. Any other name can be redefined without affecting thebehavior of other library functions, but such redefinition might conflict with adeclaration in an included header.
The headers inINCDIR provide function prototypes (function declarations including the typesof arguments) for most of the functions listed in this manual. Functionprototypes allow the compiler to check for correct usage of these functionsin the user's program. Thelint program checker can also be used andwill report discrepancies even if the headers are not included with#includestatements. Definitions for Sections 2 and 3C are checked automatically. Other definitionscan be included by using the-l option tolint. (For example,-lmincludes definitions forlibm.) Use oflint is highly recommended. See thelint chapter inPerformance Profiling Tools
Users should carefully note the difference between STREAMS andstream. STREAMS isa set of kernel mechanisms that support the development of network servicesand data communication drivers. It is composed of utility routines, kernel facilities,and a set of data structures. Astream is a file with itsassociated buffering. It is declared to be a pointer to a typeFILE defined in<stdio.h>.
In detailed definitions of components, it is sometimes necessary to refer tosymbolic names that are implementation-specific, but which are not necessarily expected tobe accessible to an application program. Many of these symbolic names describeboundary 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 fromsymbolic names of other implementation-specific constants that are accessible to application programsby headers. These names are not necessarily accessible to an application program througha header, although they can be defined in the documentation for aparticular system.
In general, a portable application program should not refer to these symbolicnames in its code. For example, an application program would not beexpected to test the length of an argument list given to aroutine to determine if it was greater than {ARG_MAX}.
Copyright © 2011, Oracle and/or its affiliates. All rights reserved.Legal Notices |   |