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