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

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2