robin.thoni
/
ipxe
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 11 Wiki Activity
Browse Source

Add start() event 

Add "xfer" to all xfer functions and "job" to all job functions.
tags/v0.9.3
Michael Brown 17 years ago
parent
a90a9adbd7
commit
e3dcb9a1ad
4 changed files with 136 additions and 61 deletions
Split View Show Diff Stats
  1. 14
    8
      src/core/job.c
  2. 39
    26
      src/core/xfer.c
  3. 42
    5
      src/include/gpxe/job.h
  4. 41
    22
      src/include/gpxe/xfer.h

+ 14
- 8
src/core/job.c View File 

@@ -26,10 +26,11 @@
26 26 
  *
27 27 
  */
28 28
29 
-void done ( struct job_interface *job, int rc ) {
29 
+void job_done ( struct job_interface *job, int rc ) {
30 30 
 	struct job_interface *dest = job_dest ( job );
31 31
32 32 
 	dest->op->done ( dest, rc );
33 
+	job_unplug ( job );
33 34 
 }
34 35
35 36 
 /****************************************************************************
 
@@ -41,24 +42,29 @@ void done ( struct job_interface *job, int rc ) {
41 42 
  *
42 43 
  */
43 44
44 
-void ignore_done ( struct job_interface *job __unused, int rc __unused ) {
45 
+void ignore_job_start ( struct job_interface *job __unused ) {
45 46 
 	/* Nothing to do */
46 47 
 }
47 48
48 
-void ignore_kill ( struct job_interface *job __unused ) {
49 
+void ignore_job_done ( struct job_interface *job __unused, int rc __unused ) {
49 50 
 	/* Nothing to do */
50 51 
 }
51 52
52 
-void ignore_progress ( struct job_interface *job __unused,
53 
-		       struct job_progress *progress ) {
53 
+void ignore_job_kill ( struct job_interface *job __unused ) {
54 
+	/* Nothing to do */
55 
+}
56 
+
57 
+void ignore_job_progress ( struct job_interface *job __unused,
58 
+			   struct job_progress *progress ) {
54 59 
 	memset ( progress, 0, sizeof ( *progress ) );
55 60 
 }
56 61
57 62 
 /** Null job control interface operations */
58 63 
 struct job_interface_operations null_job_ops = {
59 
-	.done		= ignore_done,
60 
-	.kill		= ignore_kill,
61 
-	.progress	= ignore_progress,
64 
+	.start		= ignore_job_start,
65 
+	.done		= ignore_job_done,
66 
+	.kill		= ignore_job_kill,
67 
+	.progress	= ignore_job_progress,
62 68 
 };
63 69
64 70 
 /**

+ 39
- 26
src/core/xfer.c View File 

@@ -32,7 +32,7 @@
32 32 
  * @v xfer		Data transfer interface
33 33 
  * @v rc		Reason for close
34 34 
  */
35 
-void close ( struct xfer_interface *xfer, int rc ) {
35 
+void xfer_close ( struct xfer_interface *xfer, int rc ) {
36 36 
 	struct xfer_interface *dest = xfer_dest ( xfer );
37 37
38 38 
 	dest->op->close ( dest, rc );
 
@@ -46,7 +46,7 @@ void close ( struct xfer_interface *xfer, int rc ) {
46 46 
  * @v pos		New position
47 47 
  * @ret rc		Return status code
48 48 
  */
49 
-int seek ( struct xfer_interface *xfer, size_t pos ) {
49 
+int xfer_seek ( struct xfer_interface *xfer, size_t pos ) {
50 50 
 	struct xfer_interface *dest = xfer_dest ( xfer );
51 51
52 52 
 	return dest->op->seek ( dest, pos );
 
@@ -60,7 +60,7 @@ int seek ( struct xfer_interface *xfer, size_t pos ) {
60 60 
  * @v args		Remaining arguments depend upon location type
61 61 
  * @ret rc		Return status code
62 62 
  */
63 
-int vredirect ( struct xfer_interface *xfer, int type, va_list args ) {
63 
+int xfer_vredirect ( struct xfer_interface *xfer, int type, va_list args ) {
64 64 
 	struct xfer_interface *dest = xfer_dest ( xfer );
65 65
66 66 
 	return dest->op->vredirect ( dest, type, args );
 
@@ -74,12 +74,12 @@ int vredirect ( struct xfer_interface *xfer, int type, va_list args ) {
74 74 
  * @v ...		Remaining arguments depend upon location type
75 75 
  * @ret rc		Return status code
76 76 
  */
77 
-int redirect ( struct xfer_interface *xfer, int type, ... ) {
77 
+int xfer_redirect ( struct xfer_interface *xfer, int type, ... ) {
78 78 
 	va_list args;
79 79 
 	int rc;
80 80
81 81 
 	va_start ( args, type );
82 
-	rc = vredirect ( xfer, type, args );
82 
+	rc = xfer_vredirect ( xfer, type, args );
83 83 
 	va_end ( args );
84 84 
 	return rc;
85 85 
 }
 
@@ -91,7 +91,7 @@ int redirect ( struct xfer_interface *xfer, int type, ... ) {
91 91 
  * @v iobuf		Datagram I/O buffer
92 92 
  * @ret rc		Return status code
93 93 
  */
94 
-int deliver ( struct xfer_interface *xfer, struct io_buffer *iobuf ) {
94 
+int xfer_deliver ( struct xfer_interface *xfer, struct io_buffer *iobuf ) {
95 95 
 	struct xfer_interface *dest = xfer_dest ( xfer );
96 96
97 97 
 	return dest->op->deliver ( dest, iobuf );
 
@@ -104,7 +104,8 @@ int deliver ( struct xfer_interface *xfer, struct io_buffer *iobuf ) {
104 104 
  * @v iobuf		Datagram I/O buffer
105 105 
  * @ret rc		Return status code
106 106 
  */
107 
-int deliver_raw ( struct xfer_interface *xfer, const void *data, size_t len ) {
107 
+int xfer_deliver_raw ( struct xfer_interface *xfer,
108 
+		       const void *data, size_t len ) {
108 109 
 	struct xfer_interface *dest = xfer_dest ( xfer );
109 110
110 111 
 	return dest->op->deliver_raw ( dest, data, len );
 
@@ -120,36 +121,47 @@ int deliver_raw ( struct xfer_interface *xfer, const void *data, size_t len ) {
120 121 
  */
121 122
122 123 
 /**
123 
- * Ignore close()
124 
+ * Ignore start() event
125 
+ *
126 
+ * @v xfer		Data transfer interface
127 
+ */
128 
+void ignore_xfer_start ( struct xfer_interface *xfer __unused ) {
129 
+	/* Nothing to do */
130 
+}
131 
+
132 
+/**
133 
+ * Ignore close() event
124 134 
  *
125 135 
  * @v xfer		Data transfer interface
126 136 
  * @v rc		Reason for close
127 137 
  */
128 
-void ignore_close ( struct xfer_interface *xfer __unused, int rc __unused ) {
138 
+void ignore_xfer_close ( struct xfer_interface *xfer __unused,
139 
+			 int rc __unused ) {
129 140 
 	/* Nothing to do */
130 141 
 }
131 142
132 143 
 /**
133 
- * Ignore vredirect()
144 
+ * Ignore vredirect() event
134 145 
  *
135 146 
  * @v xfer		Data transfer interface
136 147 
  * @v type		New location type
137 148 
  * @v args		Remaining arguments depend upon location type
138 149 
  * @ret rc		Return status code
139 150 
  */
140 
-int ignore_vredirect ( struct xfer_interface *xfer __unused,
141 
-		       int type __unused, va_list args __unused ) {
151 
+int ignore_xfer_vredirect ( struct xfer_interface *xfer __unused,
152 
+			    int type __unused, va_list args __unused ) {
142 153 
 	return 0;
143 154 
 }
144 155
145 156 
 /**
146 
- * Ignore seek()
157 
+ * Ignore seek() event
147 158 
  *
148 159 
  * @v xfer		Data transfer interface
149 160 
  * @v pos		New position
150 161 
  * @ret rc		Return status code
151 162 
  */
152 
-int ignore_seek ( struct xfer_interface *xfer __unused, size_t pos __unused ) {
163 
+int ignore_xfer_seek ( struct xfer_interface *xfer __unused,
164 
+		       size_t pos __unused ) {
153 165 
 	return 0;
154 166 
 }
155 167 
 
@@ -163,8 +175,8 @@ int ignore_seek ( struct xfer_interface *xfer __unused, size_t pos __unused ) {
163 175 
  * This function is intended to be used as the deliver() method for
164 176 
  * data transfer interfaces that prefer to handle raw data.
165 177 
  */
166 
-int deliver_as_raw ( struct xfer_interface *xfer,
167 
-		     struct io_buffer *iobuf ) {
178 
+int xfer_deliver_as_raw ( struct xfer_interface *xfer,
179 
+			  struct io_buffer *iobuf ) {
168 180 
 	int rc;
169 181
170 182 
 	rc = xfer->op->deliver_raw ( xfer, iobuf->data, iob_len ( iobuf ) );
 
@@ -183,8 +195,8 @@ int deliver_as_raw ( struct xfer_interface *xfer,
183 195 
  * This function is intended to be used as the deliver_raw() method
184 196 
  * for data transfer interfaces that prefer to handle I/O buffers.
185 197 
  */
186 
-int deliver_as_iobuf ( struct xfer_interface *xfer,
187 
-		       const void *data, size_t len ) {
198 
+int xfer_deliver_as_iobuf ( struct xfer_interface *xfer,
199 
+			    const void *data, size_t len ) {
188 200 
 	struct io_buffer *iobuf;
189 201
190 202 
 	iobuf = alloc_iob ( len );
 
@@ -196,15 +208,15 @@ int deliver_as_iobuf ( struct xfer_interface *xfer,
196 208 
 }
197 209
198 210 
 /**
199 
- * Ignore datagram as raw data
211 
+ * Ignore datagram as raw data event
200 212 
  *
201 213 
  * @v xfer		Data transfer interface
202 214 
  * @v data		Data buffer
203 215 
  * @v len		Length of data buffer
204 216 
  * @ret rc		Return status code
205 217 
  */
206 
-int ignore_deliver_raw ( struct xfer_interface *xfer,
207 
-			 const void *data __unused, size_t len ) {
218 
+int ignore_xfer_deliver_raw ( struct xfer_interface *xfer,
219 
+			      const void *data __unused, size_t len ) {
208 220 
 	DBGC ( xfer, "XFER %p %zd bytes delivered %s\n", xfer, len,
209 221 
 	       ( ( xfer == &null_xfer ) ?
210 222 
 		 "before connection" : "after termination" ) );
 
@@ -213,11 +225,12 @@ int ignore_deliver_raw ( struct xfer_interface *xfer,
213 225
214 226 
 /** Null data transfer interface operations */
215 227 
 struct xfer_interface_operations null_xfer_ops = {
216 
-	.close		= ignore_close,
217 
-	.vredirect	= ignore_vredirect,
218 
-	.seek		= ignore_seek,
219 
-	.deliver	= deliver_as_raw,
220 
-	.deliver_raw	= ignore_deliver_raw,
228 
+	.start		= ignore_xfer_start,
229 
+	.close		= ignore_xfer_close,
230 
+	.vredirect	= ignore_xfer_vredirect,
231 
+	.seek		= ignore_xfer_seek,
232 
+	.deliver	= xfer_deliver_as_raw,
233 
+	.deliver_raw	= ignore_xfer_deliver_raw,
221 234 
 };
222 235
223 236 
 /**

+ 42
- 5
src/include/gpxe/job.h View File 

@@ -33,6 +33,11 @@ struct job_interface;
33 33
34 34 
 /** Job control interface operations */
35 35 
 struct job_interface_operations {
36 
+	/** Start job
37 
+	 *
38 
+	 * @v job		Job control interface
39 
+	 */
40 
+	void ( * start ) ( struct job_interface *job );
36 41 
 	/** Job completed
37 42 
 	 *
38 43 
 	 * @v job		Job control interface
 
@@ -64,12 +69,13 @@ struct job_interface {
64 69 
 extern struct job_interface null_job;
65 70 
 extern struct job_interface_operations null_job_ops;
66 71
67 
-extern void done ( struct job_interface *job, int rc );
72 
+extern void job_done ( struct job_interface *job, int rc );
68 73
69 
-extern void ignore_done ( struct job_interface *job, int rc );
70 
-extern void ignore_kill ( struct job_interface *job );
71 
-extern void ignore_progress ( struct job_interface *job,
72 
-			      struct job_progress *progress );
74 
+extern void ignore_job_start ( struct job_interface *job );
75 
+extern void ignore_job_done ( struct job_interface *job, int rc );
76 
+extern void ignore_job_kill ( struct job_interface *job );
77 
+extern void ignore_job_progress ( struct job_interface *job,
78 
+				  struct job_progress *progress );
73 79
74 80 
 /**
75 81 
  * Initialise a job control interface
 
@@ -108,6 +114,37 @@ job_dest ( struct job_interface *job ) {
108 114 
 	return intf_to_job ( job->intf.dest );
109 115 
 }
110 116
117 
+/**
118 
+ * Plug a job control interface into a new destination interface
119 
+ *
120 
+ * @v job		Job control interface
121 
+ * @v dest		New destination interface
122 
+ */
123 
+static inline void job_plug ( struct job_interface *job,
124 
+			       struct job_interface *dest ) {
125 
+	plug ( &job->intf, &dest->intf );
126 
+}
127 
+
128 
+/**
129 
+ * Plug two job control interfaces together
130 
+ *
131 
+ * @v a			Job control interface A
132 
+ * @v b			Job control interface B
133 
+ */
134 
+static inline void job_plug_plug ( struct job_interface *a,
135 
+				    struct job_interface *b ) {
136 
+	plug_plug ( &a->intf, &b->intf );
137 
+}
138 
+
139 
+/**
140 
+ * Unplug a job control interface
141 
+ *
142 
+ * @v job		Job control interface
143 
+ */
144 
+static inline void job_unplug ( struct job_interface *job ) {
145 
+	plug ( &job->intf, &null_job.intf );
146 
+}
147 
+
111 148 
 /**
112 149 
  * Stop using a job control interface
113 150 
  *

+ 41
- 22
src/include/gpxe/xfer.h View File 

@@ -21,15 +21,17 @@ struct xfer_interface_operations {
21 21 
 	 *
22 22 
 	 * notification of non-close status - e.g. connected/opened, ...
23 23 
 	 *
24 
-	 * seek
25 
-	 *
26 24 
 	 * prompt for data delivery
27 25 
 	 *
28 26 
 	 * I/O buffer preparation
29 27 
 	 *
30 28 
 	 */
31 29
32 
-
30 
+	/** Start data transfer
31 
+	 *
32 
+	 * @v xfer		Data transfer interface
33 
+	 */
34 
+	void ( * start ) ( struct xfer_interface *xfer );
33 35 
 	/** Close interface
34 36 
 	 *
35 37 
 	 * @v xfer		Data transfer interface
 
@@ -60,7 +62,7 @@ struct xfer_interface_operations {
60 62 
 	 *
61 63 
 	 * A data transfer interface that wishes to support only raw
62 64 
 	 * data delivery should set this method to
63 
-	 * deliver_as_raw().
65 
+	 * xfer_deliver_as_raw().
64 66 
 	 */
65 67 
 	int ( * deliver ) ( struct xfer_interface *xfer,
66 68 
 			    struct io_buffer *iobuf );
 
@@ -73,7 +75,7 @@ struct xfer_interface_operations {
73 75 
 	 *
74 76 
 	 * A data transfer interface that wishes to support only I/O
75 77 
 	 * buffer delivery should set this method to
76 
-	 * deliver_as_iobuf().
78 
+	 * xfer_deliver_as_iobuf().
77 79 
 	 */
78 80 
 	int ( * deliver_raw ) ( struct xfer_interface *xfer,
79 81 
 				const void *data, size_t len );
 
@@ -90,24 +92,30 @@ struct xfer_interface {
90 92 
 extern struct xfer_interface null_xfer;
91 93 
 extern struct xfer_interface_operations null_xfer_ops;
92 94
93 
-extern void close ( struct xfer_interface *xfer, int rc );
94 
-extern int seek ( struct xfer_interface *xfer, size_t pos );
95 
-extern int vredirect ( struct xfer_interface *xfer, int type, va_list args );
96 
-extern int redirect ( struct xfer_interface *xfer, int type, ... );
97 
-extern int deliver ( struct xfer_interface *xfer, struct io_buffer *iobuf );
98 
-extern int deliver_raw ( struct xfer_interface *xfer,
99 
-			 const void *data, size_t len );
100 
-
101 
-extern void ignore_close ( struct xfer_interface *xfer, int rc );
102 
-extern int ignore_vredirect ( struct xfer_interface *xfer,
103 
-			      int type, va_list args );
104 
-extern int ignore_seek ( struct xfer_interface *xfer, size_t pos );
105 
-extern int deliver_as_raw ( struct xfer_interface *xfer,
106 
-			    struct io_buffer *iobuf );
107 
-extern int deliver_as_iobuf ( struct xfer_interface *xfer,
95 
+extern void xfer_start ( struct xfer_interface *xfer );
96 
+extern void xfer_close ( struct xfer_interface *xfer, int rc );
97 
+extern int xfer_seek ( struct xfer_interface *xfer, size_t pos );
98 
+extern int xfer_vredirect ( struct xfer_interface *xfer, int type,
99 
+			    va_list args );
100 
+extern int xfer_redirect ( struct xfer_interface *xfer, int type, ... );
101 
+extern int xfer_deliver ( struct xfer_interface *xfer,
102 
+			  struct io_buffer *iobuf );
103 
+extern int xfer_deliver_raw ( struct xfer_interface *xfer,
108 104 
 			      const void *data, size_t len );
109 
-extern int ignore_deliver_raw ( struct xfer_interface *xfer,
110 
-				const void *data __unused, size_t len );
105 
+
106 
+extern void ignore_xfer_start ( struct xfer_interface *xfer );
107 
+extern void ignore_xfer_close ( struct xfer_interface *xfer, int rc );
108 
+extern int ignore_xfer_vredirect ( struct xfer_interface *xfer,
109 
+				   int type, va_list args );
110 
+extern int default_xfer_vredirect ( struct xfer_interface *xfer,
111 
+				    int type, va_list args );
112 
+extern int ignore_xfer_seek ( struct xfer_interface *xfer, size_t pos );
113 
+extern int xfer_deliver_as_raw ( struct xfer_interface *xfer,
114 
+				 struct io_buffer *iobuf );
115 
+extern int xfer_deliver_as_iobuf ( struct xfer_interface *xfer,
116 
+				   const void *data, size_t len );
117 
+extern int ignore_xfer_deliver_raw ( struct xfer_interface *xfer,
118 
+				     const void *data __unused, size_t len );
111 119
112 120 
 /**
113 121 
  * Initialise a data transfer interface
 
@@ -157,6 +165,17 @@ static inline void xfer_plug ( struct xfer_interface *xfer,
157 165 
 	plug ( &xfer->intf, &dest->intf );
158 166 
 }
159 167
168 
+/**
169 
+ * Plug two data transfer interfaces together
170 
+ *
171 
+ * @v a			Data transfer interface A
172 
+ * @v b			Data transfer interface B
173 
+ */
174 
+static inline void xfer_plug_plug ( struct xfer_interface *a,
175 
+				    struct xfer_interface *b ) {
176 
+	plug_plug ( &a->intf, &b->intf );
177 
+}
178 
+
160 179 
 /**
161 180 
  * Unplug a data transfer interface
162 181 
  *

Write Preview
Loading…
Cancel
Save