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