(file) Return to readme.pulloperations CVS log (file) (dir) Up to [Pegasus] / pegasus

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

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2