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

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2