xref: /titanic_41/usr/src/uts/common/sys/stream.h (revision 66ea84940ca8687745ad2a165ef9bf49ec13996f)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 /*	Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T	*/
27 /*	  All Rights Reserved  	*/
28 
29 
30 #ifndef _SYS_STREAM_H
31 #define	_SYS_STREAM_H
32 
33 /*
34  * For source compatibility
35  */
36 #include <sys/isa_defs.h>
37 #ifdef _KERNEL
38 #include <sys/vnode.h>
39 #endif
40 #include <sys/poll.h>
41 #include <sys/strmdep.h>
42 #include <sys/cred.h>
43 #include <sys/t_lock.h>
44 #include <sys/model.h>
45 
46 #ifdef	__cplusplus
47 extern "C" {
48 #endif
49 
50 /*
51  * Data queue.
52  *
53  * NOTE: The *only* public fields are documented in queue(9S).
54  *       Everything else is implementation-private.
55  *
56  * The locking rules for the queue_t structure are extremely subtle and vary
57  * widely depending on the field in question.  As such, each field is
58  * annotated according to the following legend:
59  *
60  *   Q9S: The field is documented in queue(9S) and may be accessed without
61  *        locks by a STREAMS module when inside an entry point (e.g., put(9E)).
62  *        However, no fields can be directly modified unless q_lock is held
63  *        (which is not possible in a DDI compliant STREAMS module), with the
64  *        following exceptions:
65  *
66  *	   - q_ptr: can be modified as per the rules of the STREAMS module.
67  *		    The STREAMS framework ignores q_ptr and thus imposes *no*
68  *		    locking rules on it.
69  *         - q_qinfo: can be modified before qprocson().
70  *
71  *	   - q_minpsz, q_maxpsz, q_hiwat, q_lowat: can be modified as per the
72  *		    rules of the STREAMS module.  The STREAMS framework never
73  *		    modifies these fields, and is tolerant of temporarily
74  *		    stale field values.
75  *
76  *	  In general, the STREAMS framework employs one of the following
77  *	  techniques to ensure STREAMS modules can safely access Q9S fields:
78  *
79  *	   - The field is only modified by the framework when the stream is
80  *	     locked with strlock() (q_next).
81  *
82  *	   - The field is modified by the framework, but the modifies are
83  *	     atomic, and temporarily stale values are harmless (q_count,
84  *	     q_first, q_last).
85  *
86  *	   - The field is modified by the framework, but the field's visible
87  *	     values are either constant or directly under the control
88  *	     of the STREAMS module itself (q_flag).
89  *
90  *   QLK: The field must be accessed or modified under q_lock, except when
91  *        the stream has been locked with strlock().  If multiple q_locks must
92  *        be acquired, q_locks at higher addresses must be taken first.
93  *
94  *   STR: The field can be accessed without a lock, but must be modified under
95  *	  strlock().
96  *
97  *   SQLK: The field must be accessed or modified under SQLOCK().
98  *
99  *   NOLK: The field can be accessed without a lock, but can only be modified
100  *	   when the queue_t is not known to any other threads.
101  *
102  *   SVLK: The field must be accessed or modified under the service_queue lock.
103  *         Note that service_lock must be taken after any needed q_locks,
104  *	   and that no other lock should be taken while service_lock is held.
105  *
106  * In addition, it is always acceptable to modify a field that is not yet
107  * known to any other threads -- and other special case exceptions exist in
108  * the code.  Also, q_lock is used with q_wait to implement a stream head
109  * monitor for reads and writes.
110  */
111 typedef struct queue {
112 	struct qinit	*q_qinfo;	/* Q9S: Q processing procedure  */
113 	struct msgb	*q_first;	/* Q9S: first message in Q	*/
114 	struct msgb	*q_last;	/* Q9S: last message in Q	*/
115 	struct queue	*q_next;	/* Q9S: next Q in stream	*/
116 	struct queue	*q_link;	/* SVLK: next Q for scheduling	*/
117 	void		*q_ptr;		/* Q9S: module-specific data	*/
118 	size_t		q_count;	/* Q9S: number of bytes on Q	*/
119 	uint_t		q_flag;		/* Q9S: Q state			*/
120 	ssize_t		q_minpsz;	/* Q9S: smallest packet OK on Q */
121 	ssize_t		q_maxpsz;	/* Q9S: largest packet OK on Q	*/
122 	size_t		q_hiwat;	/* Q9S: Q high water mark	*/
123 	size_t		q_lowat;	/* Q9S: Q low water mark	*/
124 	struct qband	*q_bandp;	/* QLK: band flow information	*/
125 	kmutex_t	q_lock;		/* NOLK: structure lock		*/
126 	struct stdata 	*q_stream;	/* NOLK: stream backpointer	*/
127 	struct syncq	*q_syncq;	/* NOLK: associated syncq 	*/
128 	unsigned char	q_nband;	/* QLK: number of bands		*/
129 	kcondvar_t	q_wait;		/* NOLK: read/write sleep CV	*/
130 	struct queue	*q_nfsrv;	/* STR: next Q with svc routine */
131 	ushort_t	q_draining;	/* QLK: Q is draining		*/
132 	short		q_struiot;	/* QLK: sync streams Q UIO mode	*/
133 	clock_t		q_qtstamp;	/* QLK: when Q was enabled	*/
134 	size_t		q_mblkcnt;	/* QLK: mblk count		*/
135 	uint_t		q_syncqmsgs;	/* QLK: syncq message count	*/
136 	size_t		q_rwcnt;	/* QLK: # threads in rwnext()	*/
137 	pri_t		q_spri;		/* QLK: Q scheduling priority	*/
138 
139 	/*
140 	 * Syncq scheduling
141 	 */
142 	struct msgb	*q_sqhead;	/* QLK: first syncq message	*/
143 	struct msgb	*q_sqtail;	/* QLK: last syncq message 	*/
144 	struct queue	*q_sqnext;	/* SQLK: next Q on syncq list	*/
145 	struct queue	*q_sqprev;	/* SQLK: prev Q on syncq list 	*/
146 	uint_t		q_sqflags;	/* SQLK: syncq flags		*/
147 	clock_t		q_sqtstamp;	/* SQLK: when Q was scheduled for sq */
148 
149 	/*
150 	 * NOLK: Reference to the queue's module's implementation
151 	 * structure. This will be NULL for queues associated with drivers.
152 	 */
153 	struct fmodsw_impl	*q_fp;
154 } queue_t;
155 
156 /*
157  * Queue flags; unused flags not documented in queue(9S) can be recycled.
158  */
159 #define	QENAB		0x00000001	/* Queue is already enabled to run */
160 #define	QWANTR		0x00000002	/* Someone wants to read Q	*/
161 #define	QWANTW		0x00000004	/* Someone wants to write Q	*/
162 #define	QFULL		0x00000008	/* Q is considered full		*/
163 #define	QREADR		0x00000010	/* This is the reader (first) Q	*/
164 #define	QUSE		0x00000020	/* This queue in use (allocation) */
165 #define	QNOENB		0x00000040	/* Don't enable Q via putq	*/
166 #define	QWANTRMQSYNC	0x00000080	/* Want to remove sync stream Q */
167 #define	QBACK		0x00000100	/* queue has been back-enabled	*/
168 /*	UNUSED		0x00000200	   was QHLIST			*/
169 /* 	UNUSED 		0x00000400	   was QUNSAFE			*/
170 #define	QPAIR		0x00000800	/* per queue-pair syncq		*/
171 #define	QPERQ 		0x00001000	/* per queue-instance syncq	*/
172 #define	QPERMOD		0x00002000	/* per module syncq		*/
173 #define	QMTSAFE		0x00004000	/* stream module is MT-safe	*/
174 #define	QMTOUTPERIM	0x00008000	/* Has outer perimeter		*/
175 #define	QMT_TYPEMASK	(QPAIR|QPERQ|QPERMOD|QMTSAFE|QMTOUTPERIM)
176 					/* all MT type flags		*/
177 #define	QINSERVICE	0x00010000	/* service routine executing	*/
178 #define	QWCLOSE		0x00020000	/* will not be enabled		*/
179 #define	QEND		0x00040000	/* last queue in stream		*/
180 #define	QWANTWSYNC	0x00080000	/* Streamhead wants to write Q	*/
181 #define	QSYNCSTR	0x00100000	/* Q supports Synchronous STREAMS */
182 #define	QISDRV		0x00200000	/* the Queue is attached to a driver */
183 /*	UNUSED		0x00400000	   was QHOT			*/
184 /*	UNUSED		0x00800000	   was QNEXTHOT			*/
185 /* 	UNUSED		0x01000000	   was _QNEXTLESS		*/
186 #define	_QINSERTING	0x04000000	/* Private, module is being inserted */
187 #define	_QREMOVING	0x08000000	/* Private, module is being removed */
188 #define	_QASSOCIATED	0x10000000	/* queue is associated with a device */
189 #define	_QDIRECT	0x20000000	/* Private; transport module uses */
190 					/* direct interface to/from sockfs */
191 #define	_QSODIRECT	0x40000000	/* Private, transport module shares */
192 					/* an sodirect_t with sockfs */
193 
194 /* queue sqflags (protected by SQLOCK). */
195 #define	Q_SQQUEUED	0x01		/* Queue is in the syncq list */
196 #define	Q_SQDRAINING	0x02		/* Servicing syncq msgs.	*/
197 					/* This is also noted by the	*/
198 					/* q_draining field, but this one is */
199 					/* protected by SQLOCK */
200 
201 /*
202  * Structure that describes the separate information
203  * for each priority band in the queue.
204  */
205 typedef struct qband {
206 	struct qband	*qb_next;	/* next band's info */
207 	size_t		qb_count;	/* number of bytes in band */
208 	struct msgb	*qb_first;	/* beginning of band's data */
209 	struct msgb	*qb_last;	/* end of band's data */
210 	size_t		qb_hiwat;	/* high water mark for band */
211 	size_t		qb_lowat;	/* low water mark for band */
212 	uint_t		qb_flag;	/* see below */
213 	size_t		qb_mblkcnt;	/* mblk counter for runaway msgs */
214 } qband_t;
215 
216 /*
217  * qband flags
218  */
219 #define	QB_FULL		0x01		/* band is considered full */
220 #define	QB_WANTW	0x02		/* Someone wants to write to band */
221 #define	QB_BACK		0x04		/* queue has been back-enabled */
222 
223 /*
224  * Maximum number of bands.
225  */
226 #define	NBAND	256
227 
228 /*
229  * Fields that can be manipulated through strqset() and strqget().
230  */
231 typedef enum qfields {
232 	QHIWAT	= 0,		/* q_hiwat or qb_hiwat */
233 	QLOWAT	= 1,		/* q_lowat or qb_lowat */
234 	QMAXPSZ	= 2,		/* q_maxpsz */
235 	QMINPSZ	= 3,		/* q_minpsz */
236 	QCOUNT	= 4,		/* q_count or qb_count */
237 	QFIRST	= 5,		/* q_first or qb_first */
238 	QLAST	= 6,		/* q_last or qb_last */
239 	QFLAG	= 7,		/* q_flag or qb_flag */
240 	QSTRUIOT = 8,		/* q_struiot */
241 	QBAD	= 9
242 } qfields_t;
243 
244 /*
245  * Module information structure
246  */
247 struct module_info {
248 	ushort_t mi_idnum;		/* module id number */
249 	char 	*mi_idname;		/* module name */
250 	ssize_t	mi_minpsz;		/* min packet size accepted */
251 	ssize_t	mi_maxpsz;		/* max packet size accepted */
252 	size_t	mi_hiwat;		/* hi-water mark */
253 	size_t 	mi_lowat;		/* lo-water mark */
254 };
255 
256 /*
257  * queue information structure (with Synchronous STREAMS extensions)
258  */
259 struct	qinit {
260 	int	(*qi_putp)();		/* put procedure */
261 	int	(*qi_srvp)();		/* service procedure */
262 	int	(*qi_qopen)();		/* called on startup */
263 	int	(*qi_qclose)();		/* called on finish */
264 	int	(*qi_qadmin)();		/* for future use */
265 	struct module_info *qi_minfo;	/* module information structure */
266 	struct module_stat *qi_mstat;	/* module statistics structure */
267 	int	(*qi_rwp)();		/* r/w procedure */
268 	int	(*qi_infop)();		/* information procedure */
269 	int	qi_struiot;		/* stream uio type for struio() */
270 };
271 
272 /*
273  * Values for qi_struiot and q_struiot:
274  */
275 #define	STRUIOT_NONE		-1	/* doesn't support struio() */
276 #define	STRUIOT_DONTCARE	0	/* use current uiomove() (default) */
277 #define	STRUIOT_STANDARD	1	/* use standard uiomove() */
278 
279 /*
280  * Streamtab (used in cdevsw and fmodsw to point to module or driver)
281  */
282 struct streamtab {
283 	struct qinit *st_rdinit;
284 	struct qinit *st_wrinit;
285 	struct qinit *st_muxrinit;
286 	struct qinit *st_muxwinit;
287 };
288 
289 /*
290  * Structure sent to mux drivers to indicate a link.
291  */
292 struct linkblk {
293 	queue_t *l_qtop;	/* lowest level write queue of upper stream */
294 				/* (set to NULL for persistent links) */
295 	queue_t *l_qbot;	/* highest level write queue of lower stream */
296 	int	l_index;	/* index for lower stream. */
297 };
298 
299 /*
300  * Esballoc data buffer freeing routine
301  */
302 typedef struct free_rtn {
303 	void	(*free_func)();
304 	caddr_t	free_arg;
305 } frtn_t;
306 
307 /*
308  * Data block descriptor
309  *
310  * NOTE: db_base, db_lim, db_ref and db_type are the *only* public fields,
311  * as described in datab(9S).  Everything else is implementation-private.
312  */
313 
314 #define	DBLK_REFMAX	255U
315 
316 typedef struct datab {
317 	frtn_t		*db_frtnp;
318 	unsigned char	*db_base;
319 	unsigned char	*db_lim;
320 	unsigned char	db_ref;
321 	unsigned char	db_type;
322 	unsigned char	db_flags;
323 	unsigned char	db_struioflag;
324 	pid_t		db_cpid;	/* cached pid, needs verification */
325 	void		*db_cache;	/* kmem cache descriptor */
326 	struct msgb	*db_mblk;
327 	void		(*db_free)(struct msgb *, struct datab *);
328 	void		(*db_lastfree)(struct msgb *, struct datab *);
329 	intptr_t	db_cksumstart;
330 	intptr_t	db_cksumend;
331 	intptr_t	db_cksumstuff;
332 	union {
333 		double enforce_alignment;
334 		unsigned char data[8];
335 		struct {
336 			union {
337 				uint32_t u32;
338 				uint16_t u16;
339 			} cksum_val;    /* used to store calculated cksum */
340 			uint16_t flags;
341 			uint16_t pad;
342 		} cksum;
343 		/*
344 		 * Union used for future extensions (pointer to data ?).
345 		 */
346 	} db_struioun;
347 	struct fthdr	*db_fthdr;
348 	cred_t		*db_credp;	/* credential */
349 } dblk_t;
350 
351 #define	db_cksum16	db_struioun.cksum.cksum_val.u16
352 #define	db_cksum32	db_struioun.cksum.cksum_val.u32
353 
354 /*
355  * Accessor macros for private dblk_t fields (the rest are in <sys/strsun.h>).
356  */
357 #define	DB_CPID(mp)		((mp)->b_datap->db_cpid)
358 #define	DB_CRED(mp)		((mp)->b_datap->db_credp)
359 #define	DB_CREDDEF(mp, cr)	(DB_CRED(mp) != NULL ? DB_CRED(mp) : (cr))
360 #define	DB_FTHDR(mp)		((mp)->b_datap->db_fthdr)
361 /*
362  * Used by GLDv2 to store the TCI information.
363  */
364 #define	DB_TCI(mp)		((mp)->b_datap->db_struioun.cksum.pad)
365 
366 #define	MBLK_GETLABEL(mp) \
367 	(DB_CRED(mp) != NULL ? crgetlabel(DB_CRED(mp)) : NULL)
368 
369 /*
370  * Message block descriptor
371  */
372 typedef struct	msgb {
373 	struct	msgb	*b_next;
374 	struct  msgb	*b_prev;
375 	struct	msgb	*b_cont;
376 	unsigned char	*b_rptr;
377 	unsigned char	*b_wptr;
378 	struct datab 	*b_datap;
379 	unsigned char	b_band;
380 	unsigned char	b_tag;
381 	unsigned short	b_flag;
382 	queue_t		*b_queue;	/* for sync queues */
383 } mblk_t;
384 
385 /*
386  * bcache descriptor
387  */
388 typedef	struct	bcache {
389 	kmutex_t		mutex;
390 	struct kmem_cache	*buffer_cache;
391 	struct kmem_cache	*dblk_cache;
392 	int			alloc;
393 	int			destroy;
394 	size_t			size;
395 	uint_t			align;
396 } bcache_t;
397 
398 /*
399  * db_flags values (all implementation private!)
400  */
401 #define	DBLK_REFMIN		0x01	/* min refcnt stored in low bit */
402 #define	DBLK_COOKED		0x02	/* message has been processed once */
403 #define	DBLK_UIOA		0x04	/* uioamove() is pending */
404 
405 /*
406  * db_struioflag values:
407  */
408 #define	STRUIO_SPEC	0x01	/* struio{get,put}() special mblk */
409 #define	STRUIO_DONE	0x02	/* struio done (could be partial) */
410 #define	STRUIO_IP	0x04	/* IP checksum stored in db_struioun */
411 #define	STRUIO_ZC	0x08	/* mblk eligible for zero-copy */
412 #define	STRUIO_ZCNOTIFY	0x10	/* notify stream head when mblk acked */
413 #define	STRUIO_EAGER	0x20	/* new eager; db_cksumstart has squeue to use */
414 #define	STRUIO_POLICY	0x40	/* new eager when IPsec is enabled */
415 #define	STRUIO_CONNECT	0x80	/* conn did a connect */
416 
417 /*
418  * Message flags.  These are interpreted by the stream head.
419  */
420 #define	MSGMARK		0x01	/* last byte of message is "marked" */
421 #define	MSGNOLOOP	0x02	/* don't loop message around to */
422 				/* write side of stream */
423 #define	MSGDELIM	0x04	/* message is delimited */
424 /*	UNUSED		0x08	   was MSGNOGET (can be recycled) */
425 #define	MSGMARKNEXT	0x10	/* Private: first byte of next msg marked */
426 #define	MSGNOTMARKNEXT	0x20	/* Private: ... not marked */
427 #define	MSGHASREF	0x40	/* Private: message has reference to owner */
428 #define	MSGWAITSYNC	0x80	/* Private: waiting for sync squeue enter */
429 
430 /*
431  * Streams message types.
432  */
433 
434 /*
435  * Data and protocol messages (regular and priority)
436  */
437 #define	M_DATA		0x00		/* regular data */
438 #define	M_PROTO		0x01		/* protocol control */
439 #define	M_MULTIDATA	0x02		/* reserved for Multidata use only */
440 
441 /*
442  * Control messages (regular and priority)
443  */
444 #define	M_BREAK		0x08		/* line break */
445 #define	M_PASSFP	0x09		/* pass file pointer */
446 #define	M_EVENT		0x0a		/* Obsoleted: do not use */
447 #define	M_SIG		0x0b		/* generate process signal */
448 #define	M_DELAY		0x0c		/* real-time xmit delay (1 param) */
449 #define	M_CTL		0x0d		/* device-specific control message */
450 #define	M_IOCTL		0x0e		/* ioctl; set/get params */
451 #define	M_SETOPTS	0x10		/* set various stream head options */
452 #define	M_RSE		0x11		/* reserved for RSE use only */
453 
454 /*
455  * Control messages (high priority; go to head of queue)
456  */
457 #define	M_IOCACK	0x81		/* acknowledge ioctl */
458 #define	M_IOCNAK	0x82		/* negative ioctl acknowledge */
459 #define	M_PCPROTO	0x83		/* priority proto message */
460 #define	M_PCSIG		0x84		/* generate process signal */
461 #define	M_READ		0x85		/* generate read notification */
462 #define	M_FLUSH		0x86		/* flush your queues */
463 #define	M_STOP		0x87		/* stop transmission immediately */
464 #define	M_START		0x88		/* restart transmission after stop */
465 #define	M_HANGUP	0x89		/* line disconnect */
466 #define	M_ERROR		0x8a		/* send error to stream head */
467 #define	M_COPYIN	0x8b		/* request to copyin data */
468 #define	M_COPYOUT	0x8c		/* request to copyout data */
469 #define	M_IOCDATA	0x8d		/* response to M_COPYIN and M_COPYOUT */
470 #define	M_PCRSE		0x8e		/* reserved for RSE use only */
471 #define	M_STOPI		0x8f		/* stop reception immediately */
472 #define	M_STARTI	0x90		/* restart reception after stop */
473 #define	M_PCEVENT	0x91		/* Obsoleted: do not use */
474 #define	M_UNHANGUP	0x92		/* line reconnect, sigh */
475 #define	M_CMD		0x93		/* out-of-band ioctl command */
476 
477 /*
478  * Queue message class definitions.
479  */
480 #define	QNORM		0x00		/* normal priority messages */
481 #define	QPCTL		0x80		/* high priority cntrl messages */
482 
483 /*
484  *  IOCTL structure - this structure is the format of the M_IOCTL message type.
485  */
486 #if	defined(_LP64)
487 struct iocblk {
488 	int 	ioc_cmd;		/* ioctl command type */
489 	cred_t	*ioc_cr;		/* full credentials */
490 	uint_t	ioc_id;			/* ioctl id */
491 	uint_t	ioc_flag;		/* see below */
492 	size_t	ioc_count;		/* count of bytes in data field */
493 	int	ioc_rval;		/* return value  */
494 	int	ioc_error;		/* error code */
495 };
496 #else
497 struct iocblk {
498 	int 	ioc_cmd;		/* ioctl command type */
499 	cred_t	*ioc_cr;		/* full credentials */
500 	uint_t	ioc_id;			/* ioctl id */
501 	size_t	ioc_count;		/* count of bytes in data field */
502 	int	ioc_error;		/* error code */
503 	int	ioc_rval;		/* return value  */
504 	int	ioc_fill1;
505 	uint_t	ioc_flag;		/* see below */
506 	int	ioc_filler[2];		/* reserved for future use */
507 };
508 #endif	/* _LP64 */
509 
510 typedef	struct iocblk	*IOCP;
511 
512 /* {ioc,cp}_flags values */
513 
514 #define	IOC_MODELS	DATAMODEL_MASK	/* Note: 0x0FF00000 */
515 #define	IOC_ILP32	DATAMODEL_ILP32	/* ioctl origin is ILP32 */
516 #define	IOC_LP64	DATAMODEL_LP64	/* ioctl origin is LP64 */
517 #define	IOC_NATIVE	DATAMODEL_NATIVE
518 #define	IOC_NONE	DATAMODEL_NONE	/* dummy comparison value */
519 
520 /*
521  *	Is the ioctl data formatted for our native model?
522  */
523 #define	IOC_CONVERT_FROM(iocp)	ddi_model_convert_from( \
524 				    ((struct iocblk *)iocp)->ioc_flag)
525 
526 /*
527  * structure for the M_COPYIN and M_COPYOUT message types.
528  */
529 #if	defined(_LP64)
530 struct copyreq {
531 	int	cq_cmd;			/* ioctl command (from ioc_cmd) */
532 	cred_t	*cq_cr;			/* full credentials (from ioc_cmd) */
533 	uint_t	cq_id;			/* ioctl id (from ioc_id) */
534 	uint_t	cq_flag;		/* must be zero */
535 	mblk_t	*cq_private;		/* private state information */
536 	caddr_t	cq_addr;		/* address to copy data to/from */
537 	size_t	cq_size;		/* number of bytes to copy */
538 };
539 #else
540 struct copyreq {
541 	int	cq_cmd;			/* ioctl command (from ioc_cmd) */
542 	cred_t	*cq_cr;			/* full credentials */
543 	uint_t	cq_id;			/* ioctl id (from ioc_id) */
544 	caddr_t	cq_addr;		/* address to copy data to/from */
545 	size_t	cq_size;		/* number of bytes to copy */
546 	uint_t	cq_flag;		/* must be zero */
547 	mblk_t	*cq_private;		/* private state information */
548 	int	cq_filler[4];		/* reserved for future use */
549 };
550 #endif	/* _LP64 */
551 
552 /*
553  * structure for the M_IOCDATA message type.
554  */
555 #if	defined(_LP64)
556 struct copyresp {
557 	int	cp_cmd;			/* ioctl command (from ioc_cmd) */
558 	cred_t	*cp_cr;			/* full credentials (from ioc_cmd) */
559 	uint_t	cp_id;			/* ioctl id (from ioc_id) */
560 	uint_t	cp_flag;		/* datamodel IOC_ flags; see above */
561 	mblk_t *cp_private;		/* private state information */
562 	caddr_t	cp_rval;		/* status of request: 0 -> success */
563 					/* 		non-zero -> failure */
564 };
565 #else
566 struct copyresp {
567 	int	cp_cmd;			/* ioctl command (from ioc_cmd) */
568 	cred_t	*cp_cr;			/* full credentials */
569 	uint_t	cp_id;			/* ioctl id (from ioc_id) */
570 	caddr_t	cp_rval;		/* status of request: 0 -> success */
571 					/* 		non-zero -> failure */
572 	size_t	cp_pad1;
573 	uint_t	cp_pad2;
574 	mblk_t *cp_private;		/* private state information */
575 	uint_t	cp_flag;		/* datamodel IOC_ flags; see above */
576 	int	cp_filler[3];
577 };
578 #endif	/* _LP64 */
579 
580 /*
581  * Since these structures are all intended to travel in the same message
582  * at different stages of a STREAMS ioctl, this union is used to determine
583  * the message size in strdoioctl().
584  */
585 union ioctypes {
586 	struct iocblk	iocblk;
587 	struct copyreq	copyreq;
588 	struct copyresp	copyresp;
589 };
590 
591 /*
592  * Options structure for M_SETOPTS message.  This is sent upstream
593  * by a module or driver to set stream head options.
594  */
595 struct stroptions {
596 	uint_t	so_flags;		/* options to set */
597 	short	so_readopt;		/* read option */
598 	ushort_t so_wroff;		/* write offset */
599 	ssize_t	so_minpsz;		/* minimum read packet size */
600 	ssize_t	so_maxpsz;		/* maximum read packet size */
601 	size_t	so_hiwat;		/* read queue high water mark */
602 	size_t	so_lowat;		/* read queue low water mark */
603 	unsigned char so_band;		/* band for water marks */
604 	ushort_t so_erropt;		/* error option */
605 	ssize_t	so_maxblk;		/* maximum message block size */
606 	ushort_t so_copyopt;		/* copy options (see stropts.h) */
607 	ushort_t so_tail;		/* space available at the end */
608 };
609 
610 /* flags for stream options set message */
611 
612 #define	SO_ALL		0x003f	/* set all old options */
613 #define	SO_READOPT	0x0001	/* set read option */
614 #define	SO_WROFF	0x0002	/* set write offset */
615 #define	SO_MINPSZ	0x0004	/* set min packet size */
616 #define	SO_MAXPSZ	0x0008	/* set max packet size */
617 #define	SO_HIWAT	0x0010	/* set high water mark */
618 #define	SO_LOWAT	0x0020	/* set low water mark */
619 #define	SO_MREADON	0x0040	/* set read notification ON */
620 #define	SO_MREADOFF	0x0080	/* set read notification OFF */
621 #define	SO_NDELON	0x0100	/* old TTY semantics for NDELAY reads/writes */
622 #define	SO_NDELOFF	0x0200	/* STREAMS semantics for NDELAY reads/writes */
623 #define	SO_ISTTY	0x0400	/* the stream is acting as a terminal */
624 #define	SO_ISNTTY	0x0800	/* the stream is not acting as a terminal */
625 #define	SO_TOSTOP	0x1000	/* stop on background writes to this stream */
626 #define	SO_TONSTOP	0x2000	/* do not stop on background writes to stream */
627 #define	SO_BAND		0x4000	/* water marks affect band */
628 #define	SO_DELIM	0x8000	/* messages are delimited */
629 #define	SO_NODELIM	0x010000	/* turn off delimiters */
630 #define	SO_STRHOLD	0x020000	/* No longer implemented */
631 #define	SO_ERROPT	0x040000	/* set error option */
632 #define	SO_COPYOPT	0x080000	/* copy option(s) present */
633 #define	SO_MAXBLK	0x100000	/* set maximum message block size */
634 #define	SO_TAIL		0x200000	/* set the extra allocated space */
635 
636 #ifdef _KERNEL
637 /*
638  * Structure for rw (read/write) procedure calls. A pointer
639  * to a struiod_t is passed as a parameter to the rwnext() call.
640  *
641  * Note: DEF_IOV_MAX is defined and used as it is in "fs/vncalls.c"
642  *	 as there isn't a formal definition of IOV_MAX ???
643  */
644 #define	DEF_IOV_MAX	16
645 
646 typedef struct struiod {
647 	mblk_t		*d_mp;		/* pointer to mblk (chain) */
648 	uio_t		d_uio;		/* uio info */
649 	iovec_t d_iov[DEF_IOV_MAX];	/* iov referenced by uio */
650 } struiod_t;
651 
652 /*
653  * Structure for information procedure calls.
654  */
655 typedef struct infod {
656 	unsigned char	d_cmd;		/* info info request command */
657 	unsigned char	d_res;		/* info info command results */
658 	int		d_bytes;	/* mblk(s) byte count */
659 	int		d_count;	/* count of mblk(s) */
660 	uio_t		*d_uiop;	/* pointer to uio struct */
661 } infod_t;
662 /*
663  * Values for d_cmd & d_res.
664  */
665 #define	INFOD_FIRSTBYTES	0x02	/* return msgbsize() of first mblk */
666 #define	INFOD_BYTES		0x04	/* return msgbsize() of all mblk(s) */
667 #define	INFOD_COUNT		0x08	/* return count of mblk(s) */
668 #define	INFOD_COPYOUT		0x10	/* copyout any M_DATA mblk(s) */
669 
670 /*
671  * Structure used by _I_CMD mechanism, similar in spirit to iocblk.
672  */
673 typedef struct cmdblk {
674 	int		cb_cmd;		/* ioctl command type */
675 	cred_t		*cb_cr;		/* full credentials */
676 	uint_t		cb_len;		/* payload size */
677 	int		cb_error;	/* error code */
678 } cmdblk_t;
679 
680 #endif /* _KERNEL */
681 
682 /*
683  * Miscellaneous parameters and flags.
684  */
685 
686 /*
687  * Values for stream flag in open to indicate module open, clone open,
688  * and the return value for failure.
689  */
690 #define	MODOPEN 	0x1		/* open as a module */
691 #define	CLONEOPEN	0x2		/* clone open; pick own minor dev */
692 #define	OPENFAIL	-1		/* returned for open failure */
693 
694 /*
695  * Priority definitions for block allocation.
696  */
697 #define	BPRI_LO		1
698 #define	BPRI_MED	2
699 #define	BPRI_HI		3
700 
701 /*
702  * Value for packet size that denotes infinity
703  */
704 #define	INFPSZ		-1
705 
706 /*
707  * Flags for flushq()
708  */
709 #define	FLUSHALL	1	/* flush all messages */
710 #define	FLUSHDATA	0	/* don't flush control messages */
711 
712 /*
713  * Flag for transparent ioctls
714  */
715 #define	TRANSPARENT	(unsigned int)(-1)
716 
717 /*
718  * Stream head default high/low water marks
719  */
720 #define	STRHIGH 5120
721 #define	STRLOW	1024
722 
723 /*
724  * qwriter perimeter types
725  */
726 #define	PERIM_INNER	1		/* The inner perimeter */
727 #define	PERIM_OUTER	2		/* The outer perimeter */
728 
729 /*
730  * Definitions of Streams macros and function interfaces.
731  */
732 
733 /*
734  * canenable - check if queue can be enabled by putq().
735  */
736 #define	canenable(q)	!((q)->q_flag & QNOENB)
737 
738 /*
739  * Test if data block type is one of the data messages (i.e. not a control
740  * message).
741  */
742 #define	datamsg(type) \
743 		((type) == M_DATA || \
744 		    (type) == M_MULTIDATA || \
745 		    (type) == M_PROTO || \
746 		    (type) == M_PCPROTO || \
747 		    (type) == M_DELAY)
748 
749 /*
750  * Extract queue class of message block.
751  */
752 #define	queclass(bp) (((bp)->b_datap->db_type >= QPCTL) ? QPCTL : QNORM)
753 
754 /*
755  * Align address on next lower word boundary.
756  */
757 #define	straln(a)	(caddr_t)((intptr_t)(a) & -(sizeof (int)-1))
758 
759 /*
760  * Find the max size of data block.
761  */
762 #define	bpsize(bp) ((unsigned int)(bp->b_datap->db_lim - bp->b_datap->db_base))
763 
764 #ifdef _KERNEL
765 
766 /*
767  * For two-byte M_ERROR messages: indication that a side does not have an error
768  */
769 #define	NOERROR	((unsigned char)-1)
770 
771 /*
772  * declarations of common routines
773  */
774 
775 extern mblk_t *allocb(size_t, uint_t);
776 extern mblk_t *desballoc(unsigned char *, size_t, uint_t, frtn_t *);
777 extern mblk_t *esballoc(unsigned char *, size_t, uint_t, frtn_t *);
778 extern bcache_t *bcache_create(char *, size_t, uint_t);
779 extern void bcache_destroy(bcache_t *);
780 extern mblk_t *bcache_allocb(bcache_t *, uint_t);
781 extern mblk_t *mkiocb(uint_t);
782 extern int testb(size_t, uint_t);
783 extern bufcall_id_t bufcall(size_t, uint_t, void (*)(void *), void *);
784 extern bufcall_id_t esbbcall(uint_t, void (*)(void *), void *);
785 extern void freeb(struct msgb *);
786 extern void freemsg(mblk_t *);
787 extern mblk_t *dupb(mblk_t *);
788 extern mblk_t *dupmsg(mblk_t *);
789 extern mblk_t *dupmsg_noloan(mblk_t *);
790 extern mblk_t *copyb(mblk_t *);
791 extern mblk_t *copymsg(mblk_t *);
792 extern void linkb(mblk_t *, mblk_t *);
793 extern mblk_t *unlinkb(mblk_t *);
794 extern mblk_t *reallocb(mblk_t *, size_t, uint_t);	/* private */
795 extern mblk_t *rmvb(mblk_t *, mblk_t *);
796 extern int pullupmsg(struct msgb *, ssize_t);
797 extern mblk_t *msgpullup(struct msgb *, ssize_t);
798 extern int adjmsg(struct msgb *, ssize_t);
799 extern size_t msgdsize(struct msgb *);
800 extern mblk_t *getq(queue_t *);
801 extern void rmvq(queue_t *, mblk_t *);
802 extern void flushq(queue_t *, int);
803 extern void flushq_common(queue_t *, int, int);
804 extern void flushband(queue_t *, unsigned char, int);
805 extern int canput(queue_t *);
806 extern int bcanput(queue_t *, unsigned char);
807 extern int canputnext(queue_t *);
808 extern int bcanputnext(queue_t *, unsigned char);
809 extern int putq(queue_t *, mblk_t *);
810 extern int putbq(queue_t *, mblk_t *);
811 extern int insq(queue_t *, mblk_t *, mblk_t *);
812 extern void put(queue_t *, mblk_t *);
813 extern void putnext(queue_t *, mblk_t *);
814 extern int putctl(queue_t *, int);
815 extern int putctl1(queue_t *, int, int);
816 extern int putnextctl(queue_t *, int);
817 extern int putnextctl1(queue_t *, int, int);
818 extern queue_t *backq(queue_t *);
819 extern void qreply(queue_t *, mblk_t *);
820 extern void qenable(queue_t *);
821 extern int qsize(queue_t *);
822 extern void noenable(queue_t *);
823 extern void enableok(queue_t *);
824 extern int strqset(queue_t *, qfields_t, unsigned char, intptr_t);
825 extern int strqget(queue_t *, qfields_t, unsigned char, void *);
826 extern void unbufcall(bufcall_id_t);
827 extern void qprocson(queue_t *);
828 extern void qprocsoff(queue_t *);
829 extern void freezestr(queue_t *);
830 extern void unfreezestr(queue_t *);
831 extern void qwait(queue_t *);
832 extern int qwait_sig(queue_t *);
833 extern boolean_t qwait_rw(queue_t *);
834 extern void qwriter(queue_t *, mblk_t *, void (*func)(), int);
835 extern timeout_id_t qtimeout(queue_t *, void (*func)(void *), void *, clock_t);
836 extern bufcall_id_t qbufcall(queue_t *, size_t, uint_t,
837     void (*)(void *), void *);
838 extern clock_t quntimeout(queue_t *, timeout_id_t);
839 extern void qunbufcall(queue_t *, bufcall_id_t);
840 extern void strwakeq(queue_t *, int);
841 extern int struioget(queue_t *, mblk_t *, struiod_t *, int);
842 extern int rwnext(queue_t *, struiod_t *);
843 extern int infonext(queue_t *, infod_t *);
844 extern int isuioq(queue_t *);
845 extern void create_putlocks(queue_t *, int);
846 extern int mp_cont_len(mblk_t *, int *);
847 
848 /*
849  * shared or externally configured data structures
850  */
851 extern int nstrpush;			/* maximum number of pushes allowed */
852 
853 #endif /* _KERNEL */
854 
855 #ifdef	__cplusplus
856 }
857 #endif
858 
859 #endif	/* _SYS_STREAM_H */
860