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

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2