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