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