xlocale.h.3head

MANLINKS= \

LIST_CLASS_ENTRY.3head \

LIST_CLASS_HEAD.3head \

LIST_CONCAT.3head \

wordexp.3head \

xlocale.3head

LIST_CLASS_ENTRY.3head := LINKSRC = queue.h.3head

LIST_CLASS_HEAD.3head := LINKSRC = queue.h.3head

LIST_CONCAT.3head := LINKSRC = queue.h.3head

.\"

.\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved.

.\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.

.\"

.SH NAME

.SH SYNOPSIS

.nf

\fB#include <sys/socket.h>\fR

.fi

.SH DESCRIPTION

The \fB<sys/socket.h>\fR header defines the unsigned integral type

\fBsa_family_t\fR through \fBtypedef\fR.

.sp

.in -2

.SS "\fBlibxnet\fR Interfaces"

The \fB<sys/socket.h>\fR header defines the \fBmsghdr\fR structure for

\fBlibxnet\fR interfaces that includes the following members:

.sp

.sp

.ne 2

.na

.ad

.RS 14n

.RE

.sp

.ne 2

.na

.ad

.RS 14n

Indicates that the data array contains a \fBucred_t\fR to be received. The

.sp

.LP

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.sp

.ne 2

.na

.ad

.na

.ad

.sp .6

.RS 4n

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.RE

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.RE

.sp

.ne 2

.na

.ad

.na

.ad

.sp .6

.RS 4n

.RE

.sp

.LP

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.RE

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.RE

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.RE

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.RE

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.RE

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.RE

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.RE

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.RE

.sp

.sp

.ne 2

.na

.ad

.RS 18n

Datagram socket

.sp

.ne 2

.na

.ad

.RS 18n

Byte-stream socket

.sp

.ne 2

.na

.ad

.RS 18n

Sequenced-packet socket

.sp

.ne 2

.na

.ad

.RS 14n

Options to be accessed at the socket level, not the protocol level.

.sp

.ne 2

.na

.ad

.RS 14n

Options to be accessed at the routing socket level, not the protocol level.

.sp

.ne 2

.na

.ad

.RS 17n

Debugging information is being recorded.

.sp

.ne 2

.na

.ad

.RS 17n

Socket is accepting connections.

.sp

.ne 2

.na

.ad

.RS 17n

Transmission of broadcast messages is supported.

.sp

.ne 2

.na

.ad

.RS 17n

Reuse of local addresses is supported.

.sp

.ne 2

.na

.ad

.RS 17n

Connections are kept alive with periodic messages.

.sp

.ne 2

.na

.ad

.RS 17n

Socket lingers on close.

.sp

.ne 2

.na

.ad

.RS 17n

Out-of-band data is transmitted in line.

.sp

.ne 2

.na

.ad

.RS 17n

Send buffer size.

.sp

.ne 2

.na

.ad

.RS 17n

Receive buffer size.

.sp

.ne 2

.na

.ad

.RS 17n

Socket error status.

.sp

.ne 2

.na

.ad

.RS 17n

Socket type.

.sp

.ne 2

.na

.ad

.RS 17n

Request the reception of user credential ancillary data. This is a

.sp

.ne 2

.na

.ad

.RS 17n

Mandatory Access Control (\fBMAC\fR) exemption for unlabeled peers. This option

.sp

.ne 2

.na

.ad

.RS 17n

Bypass zone boundaries (privileged).

.sp

.ne 2

.na

.ad

.RS 15n

Control data truncated.

.sp

.ne 2

.na

.ad

.RS 15n

Terminates a record (if supported by the protocol).

.sp

.ne 2

.na

.ad

.RS 15n

Out-of-band data.

.sp

.ne 2

.na

.ad

.RS 15n

Leave received data in queue.

.sp

.ne 2

.na

.ad

.RS 15n

Normal data truncated.

.sp

.ne 2

.na

.ad

.RS 15n

Wait for complete message.

.sp

.ne 2

.na

.ad

.RS 15n

Do not generate \fBSIGPIPE\fR signal.

.sp

.ne 2

.na

.ad

.RS 11n

UNIX domain sockets

.sp

.ne 2

.na

.ad

.RS 11n

Internet domain sockets

.sp

.ne 2

.na

.ad

.RS 13n

Disables further receive operations.

.sp

.ne 2

.na

.ad

.RS 13n

Disables further send operations.

.sp

.ne 2

.na

.ad

.RS 13n

Disables further send and receive operations.

.RE

.SS "\fBlibsocket\fR Interfaces"

The \fB<sys/socket.h>\fR header defines the \fBmsghdr\fR structure for

\fBlibsocket\fR interfaces that includes the following members:

.sp

which access rights sent along with the message are received. The

\fImsg_accrightslen\fR specifies the length of the buffer.

.SH ATTRIBUTES

See \fBattributes\fR(5) for descriptions of the following attributes:

.sp

.TE

.SH SEE ALSO

\fBaccept\fR(3SOCKET), \fBaccept\fR(3XNET), \fBbind\fR(3SOCKET),

\fBbind\fR(3XNET), \fBconnect\fR(3SOCKET), \fBconnect\fR(3XNET),

\fBgetpeername\fR(3SOCKET), \fBgetpeername\fR(3XNET), \fBgetpeerucred\fR(3C),

'\" te

.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.

.\" Copyright 2008 AT&T

.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.

.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.

.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]

.SH NAME

ip, IP \- Internet Protocol

.SH SYNOPSIS

.nf

\fB#include <sys/socket.h>\fR

.fi

.fi

.SH DESCRIPTION

IP is the internetwork datagram delivery protocol that is central to the

Internet protocol family. Programs may use \fBIP\fR through higher-level

protocols such as the Transmission Control Protocol (TCP) or the User Datagram

Packets sent to or from this system may be subject to IPsec policy. See

\fBipsec\fR(7P) for more information.

.SH APPLICATION PROGRAMMING INTERFACE

The STREAMS driver \fB/dev/rawip\fR is the TLI transport provider that provides

raw access to IP.

.sp

.sp

.ne 2

.na

.ad

.RS 22n

IP options for outgoing datagrams. This socket option may be used to set IP

.sp

.ne 2

.na

.ad

.RS 22n

Enable or obtain IPsec security settings for this socket. For more details on

.sp

.ne 2

.na

.ad

.RS 22n

Join a multicast group.

.sp

.ne 2

.na

.ad

.RS 22n

Leave a multicast group.

.sp

.ne 2

.na

.ad

.RS 22n

Limit reception and transmission of packets to this interface. Takes an

.sp

.LP

.sp

.ne 2

.na

.ad

.sp .6

.RS 4n

.RE

.sp

.ne 2

.na

.ad

Enable/disable receipt of the index of the interface the packet arrived on, the

local address that was matched for reception, and the inbound packet's actual

.RE

.sp

.sp

.ne 2

.na

.ad

.RS 29n

Block multicast packets whose source address matches the given source address.

.sp

.ne 2

.na

.ad

.RS 29n

Unblock (begin receiving) multicast packets which were previously blocked using

.sp

.ne 2

.na

.ad

.RS 29n

Begin receiving packets for the given multicast group whose source address

.sp

.ne 2

.na

.ad

.RS 29n

Stop receiving packets for the given multicast group whose source address

.sp

.ne 2

.na

.ad

.RS 28n

Join a multicast group. Functionally equivalent to IP_ADD_MEMBERSHIP.

.sp

.ne 2

.na

.ad

.RS 28n

Block multicast packets whose source address matches the given source address.

.sp

.ne 2

.na

.ad

.RS 28n

Unblock (begin receiving) multicast packets which were previously blocked using

.sp

.ne 2

.na

.ad

.RS 28n

Leave a multicast group. Functionally equivalent to IP_DROP_MEMBERSHIP.

.sp

.ne 2

.na

.ad

.RS 28n

Begin receiving packets for the given multicast group whose source address

.sp

.ne 2

.na

.ad

.RS 28n

Stop receiving packets for the given multicast group whose source address

.sp

.ne 2

.na

.ad

.RS 21n

The outgoing interface for multicast packets. This option takes a \fBstruct\fR

.sp

.ne 2

.na

.ad

.RS 21n

Time to live for multicast datagrams. This option takes an unsigned character

.sp

.ne 2

.na

.ad

.RS 21n

Loopback for multicast datagrams. Normally multicast datagrams are delivered

.sp

.ne 2

.na

.ad

.RS 21n

This option takes an integer argument as its input value. The least significant

.sp

.ne 2

.na

.ad

.RS 21n

This option specifies the address of the onlink nexthop for traffic originating

will only initiate Multi-Data Transmit if the network interface driver supports

it.

.SH PACKET EVENTS

Through the netinfo framework, this driver provides the following packet

events:

.sp

.RE

.SH NETWORK INTERFACE EVENTS

In addition to events describing packets as they move through the system, it is

also possible to receive notification of events relating to network interfaces.

These events are all reported back through the same callback. The list of

.RE

.SH SEE ALSO

\fBifconfig\fR(1M), \fBrouteadm\fR(1M), \fBndd\fR(1M), \fBread\fR(2),

.sp

.LP

Braden, R., \fIRFC 1122, Requirements for Internet Hosts \(mi Communication

Specification\fR, Information Sciences Institute, University of Southern

California, September 1981.

.SH DIAGNOSTICS

A socket operation may fail with one of the following errors returned:

.sp

.ne 2

.na

.ad

.RS 17n

A \fBbind()\fR operation was attempted with a "reserved" port number and the

.sp

.ne 2

.na

.ad

.RS 17n

A \fBbind()\fR operation was attempted on a socket with a network address/port

.sp

.ne 2

.na

.ad

.RS 17n

A \fBbind()\fR operation was attempted for an address that is not configured on

.sp

.ne 2

.na

.ad

.RS 17n

A \fBsendmsg()\fR operation with a non-NULL \fBmsg_accrights\fR was attempted.

.sp

.ne 2

.na

.ad

.RS 17n

A \fBgetsockopt()\fR or \fBsetsockopt()\fR operation with an unknown socket

.sp

.ne 2

.na

.ad

.RS 17n

A \fBgetsockopt()\fR or \fBsetsockopt()\fR operation was attempted with the

.sp

.ne 2

.na

.ad

.RS 17n

A \fBconnect()\fR operation was attempted on a socket on which a

.sp

.ne 2

.na

.ad

.RS 17n

A \fBsendto()\fR or \fBsendmsg()\fR operation specifying an address to which

.sp

.ne 2

.na

.ad

.RS 17n

A \fBsend()\fR, \fBsendto()\fR, or \fBsendmsg()\fR operation was attempted to

.sp

.ne 2

.na

.ad

.RS 17n

An attempt was made to establish a connection by means of \fBconnect()\fR, or

.sp

.ne 2

.na

.ad

.RS 17n

A \fBsend()\fR or \fBwrite()\fR operation, or a \fBsendto()\fR or

.sp

.ne 2

.na

.ad

.RS 17n

The system ran out of memory for fragmentation buffers or other internal data

.sp

.ne 2

.na

.ad

.RS 17n

\fBSO_SNDBUF\fR or \fBSO_RCVBUF\fR exceeds a system limit.

.sp

.ne 2

.na

.ad

.RS 17n

Invalid length for \fBIP_OPTIONS\fR.

.sp

.ne 2

.na

.ad

.RS 17n

Invalid address for \fBIP_MULTICAST_IF\fR.

.sp

.ne 2

.na

.ad

.RS 17n

Not a multicast address for \fBIP_ADD_MEMBERSHIP\fR and

.sp

.ne 2

.na

.ad

.RS 17n

Bad interface address for \fBIP_ADD_MEMBERSHIP\fR and \fBIP_DROP_MEMBERSHIP\fR.

.sp

.ne 2

.na

.ad

.RS 17n

Address already joined for \fBIP_ADD_MEMBERSHIP\fR.

.sp

.ne 2

.na

.ad

.RS 17n

Address not joined for \fBIP_DROP_MEMBERSHIP\fR.

.sp

.ne 2

.na

.ad

.RS 17n

Invalid socket type.

.sp

.ne 2

.na

.ad

.RS 17n

No permissions.

.RE

.SH NOTES

Raw sockets should receive \fBICMP\fR error packets relating to the protocol;

currently such packets are simply discarded.

.sp

target=../sun4u/include

$(sparc_ONLY)link path=usr/platform/SUNW,Ultra-Enterprise/include \

target=../sun4u/include

link path=usr/share/man/man3head/LIST_CLASS_ENTRY.3head target=queue.h.3head

link path=usr/share/man/man3head/LIST_CLASS_HEAD.3head target=queue.h.3head

link path=usr/share/man/man3head/LIST_CONCAT.3head target=queue.h.3head

file path=opt/os-tests/tests/sockfs/dgram mode=0555

file path=opt/os-tests/tests/sockfs/drop_priv mode=0555

file path=opt/os-tests/tests/sockfs/nosignal mode=0555

file path=opt/os-tests/tests/sockfs/rights.32 mode=0555

file path=opt/os-tests/tests/sockfs/rights.64 mode=0555

file path=opt/os-tests/tests/sockfs/sockpair mode=0555

[/opt/os-tests/tests/sockfs]

user = root

tests = ['conn', 'dgram', 'drop_priv', 'nosignal', 'rights.32', 'rights.64',

[/opt/os-tests/tests/syscall]

tests = ['open.32', 'open.64']

include $(SRC)/cmd/Makefile.cmd

include $(SRC)/test/Makefile.com

PROG = conn dgram drop_priv nosignal sockpair \

LDLIBS += -lsocket

LDLIBS64 += -lsocket

cmsg->cmsg_level = tohp->level;

cmsg->cmsg_type = tohp->name;

/* copy content to control data part */

bcopy(&tohp[1], CMSG_CONTENT(cmsg),

/*

* Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.

*/

/* Copyright (c) 1990 Mentat Inc. */

}

/*

* If IP_RECVTTL is set allocate the appropriate sized buffer

*/

if (recv_ancillary.crb_recvttl &&

(ira->ira_flags & IRAF_IS_IPV4)) {

IP_STAT(ipst, conn_in_recvttl);

}

ancil_size -= toh->len;

}

if (recv_ancillary.crb_recvttl &&

(ira->ira_flags & IRAF_IS_IPV4)) {

struct T_opthdr *toh;

toh = (struct T_opthdr *)ancil_buf;

toh->level = IPPROTO_IP;

toh->name = IP_RECVTTL;

toh->status = 0;

ancil_buf += sizeof (struct T_opthdr);

dstptr = (uint8_t *)ancil_buf;

*dstptr = ipp->ipp_hoplimit;

ancil_size -= toh->len;

}

/* Consumed all of allocated space */

case IP_RECVTTL:

*i1 = connp->conn_recv_ancillary.crb_recvttl;

break; /* goto sizeof (int) option return */

case IP_ADD_MEMBERSHIP:

case IP_DROP_MEMBERSHIP:

case MCAST_JOIN_GROUP:

connp->conn_recv_ancillary.crb_recvttl = onoff;

mutex_exit(&connp->conn_lock);

break;

case IP_PKTINFO: {

/*

* This also handles IP_RECVPKTINFO.

* Copyright (c) 2017 OmniTI Computer Consulting, Inc. All rights reserved.

* Copyright (c) 2016 by Delphix. All rights reserved.

* Copyright (c) 2019 Joyent, Inc. All rights reserved.

*/

#include <sys/types.h>

{ "conn_in_recvslla", KSTAT_DATA_UINT64 },

{ "conn_in_recvucred", KSTAT_DATA_UINT64 },

{ "conn_in_recvttl", KSTAT_DATA_UINT64 },

{ "conn_in_recvhopopts", KSTAT_DATA_UINT64 },

{ "conn_in_recvhoplimit", KSTAT_DATA_UINT64 },

{ "conn_in_recvdstopts", KSTAT_DATA_UINT64 },

/*

* Copyright 2019 Joyent, Inc.

*/

#ifndef _INET_IP_STACK_H

kstat_named_t conn_in_recvslla;

kstat_named_t conn_in_recvucred;

kstat_named_t conn_in_recvttl;

kstat_named_t conn_in_recvhopopts;

kstat_named_t conn_in_recvhoplimit;

kstat_named_t conn_in_recvdstopts;

*/

/*

*/

#ifndef _INET_IPCLASSIFIER_H

crbb_recvslla : 1, /* IP_RECVSLLA option */

crbb_recvttl : 1, /* IP_RECVTTL option */

crbb_ip_recvpktinfo : 1, /* IP*_RECVPKTINFO option */

crbb_ipv6_recvhoplimit : 1, /* IPV6_RECVHOPLIMIT option */

crbb_ipv6_recvhopopts : 1, /* IPV6_RECVHOPOPTS option */

#define crb_recvif crbu.crbb.crbb_recvif

#define crb_recvslla crbu.crbb.crbb_recvslla

#define crb_recvttl crbu.crbb.crbb_recvttl

#define crb_ip_recvpktinfo crbu.crbb.crbb_ip_recvpktinfo

#define crb_ipv6_recvhoplimit crbu.crbb.crbb_ipv6_recvhoplimit

#define crb_ipv6_recvhopopts crbu.crbb.crbb_ipv6_recvhopopts

* Copyright (c) 2011, Joyent, Inc. All rights reserved.

* Copyright (c) 2011 Nexenta Systems, Inc. All rights reserved.

* Copyright (c) 2014, 2017 by Delphix. All rights reserved.

*/

/* Copyright (c) 1990 Mentat Inc. */

int tcp_ipsec_overhead;

uint_t tcp_recvifindex; /* Last received IPV6_RCVPKTINFO */

uint_t tcp_recvhops; /* Last received IPV6_RECVHOPLIMIT */

uint_t tcp_recvtclass; /* Last received IPV6_RECVTCLASS */

* Copyright 2011 Nexenta Systems, Inc. All rights reserved.

* Copyright 2019 Joyent, Inc.

* Copyright (c) 2014, 2016 by Delphix. All rights reserved.

*/

/* This file contains all TCP input processing functions. */

optlen = 0;

addflag.crb_all = 0;

/* If app asked for pktinfo and the index has changed ... */

if (connp->conn_recv_ancillary.crb_ip_recvpktinfo &&

ira->ira_ruifindex != tcp->tcp_recvifindex) {

optlen += sizeof (struct T_opthdr) + sizeof (uint_t);

addflag.crb_ipv6_recvtclass = 1;

}

/*

* For security labels, note that (1) security labels can't change on

* a connected socket at all, (2) we're connected to at most one peer,

* (3) if anything changes, then it must be some other extra option.

todi->OPT_length = optlen;

todi->OPT_offset = sizeof (*todi);

optptr = (uchar_t *)&todi[1];

/*

* If app asked for pktinfo and the index has changed ...

* Note that the local address never changes for the connection.

* Copyright (c) 2011 Nexenta Systems, Inc. All rights reserved.

* Copyright 2019 Joyent, Inc.

* Copyright (c) 2016 by Delphix. All rights reserved.

*/

#include <sys/types.h>

{ T_IP_TOS, IPPROTO_IP, OA_RW, OA_RW, OP_NP, 0, sizeof (int), 0 },

{ IP_TTL, IPPROTO_IP, OA_RW, OA_RW, OP_NP, OP_DEF_FN,

sizeof (int), -1 /* not initialized */ },

{ IP_SEC_OPT, IPPROTO_IP, OA_RW, OA_RW, OP_NP, OP_NODEFAULT,

sizeof (ipsec_req_t), -1 /* not initialized */ },

/*

* Note: Implies T_CHECK semantics for T_OPTCOM_REQ

* inlen != 0 implies value supplied and

* inlen == 0 implies that there is no

* done elsewhere should be enough, we just return here.

*/

if (inlen == 0) {

return (EINVAL);

}

break;

}

break;

case IPPROTO_IPV6:

* Copyright (c) 1991, 2010, Oracle and/or its affiliates. All rights reserved.

* Copyright 2013 Nexenta Systems, Inc. All rights reserved.

* Copyright 2014, OmniTI Computer Consulting, Inc. All rights reserved.

*/

/* Copyright (c) 1990 Mentat Inc. */

*(uint32_t *)&sin->sin_zero[4] = 0;

/*

*/

if (udi_size != 0) {

conn_recvancillary_add(connp, recv_ancillary, ira,

/*

* Copyright 2009 Sun Microsystems, Inc. All rights reserved.

* Use is subject to license terms.

*/

#include <sys/types.h>

},

{ IP_RECVIF, IPPROTO_IP, OA_RW, OA_RW, OP_NP, 0, sizeof (int), 0 },

{ IP_RECVSLLA, IPPROTO_IP, OA_RW, OA_RW, OP_NP, 0, sizeof (int), 0 },

{ IP_MULTICAST_IF, IPPROTO_IP, OA_RW, OA_RW, OP_NP, 0,

sizeof (struct in_addr), 0 /* INADDR_ANY */ },

* Use is subject to license terms.

*

* Copyright 2011 Nexenta Systems, Inc. All rights reserved.

*/

/*

* Copyright (c) 1982, 1986 Regents of the University of California.

/* Well known 6to4 Relay Router Anycast address defined in RFC 3068 */

#if !defined(_XPG4_2) || !defined(__EXTENSIONS__)

#endif /* !defined(_XPG4_2) || !defined(__EXTENSIONS__) */

#define IN_LOOPBACKNET 127 /* official! */

#define IN6ADDR_ANY_INIT { 0, 0, 0, 0, \

0, 0, 0, 0, \

0, 0, 0, 0 }

#define IN6ADDR_LOOPBACK_INIT { 0, 0, 0, 0, \

#define IP_RECVIF 0x9 /* int; receive the inbound interface index */

#define IP_RECVSLLA 0xa /* sockaddr_dl; get source link layer address */

#define IP_RECVTTL 0xb /* uint8_t; get TTL for inbound packet */

#define IP_MULTICAST_IF 0x10 /* set/get IP multicast interface */

#define IP_MULTICAST_TTL 0x11 /* set/get IP multicast timetolive */

*/

typedef struct ipsec_req {

uint_t ipsr_self_encap_req; /* Self-Encap request */

uint8_t ipsr_auth_alg; /* Auth algs for AH */

uint8_t ipsr_esp_alg; /* Encr algs for ESP */

#define IPV6_RECVRTHDRDSTOPTS 0x17

#define IPV6_CHECKSUM 0x18 /* Control checksum on raw sockets */

#define IPV6_USE_MIN_MTU 0x20 /* send packets with minimum MTU */

#define IPV6_DONTFRAG 0x21 /* don't fragment packets */

#define IPV6_SEC_OPT 0x22 /* Used to set IPSEC options */