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

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2