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