1 karl 1.1.2.1 Using the CIM/XML Pull Operations
2
3 STATUS
4
|
5 karl 1.1.2.4 <<< The TODO section is being maintained during the review and checkin process
|
6 karl 1.1.2.1 to keep track of problems, errors, notes, etc. Must be deleted before
7 checkin to head of tree. Please feel free to add notes, etc in this
8 section as you review/test.>>>>>>
9
|
10 karl 1.1.2.4 TODO list:
|
11 karl 1.1.2.3 1. Binary operation from OOP. Need to add counter to binary
12 protocol to be able to count objects in response. Generates
13 warnings in things like messageserializer and does not work with
14 OOP right now.
|
15 karl 1.1.2.4 2. OpenExecQuery - Code is incorrect in that it used InstancesWithPath
16 where the spec is instances with no path. Need new function to wrap
17 getInstanceElement(withoutPathElement) in XmlReader. Note that
18 Alternate is to put flag on InstancesWith Path to say no path
19 3. Code for Pull part of OpenQueryInstancesRequest a) should be part of
20 the common CIMOperationRequestDispatcher execCommon code.
21 4. The changes to WQLCIMOperationRequestDispatcher and CQL... for handling
22 pull not completed so we feed the responses back to the EnmerationContext
23 queues
|
24 karl 1.1.2.7 3. Lots of minor TODOs, diagnostics, etc.
|
25 karl 1.1.2.12 4. External runtime variables. Proposing that they be fixed for this release.
|
26 karl 1.1.2.3 5. Decision on EnumerationContext timeout (separate thread or just
|
27 karl 1.1.2.4 checks during other operations). Can we, in fact really keep the
28 enumeration context table and queue under control without monitoring
29 with a separate thread. We must monitor for:
30 a. Client operation that stop requesting (i.e. inter operation time
31 exceeds operationTimeout). Note that if it simply exceeds the time
32 the next operation does the cleanup. The issue is those clients that
33 simply stop and do not either close or go to completion.
34 b. We should protect against providers that no not every finish delivering
35 or take to long between deliveries. This does not exist in Pegasus
36 today
|
37 karl 1.1.2.8 6. Clean up code in Dispatcher. Want to at least reduce the code for the
38 Open Operations to a set of templates so we know that the code is the
|
39 karl 1.1.2.12 same for all operations. Most of the common code for the enum, assoc,
40 ref operations and their corresponding open/pull operations is now in a
41 set of template functions so that it is largely common code. Used the
42 templates where there is common code but not the same CIMMessage. However,
43 we should be able to do some of it with common functions (i.e. not templates)
44 by adding a layer to CIMMessage hiearchy and reduce code size. The
|
45 karl 1.1.2.8 pull is a single template for both pullInstances and pullInstancePaths.
46 However, we might be able to reduce this to a single function by adding
47 a new level to CIMMessage.h (CommonPullResponse)
|
48 karl 1.1.2.3 7. Extension to avoid double move of objects in CIMResponseData (one
49 into enumerationContext queue and second to new cimResponseData for
50 response. Want to avoid second move by extending Open/Pull response
51 messages to include count and CIMResponse data to count objects out
52 of queue when converting (avoids the second move). Big issue here
53 with binary data since need to extend format to count it.
|
54 karl 1.1.2.8 8. NEXT TASKS:
55 a. get the pull operations rather than a template into a single
56 function by creating a new CIMPullResponse message in CIMMessage.h that
57 contains the pull data. Then we can use a single function to process all
58 pull operations.
|
59 karl 1.1.2.9 b. test the enumeration timeout thread
|
60 karl 1.1.2.11 d. Sort out issues with statisticalData since it really does not work
|
61 karl 1.1.2.12 with Open and Pull operations. See separate bug 9786.
62
63 30 September 2013 - CVS Update
64 Mergeout head of tree up to 29 September 2013.
|
65 karl 1.1.2.10
66 29 September 2013. CVS update.
67 1. Modified calls to statisticalData.cpp to a) directly call with request
68 type, b) incorporate the open, pull, etc. messages. However, since these
69 are not part of the CIM class, we must do something special with them.
70 2. Corrected OOP interface to enable new flag to indicate internal operations
71 and set host, etc.
72 3. Add code to CQLOperationsDispatcher and WQLOperationDispatcher to clean
73 up CIMResponseDataCounter after filtering.
74 4. Modified ProviderAgent to set Host info for some pull operations.
75 5. Added new flag to CIMBinMsgSerializer and Deserializer.
|
76 karl 1.1.2.8
|
77 karl 1.1.2.9 17 September 2013 CVS update (Actually two different updates over 3 days)
78 1. Clean up some issues in CIMMessage.h and CIMMessage.cpp
79 2. Extend OpenExecQuery to WQL and CQL processors but return not complete
80 3. Remove memory leak in EnumerationContext and EnumerationContextTable
81 handling.
82 4. Created template functions for much of the pull operations.
83 5. Reversed order of queryLanguage and query (and changed names to match
84 execQuery) in client and server. Note that these are the execQuery
85 WQL and CQL filters and NOT FQL filters.
86 6. Some code cleanup in dispatcher
87 7. Today, passes all tests in pullop but issue in alltests. For some reason
88 not finding CIMObjectManager instance. Also, leaves enumeration contexts
89 if client terminates since cleanup thread not operating.
|
90 karl 1.1.2.11 8. XML from OOP not correctly processed.
|
91 karl 1.1.2.9
|
92 karl 1.1.2.8 14 September 2013 CVS update
93 Merged out up to 25 August. Cleaned up all operations and standardized code.
94 At this point the non pull operations code is in a set of templates but the
95 pull is not yet.
96 Fixed a significant number of problems so that it appears that the operations
97 except for OpenExecQuery run stably, at least with the pullop test program.
98 Note that there is a problem in that the Interop control provider is not
99 returning its singleton wbemserver object for some reason. Causes a test
100 failure
|
101 karl 1.1.2.7
102 Fixed for 16 June CVS Update
103 1. Cleaned up the enumerationContext and Table release functions and tested
104 to confirm that we do not lose memory in either normal sequences or
105 sequences that close early. Cleaned up pullop and added more tests
|
106 karl 1.1.2.8 Taged Before: PREAUG25UPDATE and after POSTAUG25UPDATE
|
107 karl 1.1.2.4
108 Fixed for 9 June CVS update
109 1. Cleaned up code for OpenQueryInstances. Note that this is incomplete.
110 No support in WQL or CQL Operations
111 2.
112
113 What was fixed for 5 June checkin.
|
114 karl 1.1.2.3 1. Extended ResponseTest MOF for for both CMPI and C++ subclasses
115 2. Fixed issues with pullop.
116 3. Fixed temp issue with CIMResponseData size by putting in mutex. That
117 is not a permanent fix but it gets around issue probably in the control
118 of the move logic that meant counts were off.
119 4. Fixed issues in Dispatcher so that associator code works. Still messy
120 code in the dispatcher.
121 5. Changed name of Enumerationtable.h & cpp to EnumerationContextTable.*
122 6 Changed name of ResponseStressTest module, classes, etc.
123
124 TAG: TASK_PEP317_5JUNE_2013_2
125
|
126 karl 1.1.2.2 2 June 2013
|
127 karl 1.1.2.1
128 Issues - KS
129 1. have not installed the binary move in CIMResponseData. Please run
130 with OPP off.
131 2. Some problem in the processing so we are getting server crashes.
132 Right no I am guessing that this is in the binaryCodec and am going to
133 expand the test tools to allow testing through the localhost.
134
135 3. Still way to many TODO and KS comments and KS_TEMPS. Removing bit by bit.
136
137 4. Env variable connection for the config parameters not installed.
138
139 5. Issue with the threaded timer. For some reason during tests it
140 eventually calls the timer thread with trash for the parm (which is
141 pointer to the EnumerationTable object). Caught because we do a valid
142 test at beginning of the function.
143
|
144 karl 1.1.2.2 6. Still using the templates in CIMOperationRequestDispatcher to simplify
145 the handle... processing.
146
147 7. I think I have a way around the double move of objects in the
148 EnumerationContext so that the outputter will just take a defined number
149 of objects directly from the gathering cache and save the second move.
150
151 8. Not yet passing all tests but getting closer now.
152
153 9. Created a tag before this commit TASK_PEP317_1JUNE_2013.
154
155 10. Next Tag will be TASK_PEP317_2_JUNE_2013 in the task branch
156
157
|
158 karl 1.1.2.1 ===========================================
159
160 OVERVIEW:
161
162 The operation extensions for pull operations defined in the DMTF specification
163 DSP0200 V 1.4 were implemented in Pegasus effective Pegasus version 2.11
164 including Client and Server.
165
166 These operations extend the CIM/XML individual operations to operation
167 sequences where the server must maintain state between operations in a
168 sequence and the client must execute multiple operations to get the full
169 set of instances or instance paths.
170
171 The following new CIM/XML operations as defined in DSP0200 are included;
172
173 -OpenEnumerateInstances
174 -openEnumerateInstancePaths
175 -OpenReferenceInstances
176 -OpenReferenceInstancePaths
177 -OpenAssociatiorInstances
178 -OpenAssociatorInstancePaths
179 karl 1.1.2.1 -PullInstancesWithPath
180 -PullInstancePaths
181 -CloseEnumeration
182 -EnumerationCount
|
183 karl 1.1.2.2 OpenExecQuery
|
184 karl 1.1.2.1
185 The following operations have not been implemented in this version of Pegasus:
186
187 -OpenQueryInstances
188
189 The following limitations on the implementation exist;
190
191 1. The filterQueryLanguage and filterQuery parameters are processed by
192 the Pegasus client but the server returns error if there is any data in
|
193 karl 1.1.2.2 either parameter. This work does not include the development of the
194 query language. Note that a separate effort to extend Pegasus to use
195 the DMTF FQL query language is in process.
|
196 karl 1.1.2.1
197 2. The input parameter continueOnError is processed correctly by the client
198 but the Pegasus server only provides for false since the server does not
199 include logic to continue processing responses after an error is
200 encountered.
201 This is consistent with the statement in the specification that use of
202 this functionality is optional and the fact that the DMTF agrees that all
203 of the issues of continuing after errors have not been clarified.
204
205 3. The operation enumerationCount is not processed by the server today since
206 a) really getting the count would be the same cost as the corresponding
207 enumeration, b) the server does not include a history or estimating
208 mechanism for this to date.
|
209 karl 1.1.2.2 NOTE: After a through review as part of the development of the next version
210 of CMPI we have concluded that this operation is probably not worth the
211 effort. Since it is optional, Pegasus will only return the unknown status
212 at this point
|
213 karl 1.1.2.1
214 Since the concept of sequences of operations linked together (open, pull, close)
215 is a major extension to the original CIM/XML operation concept of completely
216 independent operations several new pieces of functionality are implemented
217 to control interOperationTimeouts, counts of objects to be returned, etc.
218
219 TBD - Review this
220
221 CLIENT
222
223 The new operations follow the same pattern as the APIs for existing operations
224 in that:
225
226 1. All errors are handled as CIMException and Exception
227
228 2. The means of inputting parameters are the same except that there are
229 significantly more input parameters with the open operations and for the
230 first time operations return parameters as well as objects in the
231 response. Specifically the open and pull operations return values for
232 enumerationContext which is the identity for a pull sequence and
233 endOfSequence which is the marker the server sends in open and pull
234 karl 1.1.2.1 responses when it has no more objects to send.
235
236 The significant differences include:
237
238 1. Processing of parameters on responses (i.e. the endOfSequence and
239 enumerationContext parameters are returned for open and pull operations).
240
241 2. Numeric arguments (Uint32 and Uint64 include the option of NULL in some
242 cases so they are packaged inside classes Uint32Arg and Uint64Arg in the
243 client api.
244
245 3. The association and reference operations ONLY process instances. They do
246 not include the capability to return classes like reference and associator
247 do and therefore return CIMInstance rather than CIMObject.
248
249 4. Paths are returned in all cases (i.e OpenEnumerateInstances and
250 PullInstancesWithPath where they were not with EnumeratInstances.
251
252 5. The client must maintain state between operations in a sequence (using
253 the enumerationContext parameter).
254
255 karl 1.1.2.1 TBD- Are there more differences.
256
257
258 SERVER
259
260 The Pegasus server attempts to always deliver the requested number of objects
261 for any open or pull request (the specification allows for the server to
262 deliver less than the requested number of objects and specifically to return
263 zero objects on open). We felt that it was worth any extra cost in processing
264 to provide the client with exactly what it had requested.
265
266 The pegasus server always closes an enumeration sequence upon receipt of any
267 error from the providers, repository, etc. Therefore the server will reject
|
268 karl 1.1.2.2 any request that has continueOnError = true;
269
270 Expansion to allow the continue on error may be added in a future version.
271 In any case, the whole purpose of the continue on error is really to allow
272 input from good providers to be mixed with providers that return errors so
273 that generally this would mean simply changing the logic in the return mechanism
274 to not shutdown when an error is received from any given provider.
275
276 Generally we do not believe that the providers need to do much more in the
277 future to support the continueOnError other than possibly allowing the provider
278 to continue processing after it has received an error.
|
279 karl 1.1.2.1
280 PROVIDERS
281
282 This implementation requires NO changes to the existing providers. The
283 provider APIs operate just as they do with the original operations.
284
285 Because the server processing is different however, there may be some
286 behavior differences primarily because the client now controls the speed of
287 delivery of objects.
288
289 In previous versions of Pegasus, the server attempts to deliver objects as
290 rapidly as then can be put on the network. In the case of HTTP chunked requests
291 they are delivered in chunks of about 100 objects. The primary delay for the
292 providers was the processing of each segment through the server. The server
293 is blocked so that no other segment can proceed through the server until that
294 segment is processed and sent on the network.
295 In the case of non-chunkedresponses, they are completely gathered in the serve
296 and then delivered as one non-chunked response. There were no delays for the
297 providers, just lots of possible memory use in the server.
298
299 The responses from providers (delivered through the deliver(...) interface are
300 karl 1.1.2.1 gathered into segments of about 100 objects and this group of objects is moved
301 through the server to be delivered to the client.
302
303 However with the inclusion of the pull operations, The segments of objects
304 from the providers are cached in the server response path until the
305 maxObjectCount for that request (open or pull) and that number returned in a
306 non-chunked response. Thus, if the client is slow to issue pull requests,
307 the providers might be delayed at some point to reduce memory usage in the
308 server (the delay appears as slow response tothe deliver operation).
309
310 In other words, the time to process large sets of responses from the provider
311 now depends on the speed of handling the client.
312
313 It is important to remember in developing providers that the Pegasus server
314 can most efficiently process responses if they are passed from the provider
315 to the server individually or in small arrays of objects rather than the
316 provider gathering very large arrays of objects and sending them to the
317 server.
318
|
319 karl 1.1.2.2 NEXT GENERATION PROVIDERS
320 KS_TODO
321
|
322 karl 1.1.2.1 CONFIGURATION PARAMETERS
323
324 The server includes several configuration parameters to set limits on the
325 processing of pull operations. All of these configuration parameters are
326 compile time parameters rather than runtime.
327
328 1. Maximum value of minimum interoperation time. This parameter defines the
329 maximum time allowed between the return of an open or pull response and
330 the receipt of the next pull or a close operation before the server may
331 close the enumeration. The specification allows the server to set a
332 maximum interoperation time and refuse open requests that with requested
333 operationTimeout greater than that time.
334 CIM_ERR_INVALID_OPERATION_TIMEOUT
335
336 This value is set with the Pegasus environment variable
337 PEGASUS_PULL....
338
339 2. Maximum objects returned in a single open or pull operation. The server
340 can set a maximum limit on the number of objects that can be returned in
341 a single open or pull oepration with the maxObjectCount parameter.
342
343 karl 1.1.2.1 3. Whether the server allows 0 as an interoperation timeout value. The value
344 zero is s special value for the interoperationTimeout in that it tells the
345 server to not timeout any enumeration sequence.
346
347 With this value for interoperationTimeout, the only way to close an
348 enumeration sequence is to complete all of the pulls or issue the close.
349 If for some reason the sequence is not completed, that enumeration context
350 would remain open indefinitly. Since in Pegasus any open enumeration
351 context uses resources (the context object and any provider resposnes that
352 have not yet been issued in a response) it would appear that most
353 platforms would not want to allow the existence of enumeration contexts
354 that cannot be closed by the server.
355
356 4, maximum consecutive pull requests with 0 maxObjectCount. The use of the
357 pull operation with maxObjectCount set to zero could be used to keep an
358 enumeration context open indefinitly (this tells the server to restart the
359 interoperationTimeout but not send any objects in the response). Therefore the
360 specification allows for the server setting maximum limits on this behavior
361 and returning the error CIM_ERR_SERVER_LIMITS_EXCEEDED if this limit is
362 exceeded.
363 Note that this is maximum CONSECUTIVE pulls so that issuing a pull with
364 karl 1.1.2.1 a non-zero count resets this counter.
365
366 KS-TBD - Is this really logical since we can still block by just issuing
367 lots of zero request and an occansional request for one object.
368
369 Pegaus sets the value of this limit to 1000 and allows the implementer to
370 modify it with the PEGASUS_MAXIMUM_ZERO_OBJECTCOUNT environment variable.
371
372 5. Default operationTimeout -
373
374 The default of this parameter is to refuse operat
375
376 In the current release of Pegasus these are all compile time parameters.
|
377 karl 1.1.2.11
378
379 NOTES On working with task branch.
380
381 Merge out Process
382
383 To keep our TASK branch in sync with the current head of tree we need
384 to do a regular merge out. the TaskMakefile contains the makefile
385 procedures to do this efficiently. NOTE: Following these procedures is
386 important in that you are merging out new material each time you do
387 the merge out. If you were just to repeatedly merge out, you would be
388 merging previously merged changes a second time causing a real mess.
389
390 Start with new directory and put TaskMakefile above pegasus (needed so you
391 have this file for the initial operations.
392
393 make -f TaskMakefile branch_merge_out BNAME=PEP317-pullop ## takes a long time
394
395 This checks out current head, merges it into task branch and sets tags
396 for the mergeout. Note that at the end of this step this work is
397 part of the TASK... branch.
398 karl 1.1.2.11
399 NOW check for conflicts, errors, etc. that resulted from the merge.
400 Look for conflict flags, compare the results (I use linux merge as a
401 good graphic compare tool) and build and test. When you are satisfied
402 that the merge out is clean, you can commit the results to the TASK...
403 branch
404
405 To commit the work to this into Task branch
406
407 make -f mak/TaskMakefile branch_merge_out_commit BNAME=PEP317-pullop
408
409 or manually commit and finish as follows
410
411 cvs commit
412 make -f mak/TaskMakefile branch_merge_out_finish BNAME=PEP317-pullop
413
414 ## This last step is important since it cleans up temporary tags to prepare
415 you for the next checkout
416
417 COMPARE TASKBRANCH WITH HEAD
418
419 karl 1.1.2.11 In a new pegasus work space do same as above for merge out.
420
421 make -f TaskMakefile BNAME=PEP317-pullop
422
423 This produces a result which is all of the head merged into the branch.
424 A diff of this is all the new changes to the head of tree that you will
425 include into the merge.
426
|
Return to
readme.pulloperations
CVS log
Up to [Pegasus] / pegasus