xref: /onnv-gate/usr/src/cmd/filebench/common/flowop.h (revision 6701:4213fadfdec4)
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 #ifndef	_FB_FLOWOP_H
27 #define	_FB_FLOWOP_H
28 
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include "config.h"
33 
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <unistd.h>
37 #include <sys/stat.h>
38 #include <sys/types.h>
39 #include <sys/param.h>
40 #include <sys/resource.h>
41 #include <pthread.h>
42 #ifndef HAVE_SYSV_SEM
43 #include <semaphore.h>
44 #endif
45 #include "stats.h"
46 #include "threadflow.h"
47 #include "vars.h"
48 #include "fileset.h"
49 #include "filebench.h"
50 
51 #ifdef	__cplusplus
52 extern "C" {
53 #endif
54 
55 typedef struct flowop {
56 	char		fo_name[128];	/* Name */
57 	int		fo_instance;	/* Instance number */
58 	struct flowop	*fo_next;	/* Next in global list */
59 	struct flowop	*fo_exec_next;	/* Next in thread's or compfo's list */
60 	struct flowop	*fo_resultnext;	/* List of flowops in result */
61 	struct flowop	*fo_comp_fops;	/* List of flowops in composite fo */
62 	var_t		*fo_lvar_list;	/* List of composite local vars */
63 	struct threadflow *fo_thread;	/* Backpointer to thread */
64 	int		(*fo_func)();	/* Method */
65 	int		(*fo_init)();	/* Init Method */
66 	void		(*fo_destruct)(); /* Destructor Method */
67 	int		fo_type;	/* Type */
68 	int		fo_attrs;	/* Flow op attribute */
69 	avd_t		fo_filename;	/* file/fileset name */
70 	fileset_t	*fo_fileset;	/* Fileset for op */
71 	int		fo_fd;		/* File descriptor */
72 	int		fo_fdnumber;	/* User specified file descriptor */
73 	int		fo_srcfdnumber;	/* User specified src file descriptor */
74 	fbint_t		fo_constvalue;	/* constant version of fo_value */
75 	fbint_t		fo_constwss;	/* constant version of fo_wss */
76 	avd_t		fo_iosize;	/* Size of operation */
77 	avd_t		fo_wss;		/* Flow op working set size */
78 	char		fo_targetname[128]; /* Target, for wakeup etc... */
79 	struct flowop	*fo_targets;	/* List of targets matching name */
80 	struct flowop	*fo_targetnext;	/* List of targets matching name */
81 	avd_t		fo_iters;	/* Number of iterations of op */
82 	avd_t		fo_value;	/* Attr */
83 	avd_t		fo_sequential;	/* Attr */
84 	avd_t		fo_random;	/* Attr */
85 	avd_t		fo_stride;	/* Attr */
86 	avd_t		fo_backwards;	/* Attr */
87 	avd_t		fo_dsync;	/* Attr */
88 	avd_t		fo_blocking;	/* Attr */
89 	avd_t		fo_directio;	/* Attr */
90 	avd_t		fo_rotatefd;	/* Attr */
91 	flowstat_t	fo_stats;	/* Flow statistics */
92 	pthread_cond_t	fo_cv;		/* Block/wakeup cv */
93 	pthread_mutex_t	fo_lock;	/* Mutex around flowop */
94 	void		*fo_private;	/* Flowop private scratch pad area */
95 	char		*fo_buf;	/* Per-flowop buffer */
96 	uint64_t	fo_buf_size;	/* current size of buffer */
97 #ifdef HAVE_SYSV_SEM
98 	int		fo_semid_lw;	/* sem id */
99 	int		fo_semid_hw;	/* sem id for highwater block */
100 #else
101 	sem_t		fo_sem;		/* sem_t for posix semaphores */
102 #endif /* HAVE_SYSV_SEM */
103 	avd_t		fo_highwater;	/* value of highwater paramter */
104 	void		*fo_idp;	/* id, for sems etc */
105 	hrtime_t	fo_timestamp;	/* for ratecontrol, etc... */
106 	int		fo_initted;	/* Set to one if initialized */
107 	int64_t		fo_tputbucket;	/* Throughput bucket, for limiter */
108 	uint64_t	fo_tputlast;	/* Throughput count, for delta's */
109 
110 } flowop_t;
111 
112 /* Flow Op Attrs */
113 #define	FLOW_ATTR_SEQUENTIAL	0x1
114 #define	FLOW_ATTR_RANDOM	0x2
115 #define	FLOW_ATTR_STRIDE	0x4
116 #define	FLOW_ATTR_BACKWARDS	0x8
117 #define	FLOW_ATTR_DSYNC		0x10
118 #define	FLOW_ATTR_BLOCKING	0x20
119 #define	FLOW_ATTR_DIRECTIO	0x40
120 #define	FLOW_ATTR_READ		0x80
121 #define	FLOW_ATTR_WRITE		0x100
122 
123 /* Flowop Instance Numbers */
124 			    /* Worker flowops have instance numbers > 0 */
125 #define	FLOW_DEFINITION 0   /* Prototype definition of flowop from library */
126 #define	FLOW_INNER_DEF -1   /* Constructed proto flowops within composite */
127 #define	FLOW_MASTER -2	    /* Master flowop based on flowop declaration */
128 			    /* supplied within a thread definition */
129 
130 /* Flowop type definitions */
131 
132 #define	FLOW_TYPES	6
133 #define	FLOW_TYPE_GLOBAL	0  /* Rolled up statistics */
134 #define	FLOW_TYPE_IO		1  /* Op is an I/O, reflected in iops and lat */
135 #define	FLOW_TYPE_AIO		2  /* Op is an async I/O, reflected in iops */
136 #define	FLOW_TYPE_SYNC		3  /* Op is a sync event */
137 #define	FLOW_TYPE_COMPOSITE	4  /* Op is a composite flowop */
138 #define	FLOW_TYPE_OTHER		5  /* Op is a something else */
139 
140 extern flowstat_t controlstats;
141 extern pthread_mutex_t controlstats_lock;
142 
143 void flowop_init(void);
144 flowop_t *flowop_define(threadflow_t *, char *name, flowop_t *inherit,
145     flowop_t **flowoplist_hdp, int instance, int type);
146 flowop_t *flowop_find(char *name);
147 flowop_t *flowop_find_one(char *name, int instance);
148 flowop_t *flowop_find_from_list(char *name, flowop_t *list);
149 void flowoplib_usage(void);
150 void flowoplib_init(void);
151 void flowop_delete_all(flowop_t **threadlist);
152 void flowop_endop(threadflow_t *threadflow, flowop_t *flowop, int64_t bytes);
153 void flowop_beginop(threadflow_t *threadflow, flowop_t *flowop);
154 void flowop_destruct_all_flows(threadflow_t *threadflow);
155 flowop_t *flowop_new_composite_define(char *name);
156 void flowop_printall(void);
157 
158 #ifdef	__cplusplus
159 }
160 #endif
161 
162 #endif	/* _FB_FLOWOP_H */
163