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