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.31 OOP right now. Fixed by converting to XML. Concluded that we do not
15 need to do this. The binary response is not really used often
16 in the current environment So double mapping it is not a major issue.
17 Leave this as FUTURE
|
18 karl 1.1.2.35 2. DONE OpenExecQuery - Code is incomplete in that it does not include the
|
19 karl 1.1.2.31 return from the exec query function to the aggregator yet. Code for Pull
|
20 karl 1.1.2.34 part of OpenQueryInstancesRequest a) should be part of the common
21 CIMOperationRequestDispatcher execCommon code. DONE, not tested. 29 May
|
22 karl 1.1.2.35 30 May tested with simple cli calls.
23 3. DONE The changes to WQLCIMOperationRequestDispatcher and CQL... for handling
|
24 karl 1.1.2.4 pull not completed so we feed the responses back to the EnmerationContext
|
25 karl 1.1.2.35 queues. DONE Not tested 29 May 30 May DONE, some testing done
26 4. Minor TODOs, diagnostics, etc. still in the code. Reduced almost to
27 none now. We are leaving some in as PEGASUS_DEBUG
|
28 karl 1.1.2.31 5. Extension to avoid double move of objects in CIMResponseData (one
|
29 karl 1.1.2.3 into enumerationContext queue and second to new cimResponseData for
30 response. Want to avoid second move by extending Open/Pull response
31 messages to include count and CIMResponse data to count objects out
|
32 karl 1.1.2.23 of queue when converting (avoids the second move). This would mean
33 extending the output writers to allow the count field to be supplied
|
34 karl 1.1.2.30 so they would only create output for up to the count supplied.(Make
|
35 karl 1.1.2.35 this future beyond bug 9676). This is fairly extensive because it
36 extends beyond CIMResponseData to SCMO and XML writers where the
37 XmlWriters used by encodeXmlResponse would have to have counters
38 added. Then instead of copying on getCache we would simply pass the
39 cache and count on and the writer would take and remove.
|
40 karl 1.1.2.31 6. Add more static tests (currently only OpenEnumerateInstances and
|
41 karl 1.1.2.30 OpenEnumerateInstanceNames covered).
|
42 karl 1.1.2.26 Low priority because most of this except exact XML covered in other
|
43 karl 1.1.2.28 tests. note that we can only add very limited tests since a) no
|
44 karl 1.1.2.31 way to test multiple operations in sequence(i.e. open/pull) and
|
45 karl 1.1.2.28 cannot be sure how many responses will come back in all cases even
|
46 karl 1.1.2.35 for open. The only reason for most of these tests is to assure that
47 we do not change XML inadvertendtly in future with change that is
48 compatible to both our server and client but breaks other clients or
49 servers. In any case we can do only minimal tests because most real
50 testing involves both open and pull and the static tests are by their
51 nature single operation.
52 7. Clean up the CIMOperationRequestDecoder.cpp reject CIMException
53 further since there is some overlap. The only overlap is that a
54 couple of the specific functions duplicate. VERY LOW priority.
|
55 karl 1.1.2.32 8. Correct issue between operations and HTTP where we are sending
|
56 karl 1.1.2.31 trailers with exceptions. Modify response mechanisms so that we
57 set non-chunked for all responses where we send error responses to
|
58 karl 1.1.2.35 avoid the trailers. NOTE: There should be now a bug on this in general
59 where we would want to send an initial error without the trailer. Should
60 have always done that.
|
61 karl 1.1.2.32 9. It would be more efficient in dispatcher to always use exception for
|
62 karl 1.1.2.31 rejects and change the _reject functions so that they never return
63 when they reject. This is VERY LOW PRIORITY and primarily saves
64 a few lines of code in the reject functions and their calls. Means we
65 would code.
|
66 karl 1.1.2.35 _rejectIfEnumerationToBroad(...);
67 _rejectIfThisParameterIncorrect(...);
|
68 karl 1.1.2.31
69 instead of
70 if (_rejectIfEnum...)
71 {
72 return true
73 }
74 It would mean that the method trace for the handlers would not return
|
75 karl 1.1.2.35 an exit if we rejected. VERY LOW PRIORITY. Possibly FUTURE. No behavior
76 change, just more compact source code but it messes with the method
77 trace logic.
|
78 karl 1.1.2.34 10. There are still a couple of template functions around the task of
|
79 karl 1.1.2.32 distributing requests to the multiple providers.
80 In fact there are two similiar but different templates for
|
81 karl 1.1.2.31 the associators(i.e. assoc, ref, etc.) functions and the parallel
82 openAssoc functions. It would be nice to consolidate that logic and
83 further to try to create a non-template form for those functions. LOW
84 PRIORITY.
|
85 karl 1.1.2.34 11. External runtime variables. This bug leaves these variables as
|
86 karl 1.1.2.37 internal to CIMOperationRequestDispatcher.cpp.
87 See bug 9819 for the changes to externalize these variables, both
88 the runtime and buildtime variables. The Work group discussion
89 documents what the variables are and how they tie to statistics info.
90 See the OpenPegasus Wiki, Pull operations work group.
|
91 karl 1.1.2.35 12. Trace functions in CIMResponseData,h & cpp should be PEGASUS_DEBUG.
|
92 karl 1.1.2.37 Same for trace function in EnumerationContext and
93 EnumerationContextTable
94 13.Question. We added trace in CIMRequestOperationDispatcher.cpp if
95 query enum is recevied with no object path. However, since this is
96 a provider problem should we be doing something other than a trace
97 (ex. log) since traces are often not really used and they do generate
98 lots of data whereby something like this could get lost. Also, need
99 to review what level of trace if we keep trace.
|
100 karl 1.1.2.36 14. Note that the build-a-class argument on OpenQueryInstances always
|
101 karl 1.1.2.38 returns error since we do not build the class. We propose to deprecate
102 this in DMTF and not implement in in OpenPegasus. TODO add a bug
103 defining this limitation. This is not a TODO, just a warning for
|
104 karl 1.1.2.37 the future. TODO add bug about this and add to release notes
|
105 karl 1.1.2.38 15. Clarify trace of completion of each enumeration sequence.
106 16. Statistics keeping for open, etc. through cimperf.
107
|
108 karl 1.1.2.26
109 NEXT TASKS:
|
110 karl 1.1.2.37 a. finish 8, 12 above. Test against cimperf since there was a bug
111 in cimperf from before.
|
112 karl 1.1.2.38 18 June 2014
113 1. Correct errors in pullop and CMIMessage.cpp identified by Ji Lee as comments 58,59
114 2. Correct error in Makefile identified by Ji Lee as bug comment 60
|
115 karl 1.1.2.37
116 14 June 2014
117 1. Mergeout from head of tree.
118
|
119 karl 1.1.2.36 12 June 2014
120 1. Implement the basic code for the CIMOperationDispatcher portion of bug 9819
121 Note that the CIMConfig calls are disabled with comments.
122 2. Corrected a number of differences in const declaration and definition for
|
123 karl 1.1.2.37 continueOnError and maxObjectCount in CIMClient. This corrects issue
124 documented in bug 9676 comment 53
|
125 karl 1.1.2.36 3. Corrected some documentation for Pull operations in CIMClient.
126 4. Corrected similar issue In EnumerationContext class. See comment 54
127 5. Removed ExecInfo.h header from Client/tests/PullErrors/PullErrors.cpp
|
128 karl 1.1.2.35
129 30 May 2014
130 1. Correct issue in UintArgs. Modified to use smart pointers, consistent
131 with public interfaces. Tested
132 2. Complete code for OpenQueryInstances and PullInstances so that the complete
133 sequence works for both the server and client (i.e. 2, 3 above done
134 except for more tests in pullop).
135 3. Fix issue in cimcli where the OpenQueryInstances was outputting a path
136 component where there is no path transmitted from the server.
137 4. Moved large block of common code in CQLOperationRequestDispatcher.cpp
138 and WQLOperationRequestDispatcher.cpp to common function
139 handleQueryRequestCommon in CIMOperationRequestDispatcher.cpp. These
140 handlers now reduced to just the parser processing and minimal error
141 checks.
142 5. Cleaned up some code in EnumerationContextTable.CreateContext so only
143 single interface for all requests.
144 6, Commented out a number of PEG_TRACE messages. Note that they are
145 commented with 4 /s at line beginning to be easily identified.
146 //// code
147 There are still a number of KS_TODOs but they are mostly some questsions,
148 some internationalization (note that almost none of this environment is
149 karl 1.1.2.35 completely internationlaized (see the decoders)) and a couple of questions
150 about the existing code or exactly what message should be sent. I argue
151 that the current TODOs should not stop checkin. Will remove after we
152 have tested couple of days and prove that there is no real need.
153 7. Added trace in Query response code if there is no objectPath since that
154 is really an error in the provider
155
|
156 karl 1.1.2.34
157 29 May 2014
158 1. Correct issue in cimcli that was causing rejects of open operations when
159 there were no filters requested. The standard default is WQL in cimcli
160 so we overrode this for the pull operations.
161 2. Clean up OpenQueryInstances in CIMMessage.h and CIMMessage.cpp.
162 3. Modify CIMOperationRequestDispatcher and
163 EnumerationContextTable.CreateContext to pass request rather than request
164 parameters.
165 4. Remove a number of diagnostic messages. Note that there are still some.
166 They are marked KS_TODO with with note to remove before checkin. They are
167 all traces and validations.
168 5. Correct error in inclusion of execinfo.h include in CIMOperationRequestDis.
169 found by Ji Lee.
170 6. Cleaned up execQuery and extended it for OpenQueryInstances. ExecQuery
171 tested but have not tested OpenQueryInstances yet. One more checkin and we
172 should be able to close 2,3 above (OpenQueryInstances).
|
173 karl 1.1.2.32
174 26 May 2014
175 1. Remove a number of diagnostics.
176 2. Make cache size in EnumerationContextTable dynamic and remove function
177 to set default values. MaximumEnums set from Dispatcher on constructor for
178 EnumerationContextTable and table size set to 1/2 of maximum number of
179 open contexts.
180 3. Clean up some statistics in EnumerationContextTable
|
181 karl 1.1.2.33 4. Correct error in query and queryLanguage parameters in cimcli in that
182 the default for queryLanguage is WQL but must be "" for pull operations.
183 If WQL found they set it to "".
|
184 karl 1.1.2.32
|
185 karl 1.1.2.31
186 9 May 2104
187 1. Converted several template functions in CIMOperationRequestDispatcher
188 to real functions
189 2. Added intermediate CIMMessage for CIMPullOperationRequestMessage since
190 all of the pulls have exactly the same data. This allowed us to
191 convert the template function processPullRequest from template to
192 real function
193 3. Added intermediate CIMMessage for CIMOpenOperationRequestMessage betweeh\n
194 all of the Opens and the CIMRequestData message. This will allow
195 common code to test all of these variables in all 6
196 CIMOperationRequestDispatcher handleOpen... functions
197 3. Added variable in CIMOperationRequestDispatcher handleEnqueue to make
198 releasing the original request conditional on return from the handle...
199 for open... and pull... handlers.
200 This allowed us to drop one place where we were creating a new request msg
201 for the delayed response and use the original request. This meant that
202 we could convert the issueOpenOrPullResponse from template function to
203 real function.
204 4. Moved open and pull constructors in CIMMessage.h to CIMMessage.cpp. NOTE:
205 openQueryInstances not moved. Will do when we get this funciton running.
206 karl 1.1.2.31 5. Added test for correct namespace in pull operations. Note that it is
207 never really used but since supplied with request, we test to be sure it is
208 same as open request namespace. added internationalized exception for this.
209 6. We should probably add same test to close just as an input parameter
210 validation.
211 6. Modified processPullRequest to close the enumeration context if
212 incorrect response type received. Before we just returned exception and
213 left context open for next request. Closing is much more logical since the
214 client really did send an erronous request.
215 7. Modified PullErrors to correctly test above changed in behavior.
216 8. Removed a significant number of diagnostic messages.
|
217 karl 1.1.2.33 9. Added query and querylanguage parameters to cimcli.
|
218 karl 1.1.2.31
|
219 karl 1.1.2.23
|
220 karl 1.1.2.30 4 May 2014
221 1. Clean interface with EnumerationContext timeout thread
222 2. Remove more diagnostics
223 3. Correct issue with enumerationContext Release that was causing
224 failures during nightly tests.
225
|
226 karl 1.1.2.29 2 May 2014
227 1. Remove Diagnostics from ResponseData.cpp
228 2. Correct setup and start of EnumerationContextTimerThread
229 3. Change limit on max number of enum contexts to be set from Dispatcher.
230 4. Increase size of hashtable for enum contexts.
231 5. Corrected issue causing failures in removeContext. Now runs through nightly
232 tests most of the time.
|
233 karl 1.1.2.28 1 May 2014
234 1. Cleanup of code and variable names.
235 2. Removed namespace variable from EnumerationContext. It was never used.
236 3. Added test for max number of open enumerations. Right now it is fixed
237 and set about 100. Note that this is tied to the size of hash table
238 so that there is a issue with more dynamic setting of max and the
239 hash table size.
240 4. Removed several unused functions.
241 5. Found one possible issue causing thread conflict but not the core one
242 yet.
243
244 30 April
245 1. Added exception response to dispatcher for Limits exceeded on
246 CreateEnumerationContext. Returns Exceeded server limits CIMException.
247 2. Fixed possible deadlock where we were not unlocking EnumerationContext
248 under error condition
249
250
|
251 karl 1.1.2.27 27 April - mergeout to head of tree
252 1. Mergeout of the code to the head of tree. Documented that mergeout in
253 the bug
254
255 27 April 2014
256 1. Clean up in a number of areas, mostly just code without changing
257 functionality.
258 2. Modified CIMMessage.h slightly to clarify names of the pull intermediate
259 messages (the common open and pull response);
260 3. Removed a number of diagnostics from CIMResponseData
261 4. Added new function to ResponseStressTestProvider to be able to terminate
262 output after a defined number of objects with a CIMException.
263 5. Removed a number of other TODOs
264 6. Corrected a couple of errors in the server message bundle.
265 7. Modified ResponseEncoder to only output the error for pull errors.
266 It was errounously outputting the EndOfSequence, EnumerationContext and
267 the error. This way, only the error is sent which is spec.
268 8. Removed number of TODOs and cleaned up a couple of others.
269 9. Added static tests for OpenEnumerateInstanceNames.
270 10. Modified a number of the temporary diagnostics to be permanent by
271 changing them to PEGASUS_DEBUG_ASSERTs
272 karl 1.1.2.27
|
273 karl 1.1.2.24 22 April 2014
274 1. Clean up some messages.
275 2. Still trying to find issue that randomly keeps messages in timeout
276 queue long after they have been closed and returned.
|
277 karl 1.1.2.25 3. Fixed memory loss error.
|
278 karl 1.1.2.26 4. Added zero reject for OperationTimeout because that effectively disables
279 the whole timeout mechanism so that enumerations could be started, never
280 completed by the client and would just hang around in memory. That
281 would be a significant DDOS attack (start very large enum with no
282 timeout) and never do pulls after open.
|
283 karl 1.1.2.25
|
284 karl 1.1.2.23 21 April 2014
|
285 karl 1.1.2.27 1. Reorganized code in CIMOperationRequestDecoder.cpp ...Iparam classes.
|
286 karl 1.1.2.23 Cleaned up the rejectCIMException code.
287 2. Cleanup some issues in the EnumerationContextTimeout Thread.
288 3. Fixed issue in pullop where it was using zero as default for default
289 operation timeout where it should have been NULL, the DMTF specified
290 default.
291 4. Enabled the test to reject 0 as operation timeout on a request and but
292 controled by a #define in CIMOperationRequestDispatcher.cpp
293 5. Added test for excessive new OperationContext entries in table.
294
295 18 April 2014
296 1. Internationalize remaining messages in CIMOperationRequestDecoder.cpp and
297 clean up the decoders for some of the messages so they use the
298 ...Iparam classes. Note that we did not clean up all of the old message
299 decoders, just the new ones and we did not clean up the Count message
300 since it is deprecated. TODO clean these up so the decoder is really
301 consistent.
302 2. Enabled the EnumerationContext Timer and removed code for alternate
303 non-thread solution.
|
304 karl 1.1.2.16
|
305 karl 1.1.2.21 17 April 2014
306 1. Reorganized the lock/unlock for handling the EnumerationContext because
307 there were thread windows (i.e. using the context after it was released
308 by other thread).
309 2. Modified code for the InteroperationTimerThread and deleted old code that
310 allowed this whole thread to by bypassed.
311 3. Internationalized a number of CIMOperationRequestDispatcher CIMException
312 response messages.
|
313 karl 1.1.2.22 4. Fixed stress tests in Client/tests/pullop that were getting timeout. The
314 issue was not the pull code but that fact that the idle client timeout
315 appears to be measureing to the end of the operation and the operation
316 was taking more than 40 seconds which is the default timeout. The idle
317 timeout takes no account of the fact that chunks are being regularly
318 delivered.
319 5. Several minor code changes.
320 NOTE: At this point the code passes extensive tests of the pull operations
321 both in OOP and none OOP mode (but with lots of diagnostics that may
322 be affecting timing).
|
323 karl 1.1.2.21
|
324 karl 1.1.2.20 10 April 2014
325 1. Fix issues causing failure with repeated pull operations.
326 2. Consolidate some of the CIMOperationRequestDispatcher.cpp template code
327
|
328 karl 1.1.2.19 7 April 2104
329 MergeOut of head of tree.
330
331 7 April 2014
332 1. Permanently fixed issue with getting correct number of objects on response.
333 This was introduced when did a temp fix to the OOP processing, in particular
334 removed the condition variable wait in the CIMOperationDispatcher handle
335 functions for opens and pulls. This moved the functionality to kick off
336 open and pull responses to the provider threads if there are not enough
337 objects when the handle is processed. Also added a variable to allow us to
338 test with either a) responses are required to satisfy the original
339 request size or) b, responses are required only to return some objects.
340 We will add statistics to see which of these works best.
341 2. Modified WsmProcessor EnumerationContext class since the name conflicts
342 with the pull Operation EnumerationContext class.
343 3. Created a new intermediate level of CIMMessage, the CIMPullResponseData
344 Message so that all of the open and Pull responses can use common code
345 since there are only two variables (endOfSequence and EnumerationContext)
346 and they are common across all the open and pull responses.
347 4. Removed a number of diagnostics.
348 5. Cleaned up the Dispcatcher so that the open and pulls have common response
349 karl 1.1.2.19 code and that code can be used from the dispatcher handle functions and
350 the provider response functions.
351
|
352 karl 1.1.2.18 31 March 2014 - Checkin
353 1. Fixed issues in OOP processing of pull operations, in particular
354 issues with cimxml output format when processed through the
355 *InternalXmlEncoder functions.
356 2. Clean up some of the internalXml functionality
357 3. Found issues causing timeout with a particular provider. The issue
358 is that the dispatcher and monitor end up using the same thread so the
359 condition variable in the dispatcher thread stops the monitor. Turned
360 off the conditionVariable in getCache for the moment which means that
361 we get number of responses for open... with 0 objects before the
362 providers can begin to respond. This is only for test.
363 4. Added some statistics for enumerations and display the statistics
364 when we close the server (same as cache statistics)
365
366 12 March 2014 - Mergeout and Mergein
367 1. Mergeout to head of tree for this date and mergein for patch update
368 to bug 9676
369 2. Extensions to pullop tests program and tests.
370 3. Added some diagnostics in looking for OOP issue.
371 4. Removed a number of diagnostics messages and cleaned up code in
372 dispatcher to simplify pull operation processing.
373 karl 1.1.2.18
|
374 karl 1.1.2.17 15 December 2013
375 1. Mergeout and mergein up to 15 December 2013
376 2. Clean up issues from tests documented in bug 9676 last week.
377 3. Clean up some code in dispatcher
378 4. Remove the filter function from ResponseStressc++Provider.
379
|
380 karl 1.1.2.16 21 November 2013
381 1. Mergeout from head of tree to 21 November 2013.
|
382 karl 1.1.2.15
383 18 November 2013
384 1. Cleanup of a bunch of minor errors and completion of all of the code for
385 the openQueryInstances except for the PullInstances in Dispatcher and
386 the aggregator function.
387 2. OpenqueryInstances added to cimcli.
|
388 karl 1.1.2.14
389 13 October 2013 CVS branch update.
390 1. Integrated bug 9786 into the branch. Note that we need to test the
391 generated statistics.
392 2. Mergeout executed to update to head of tree as of 8:00 am 13 October 2013.
393 3. Cleaned up several errors in OOP processing. Note that there is at least
394 one issue left when we to a pull on ManagedElement in at least one of the
395 namespaces.
396 4. Cleaned up some of the outstanding diagnostic code
397 5. Generally passes all tests except for one test of pullop where it is trying
398 to pull enum instances CIM_ManagedElement from a particular namespace.
|
399 karl 1.1.2.12
|
400 karl 1.1.2.16 NOTE: I did not make comments here for changes in October despite the fact
401 that I did 2 mergouts, number of fixes, and a mergein.
402
|
403 karl 1.1.2.12 30 September 2013 - CVS Update
404 Mergeout head of tree up to 29 September 2013.
|
405 karl 1.1.2.10
406 29 September 2013. CVS update.
407 1. Modified calls to statisticalData.cpp to a) directly call with request
408 type, b) incorporate the open, pull, etc. messages. However, since these
409 are not part of the CIM class, we must do something special with them.
|
410 karl 1.1.2.13 See bug 9785 for full solution to this issue.
|
411 karl 1.1.2.10 2. Corrected OOP interface to enable new flag to indicate internal operations
412 and set host, etc.
413 3. Add code to CQLOperationsDispatcher and WQLOperationDispatcher to clean
414 up CIMResponseDataCounter after filtering.
415 4. Modified ProviderAgent to set Host info for some pull operations.
416 5. Added new flag to CIMBinMsgSerializer and Deserializer.
|
417 karl 1.1.2.8
|
418 karl 1.1.2.9 17 September 2013 CVS update (Actually two different updates over 3 days)
419 1. Clean up some issues in CIMMessage.h and CIMMessage.cpp
420 2. Extend OpenExecQuery to WQL and CQL processors but return not complete
421 3. Remove memory leak in EnumerationContext and EnumerationContextTable
422 handling.
423 4. Created template functions for much of the pull operations.
424 5. Reversed order of queryLanguage and query (and changed names to match
425 execQuery) in client and server. Note that these are the execQuery
426 WQL and CQL filters and NOT FQL filters.
427 6. Some code cleanup in dispatcher
428 7. Today, passes all tests in pullop but issue in alltests. For some reason
429 not finding CIMObjectManager instance. Also, leaves enumeration contexts
430 if client terminates since cleanup thread not operating.
|
431 karl 1.1.2.11 8. XML from OOP not correctly processed.
|
432 karl 1.1.2.9
|
433 karl 1.1.2.8 14 September 2013 CVS update
434 Merged out up to 25 August. Cleaned up all operations and standardized code.
435 At this point the non pull operations code is in a set of templates but the
436 pull is not yet.
437 Fixed a significant number of problems so that it appears that the operations
438 except for OpenExecQuery run stably, at least with the pullop test program.
439 Note that there is a problem in that the Interop control provider is not
440 returning its singleton wbemserver object for some reason. Causes a test
441 failure
|
442 karl 1.1.2.7
443 Fixed for 16 June CVS Update
444 1. Cleaned up the enumerationContext and Table release functions and tested
445 to confirm that we do not lose memory in either normal sequences or
446 sequences that close early. Cleaned up pullop and added more tests
|
447 karl 1.1.2.8 Taged Before: PREAUG25UPDATE and after POSTAUG25UPDATE
|
448 karl 1.1.2.4
449 Fixed for 9 June CVS update
450 1. Cleaned up code for OpenQueryInstances. Note that this is incomplete.
451 No support in WQL or CQL Operations
452 2.
453
454 What was fixed for 5 June checkin.
|
455 karl 1.1.2.3 1. Extended ResponseTest MOF for for both CMPI and C++ subclasses
456 2. Fixed issues with pullop.
457 3. Fixed temp issue with CIMResponseData size by putting in mutex. That
458 is not a permanent fix but it gets around issue probably in the control
459 of the move logic that meant counts were off.
460 4. Fixed issues in Dispatcher so that associator code works. Still messy
461 code in the dispatcher.
462 5. Changed name of Enumerationtable.h & cpp to EnumerationContextTable.*
463 6 Changed name of ResponseStressTest module, classes, etc.
464
465 TAG: TASK_PEP317_5JUNE_2013_2
466
|
467 karl 1.1.2.2 2 June 2013
|
468 karl 1.1.2.1
469 Issues - KS
470
|
471 karl 1.1.2.15 - Still way to many TODO and KS comments and KS_TEMPS. Removing bit by bit.
|
472 karl 1.1.2.1
|
473 karl 1.1.2.15 - Runtime variable connection for the config parameters not installed. That
474 has been made into a separate bug (see bug 9819)
|
475 karl 1.1.2.1
476 5. Issue with the threaded timer. For some reason during tests it
477 eventually calls the timer thread with trash for the parm (which is
478 pointer to the EnumerationTable object). Caught because we do a valid
479 test at beginning of the function.
480
|
481 karl 1.1.2.2 6. Still using the templates in CIMOperationRequestDispatcher to simplify
482 the handle... processing.
483
484 7. I think I have a way around the double move of objects in the
485 EnumerationContext so that the outputter will just take a defined number
486 of objects directly from the gathering cache and save the second move.
487
|
488 karl 1.1.2.15 8. Not yet passing all tests but getting closer now. The major test that is
489 causing an error today is the execution of a full enumeration with the
490 forceProviders = true. This causes a client timeout sometimes.
|
491 karl 1.1.2.2
492
493
|
494 karl 1.1.2.1 ===========================================
495
496 OVERVIEW:
497
498 The operation extensions for pull operations defined in the DMTF specification
499 DSP0200 V 1.4 were implemented in Pegasus effective Pegasus version 2.11
500 including Client and Server.
501
502 These operations extend the CIM/XML individual operations to operation
503 sequences where the server must maintain state between operations in a
504 sequence and the client must execute multiple operations to get the full
505 set of instances or instance paths.
506
507 The following new CIM/XML operations as defined in DSP0200 are included;
508
509 -OpenEnumerateInstances
510 -openEnumerateInstancePaths
511 -OpenReferenceInstances
512 -OpenReferenceInstancePaths
513 -OpenAssociatiorInstances
514 -OpenAssociatorInstancePaths
|
515 karl 1.1.2.16 -OpenQueryInstances
|
516 karl 1.1.2.1 -PullInstancesWithPath
517 -PullInstancePaths
|
518 karl 1.1.2.16 -PullInstances
|
519 karl 1.1.2.1 -CloseEnumeration
520 -EnumerationCount
|
521 karl 1.1.2.2 OpenExecQuery
|
522 karl 1.1.2.1
523 The following operations have not been implemented in this version of Pegasus:
524
525 -OpenQueryInstances
526
527 The following limitations on the implementation exist;
528
529 1. The filterQueryLanguage and filterQuery parameters are processed by
530 the Pegasus client but the server returns error if there is any data in
|
531 karl 1.1.2.2 either parameter. This work does not include the development of the
532 query language. Note that a separate effort to extend Pegasus to use
533 the DMTF FQL query language is in process.
|
534 karl 1.1.2.1
535 2. The input parameter continueOnError is processed correctly by the client
536 but the Pegasus server only provides for false since the server does not
537 include logic to continue processing responses after an error is
538 encountered.
539 This is consistent with the statement in the specification that use of
540 this functionality is optional and the fact that the DMTF agrees that all
541 of the issues of continuing after errors have not been clarified.
542
543 3. The operation enumerationCount is not processed by the server today since
544 a) really getting the count would be the same cost as the corresponding
545 enumeration, b) the server does not include a history or estimating
546 mechanism for this to date.
|
547 karl 1.1.2.2 NOTE: After a through review as part of the development of the next version
548 of CMPI we have concluded that this operation is probably not worth the
549 effort. Since it is optional, Pegasus will only return the unknown status
550 at this point
|
551 karl 1.1.2.1
552 Since the concept of sequences of operations linked together (open, pull, close)
553 is a major extension to the original CIM/XML operation concept of completely
554 independent operations several new pieces of functionality are implemented
555 to control interOperationTimeouts, counts of objects to be returned, etc.
556
557 TBD - Review this
558
559 CLIENT
560
561 The new operations follow the same pattern as the APIs for existing operations
562 in that:
563
564 1. All errors are handled as CIMException and Exception
565
566 2. The means of inputting parameters are the same except that there are
567 significantly more input parameters with the open operations and for the
568 first time operations return parameters as well as objects in the
569 response. Specifically the open and pull operations return values for
570 enumerationContext which is the identity for a pull sequence and
571 endOfSequence which is the marker the server sends in open and pull
572 karl 1.1.2.1 responses when it has no more objects to send.
573
574 The significant differences include:
575
576 1. Processing of parameters on responses (i.e. the endOfSequence and
577 enumerationContext parameters are returned for open and pull operations).
578
579 2. Numeric arguments (Uint32 and Uint64 include the option of NULL in some
580 cases so they are packaged inside classes Uint32Arg and Uint64Arg in the
581 client api.
582
583 3. The association and reference operations ONLY process instances. They do
584 not include the capability to return classes like reference and associator
585 do and therefore return CIMInstance rather than CIMObject.
586
587 4. Paths are returned in all cases (i.e OpenEnumerateInstances and
588 PullInstancesWithPath where they were not with EnumeratInstances.
589
590 5. The client must maintain state between operations in a sequence (using
591 the enumerationContext parameter).
592
593 karl 1.1.2.1 TBD- Are there more differences.
594
595
596 SERVER
597
598 The Pegasus server attempts to always deliver the requested number of objects
599 for any open or pull request (the specification allows for the server to
600 deliver less than the requested number of objects and specifically to return
601 zero objects on open). We felt that it was worth any extra cost in processing
602 to provide the client with exactly what it had requested.
603
604 The pegasus server always closes an enumeration sequence upon receipt of any
605 error from the providers, repository, etc. Therefore the server will reject
|
606 karl 1.1.2.2 any request that has continueOnError = true;
607
608 Expansion to allow the continue on error may be added in a future version.
609 In any case, the whole purpose of the continue on error is really to allow
610 input from good providers to be mixed with providers that return errors so
611 that generally this would mean simply changing the logic in the return mechanism
612 to not shutdown when an error is received from any given provider.
613
614 Generally we do not believe that the providers need to do much more in the
615 future to support the continueOnError other than possibly allowing the provider
616 to continue processing after it has received an error.
|
617 karl 1.1.2.1
618 PROVIDERS
619
620 This implementation requires NO changes to the existing providers. The
621 provider APIs operate just as they do with the original operations.
622
623 Because the server processing is different however, there may be some
624 behavior differences primarily because the client now controls the speed of
625 delivery of objects.
626
627 In previous versions of Pegasus, the server attempts to deliver objects as
628 rapidly as then can be put on the network. In the case of HTTP chunked requests
629 they are delivered in chunks of about 100 objects. The primary delay for the
630 providers was the processing of each segment through the server. The server
631 is blocked so that no other segment can proceed through the server until that
632 segment is processed and sent on the network.
633 In the case of non-chunkedresponses, they are completely gathered in the serve
634 and then delivered as one non-chunked response. There were no delays for the
635 providers, just lots of possible memory use in the server.
636
637 The responses from providers (delivered through the deliver(...) interface are
638 karl 1.1.2.1 gathered into segments of about 100 objects and this group of objects is moved
639 through the server to be delivered to the client.
640
641 However with the inclusion of the pull operations, The segments of objects
642 from the providers are cached in the server response path until the
643 maxObjectCount for that request (open or pull) and that number returned in a
644 non-chunked response. Thus, if the client is slow to issue pull requests,
645 the providers might be delayed at some point to reduce memory usage in the
646 server (the delay appears as slow response tothe deliver operation).
647
648 In other words, the time to process large sets of responses from the provider
649 now depends on the speed of handling the client.
650
651 It is important to remember in developing providers that the Pegasus server
652 can most efficiently process responses if they are passed from the provider
653 to the server individually or in small arrays of objects rather than the
654 provider gathering very large arrays of objects and sending them to the
655 server.
656
|
657 karl 1.1.2.2 NEXT GENERATION PROVIDERS
658 KS_TODO
659
|
660 karl 1.1.2.1 CONFIGURATION PARAMETERS
661
662 The server includes several configuration parameters to set limits on the
663 processing of pull operations. All of these configuration parameters are
664 compile time parameters rather than runtime.
665
666 1. Maximum value of minimum interoperation time. This parameter defines the
667 maximum time allowed between the return of an open or pull response and
668 the receipt of the next pull or a close operation before the server may
669 close the enumeration. The specification allows the server to set a
670 maximum interoperation time and refuse open requests that with requested
671 operationTimeout greater than that time.
672 CIM_ERR_INVALID_OPERATION_TIMEOUT
673
674 This value is set with the Pegasus environment variable
675 PEGASUS_PULL....
676
677 2. Maximum objects returned in a single open or pull operation. The server
678 can set a maximum limit on the number of objects that can be returned in
679 a single open or pull oepration with the maxObjectCount parameter.
680
681 karl 1.1.2.1 3. Whether the server allows 0 as an interoperation timeout value. The value
682 zero is s special value for the interoperationTimeout in that it tells the
683 server to not timeout any enumeration sequence.
684
685 With this value for interoperationTimeout, the only way to close an
686 enumeration sequence is to complete all of the pulls or issue the close.
687 If for some reason the sequence is not completed, that enumeration context
688 would remain open indefinitly. Since in Pegasus any open enumeration
689 context uses resources (the context object and any provider resposnes that
690 have not yet been issued in a response) it would appear that most
691 platforms would not want to allow the existence of enumeration contexts
692 that cannot be closed by the server.
693
694 4, maximum consecutive pull requests with 0 maxObjectCount. The use of the
695 pull operation with maxObjectCount set to zero could be used to keep an
696 enumeration context open indefinitly (this tells the server to restart the
697 interoperationTimeout but not send any objects in the response). Therefore the
698 specification allows for the server setting maximum limits on this behavior
699 and returning the error CIM_ERR_SERVER_LIMITS_EXCEEDED if this limit is
700 exceeded.
701 Note that this is maximum CONSECUTIVE pulls so that issuing a pull with
702 karl 1.1.2.1 a non-zero count resets this counter.
703
704 KS-TBD - Is this really logical since we can still block by just issuing
705 lots of zero request and an occansional request for one object.
706
707 Pegaus sets the value of this limit to 1000 and allows the implementer to
708 modify it with the PEGASUS_MAXIMUM_ZERO_OBJECTCOUNT environment variable.
709
710 5. Default operationTimeout -
711
712 The default of this parameter is to refuse operat
713
714 In the current release of Pegasus these are all compile time parameters.
|
715 karl 1.1.2.11
716
717 NOTES On working with task branch.
718
719 Merge out Process
720
721 To keep our TASK branch in sync with the current head of tree we need
722 to do a regular merge out. the TaskMakefile contains the makefile
723 procedures to do this efficiently. NOTE: Following these procedures is
724 important in that you are merging out new material each time you do
725 the merge out. If you were just to repeatedly merge out, you would be
726 merging previously merged changes a second time causing a real mess.
727
728 Start with new directory and put TaskMakefile above pegasus (needed so you
729 have this file for the initial operations.
730
731 make -f TaskMakefile branch_merge_out BNAME=PEP317-pullop ## takes a long time
732
733 This checks out current head, merges it into task branch and sets tags
734 for the mergeout. Note that at the end of this step this work is
735 part of the TASK... branch.
736 karl 1.1.2.11
737 NOW check for conflicts, errors, etc. that resulted from the merge.
738 Look for conflict flags, compare the results (I use linux merge as a
739 good graphic compare tool) and build and test. When you are satisfied
740 that the merge out is clean, you can commit the results to the TASK...
741 branch
742
743 To commit the work to this into Task branch
744
745 make -f mak/TaskMakefile branch_merge_out_commit BNAME=PEP317-pullop
746
747 or manually commit and finish as follows
748
749 cvs commit
750 make -f mak/TaskMakefile branch_merge_out_finish BNAME=PEP317-pullop
751
752 ## This last step is important since it cleans up temporary tags to prepare
753 you for the next checkout
754
755 COMPARE TASKBRANCH WITH HEAD
756
757 karl 1.1.2.11 In a new pegasus work space do same as above for merge out.
758
759 make -f TaskMakefile BNAME=PEP317-pullop
760
761 This produces a result which is all of the head merged into the branch.
762 A diff of this is all the new changes to the head of tree that you will
763 include into the merge.
764
|
Return to
readme.pulloperations
CVS log
Up to [Pegasus] / pegasus