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