xref: /onnv-gate/usr/src/uts/common/sys/msg.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 1999-2003 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate /*	Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T	*/
28*0Sstevel@tonic-gate /*	  All Rights Reserved  	*/
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate 
31*0Sstevel@tonic-gate #ifndef _SYS_MSG_H
32*0Sstevel@tonic-gate #define	_SYS_MSG_H
33*0Sstevel@tonic-gate 
34*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate #include <sys/ipc.h>
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate #ifdef	__cplusplus
39*0Sstevel@tonic-gate extern "C" {
40*0Sstevel@tonic-gate #endif
41*0Sstevel@tonic-gate 
42*0Sstevel@tonic-gate /*
43*0Sstevel@tonic-gate  * IPC Message Facility.
44*0Sstevel@tonic-gate  */
45*0Sstevel@tonic-gate 
46*0Sstevel@tonic-gate /*
47*0Sstevel@tonic-gate  * Implementation Constants.
48*0Sstevel@tonic-gate  */
49*0Sstevel@tonic-gate 
50*0Sstevel@tonic-gate /*
51*0Sstevel@tonic-gate  * Permission Definitions.
52*0Sstevel@tonic-gate  */
53*0Sstevel@tonic-gate #define	MSG_R	0400	/* read permission */
54*0Sstevel@tonic-gate #define	MSG_W	0200	/* write permission */
55*0Sstevel@tonic-gate 
56*0Sstevel@tonic-gate /*
57*0Sstevel@tonic-gate  * ipc_perm Mode Definitions.
58*0Sstevel@tonic-gate  */
59*0Sstevel@tonic-gate #define	MSG_RWAIT	01000	/* a reader is waiting for a message */
60*0Sstevel@tonic-gate #define	MSG_WWAIT	02000	/* a writer is waiting to send */
61*0Sstevel@tonic-gate 
62*0Sstevel@tonic-gate /*
63*0Sstevel@tonic-gate  * Message Operation Flags.
64*0Sstevel@tonic-gate  */
65*0Sstevel@tonic-gate #define	MSG_NOERROR	010000	/* no error if big message */
66*0Sstevel@tonic-gate 
67*0Sstevel@tonic-gate typedef unsigned long msgqnum_t;
68*0Sstevel@tonic-gate typedef unsigned long msglen_t;
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate struct msg;
71*0Sstevel@tonic-gate struct msqid_ds {
72*0Sstevel@tonic-gate 	struct ipc_perm	msg_perm;	/* operation permission struct */
73*0Sstevel@tonic-gate 	struct msg	*msg_first;	/* ptr to first message on q */
74*0Sstevel@tonic-gate 	struct msg	*msg_last;	/* ptr to last message on q */
75*0Sstevel@tonic-gate 	msglen_t	msg_cbytes;	/* current # bytes on q */
76*0Sstevel@tonic-gate 	msgqnum_t	msg_qnum;	/* # of messages on q */
77*0Sstevel@tonic-gate 	msglen_t	msg_qbytes;	/* max # of bytes on q */
78*0Sstevel@tonic-gate 	pid_t		msg_lspid;	/* pid of last msgsnd */
79*0Sstevel@tonic-gate 	pid_t		msg_lrpid;	/* pid of last msgrcv */
80*0Sstevel@tonic-gate #if defined(_LP64)
81*0Sstevel@tonic-gate 	time_t		msg_stime;	/* last msgsnd time */
82*0Sstevel@tonic-gate 	time_t		msg_rtime;	/* last msgrcv time */
83*0Sstevel@tonic-gate 	time_t		msg_ctime;	/* last change time */
84*0Sstevel@tonic-gate #else
85*0Sstevel@tonic-gate 	time_t		msg_stime;	/* last msgsnd time */
86*0Sstevel@tonic-gate 	int32_t		msg_pad1;	/* reserved for time_t expansion */
87*0Sstevel@tonic-gate 	time_t		msg_rtime;	/* last msgrcv time */
88*0Sstevel@tonic-gate 	int32_t		msg_pad2;	/* time_t expansion */
89*0Sstevel@tonic-gate 	time_t		msg_ctime;	/* last change time */
90*0Sstevel@tonic-gate 	int32_t		msg_pad3;	/* time_t expansion */
91*0Sstevel@tonic-gate #endif
92*0Sstevel@tonic-gate 	short		msg_cv;
93*0Sstevel@tonic-gate 	short		msg_qnum_cv;
94*0Sstevel@tonic-gate 	long		msg_pad4[3];	/* reserve area */
95*0Sstevel@tonic-gate };
96*0Sstevel@tonic-gate 
97*0Sstevel@tonic-gate /*
98*0Sstevel@tonic-gate  * User message buffer template for msgsnd and msgrecv system calls.
99*0Sstevel@tonic-gate  */
100*0Sstevel@tonic-gate 
101*0Sstevel@tonic-gate #ifdef _KERNEL
102*0Sstevel@tonic-gate struct ipcmsgbuf {
103*0Sstevel@tonic-gate #else
104*0Sstevel@tonic-gate struct msgbuf {
105*0Sstevel@tonic-gate #endif /* _KERNEL */
106*0Sstevel@tonic-gate #if defined(_XOPEN_SOURCE)
107*0Sstevel@tonic-gate 	long	_mtype;		/* message type */
108*0Sstevel@tonic-gate 	char	_mtext[1];	/* message text */
109*0Sstevel@tonic-gate #else
110*0Sstevel@tonic-gate 	long	mtype;		/* message type */
111*0Sstevel@tonic-gate 	char	mtext[1];	/* message text */
112*0Sstevel@tonic-gate #endif
113*0Sstevel@tonic-gate };
114*0Sstevel@tonic-gate 
115*0Sstevel@tonic-gate /*
116*0Sstevel@tonic-gate  * Header and message header structures for msgsnap() system call.
117*0Sstevel@tonic-gate  */
118*0Sstevel@tonic-gate struct msgsnap_head {
119*0Sstevel@tonic-gate 	size_t	msgsnap_size;	/* bytes consumed/required in the buffer */
120*0Sstevel@tonic-gate 	size_t	msgsnap_nmsg;	/* number of messages in the buffer */
121*0Sstevel@tonic-gate };
122*0Sstevel@tonic-gate 
123*0Sstevel@tonic-gate struct msgsnap_mhead {
124*0Sstevel@tonic-gate 	size_t	msgsnap_mlen;	/* number of bytes in message that follows */
125*0Sstevel@tonic-gate 	long	msgsnap_mtype;	/* message type */
126*0Sstevel@tonic-gate };
127*0Sstevel@tonic-gate 
128*0Sstevel@tonic-gate #if !defined(_KERNEL)
129*0Sstevel@tonic-gate #if defined(__STDC__)
130*0Sstevel@tonic-gate int msgctl(int, int, struct msqid_ds *);
131*0Sstevel@tonic-gate int msgget(key_t, int);
132*0Sstevel@tonic-gate int msgids(int *, uint_t, uint_t *);
133*0Sstevel@tonic-gate int msgsnap(int, void *, size_t, long);
134*0Sstevel@tonic-gate ssize_t msgrcv(int, void *, size_t, long, int);
135*0Sstevel@tonic-gate int msgsnd(int, const void *, size_t, int);
136*0Sstevel@tonic-gate #else /* __STDC__ */
137*0Sstevel@tonic-gate int msgctl();
138*0Sstevel@tonic-gate int msgget();
139*0Sstevel@tonic-gate int msgids();
140*0Sstevel@tonic-gate int msgsnap();
141*0Sstevel@tonic-gate int msgrcv();
142*0Sstevel@tonic-gate int msgsnd();
143*0Sstevel@tonic-gate #endif /* __STDC__ */
144*0Sstevel@tonic-gate #endif /* ! _KERNEL */
145*0Sstevel@tonic-gate 
146*0Sstevel@tonic-gate #ifdef	__cplusplus
147*0Sstevel@tonic-gate }
148*0Sstevel@tonic-gate #endif
149*0Sstevel@tonic-gate 
150*0Sstevel@tonic-gate #endif	/* _SYS_MSG_H */
151