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

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2