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