/*=========================================================================

  Program:   ParaView
  Module:    vtkPVSessionCore.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
/**
 * @class   vtkPVSessionCore
 *
 * vtkPVSessionCore is used by vtkSMSession.
 * vtkPVSessionCore handle the communication to MPI satellites and
 * ServerImplementation code instantiation and execution.
 * On the other hand, the vtkSMSession dispatch the request to the right
 * process and therefore to the right vtkPVSessionCore instance.
*/

#ifndef vtkPVSessionCore_h
#define vtkPVSessionCore_h

#include "vtkObject.h"
#include "vtkPVServerImplementationCoreModule.h" //needed for exports
#include "vtkSMMessageMinimal.h"                 // needed for vtkSMMessage.
#include "vtkWeakPointer.h"                      // needed for vtkMultiProcessController

class vtkClientServerInterpreter;
class vtkClientServerStream;
class vtkCollection;
class vtkMPIMToNSocketConnection;
class vtkMultiProcessController;
class vtkPVInformation;
class vtkSIObject;
class vtkSIProxyDefinitionManager;

class VTKPVSERVERIMPLEMENTATIONCORE_EXPORT vtkPVSessionCore : public vtkObject
{
public:
  static vtkPVSessionCore* New();
  vtkTypeMacro(vtkPVSessionCore, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  //@{
  /**
   * Provides access to the interpreter.
   */
  vtkGetObjectMacro(Interpreter, vtkClientServerInterpreter);
  //@}

  //@{
  /**
   * Provides access to the proxy definition manager.
   */
  vtkGetObjectMacro(ProxyDefinitionManager, vtkSIProxyDefinitionManager);
  //@}

  /**
   * Push the state message.
   * This might forward the message to the MPI statellites if needed.
   */
  virtual void PushState(vtkSMMessage* message);

  /**
   * Pull the state message from the local SI object instances.
   */
  virtual void PullState(vtkSMMessage* message);

  /**
   * Execute a command on the given processes. Use GetLastResult() to obtain the
   * last result after the command stream is evaluated. Once can set
   * \c ignore_errors to true, to ignore any interpreting errors.
   */
  virtual void ExecuteStream(
    vtkTypeUInt32 location, const vtkClientServerStream& stream, bool ignore_errors = false);

  /**
   * Returns the response of the ExecuteStream() call from the location. Note if
   * location refers to multiple processes, then the reply is only fetched from
   * the "closest" process.
   */
  virtual const vtkClientServerStream& GetLastResult();

  /**
   * Notify that the given SIObject is not used anymore .
   * This does not necessary delete the SIObject specially if this one is
   * used by other local SIObject. It only decrease its reference count.
   */
  virtual void UnRegisterSIObject(vtkSMMessage* message);

  /**
   * Notify that the given SIObject is used.
   * It only increase its reference count.
   */
  virtual void RegisterSIObject(vtkSMMessage* message);

  /**
   * Returns a vtkSIObject or subclass given its global id, if any otherwise
   * return NULL;
   */
  vtkSIObject* GetSIObject(vtkTypeUInt32 globalid);

  /**
   * Return a vtkObject given its global id if any otherwise return NULL;
   */
  vtkObject* GetRemoteObject(vtkTypeUInt32 globalid);

  /**
   * Register a remote object
   */
  void RegisterRemoteObject(vtkTypeUInt32 globalid, vtkObject* obj);

  /**
   * Unregister a remote object
   */
  void UnRegisterRemoteObject(vtkTypeUInt32 globalid);

  /**
   * Gather information about an object referred by the \c globalid.
   * \c location identifies the processes to gather the information from.
   */
  virtual bool GatherInformation(
    vtkTypeUInt32 location, vtkPVInformation* information, vtkTypeUInt32 globalid);

  /**
   * Returns the number of processes. This simply calls the
   * GetNumberOfProcesses() on this->ParallelController
   */
  int GetNumberOfProcesses();

  //@{
  /**
   * Get/Set the socket connection used to communicate between data=server and
   * render-server processes. This is valid only on data-server and
   * render-server processes.
   */
  void SetMPIMToNSocketConnection(vtkMPIMToNSocketConnection*);
  vtkGetObjectMacro(MPIMToNSocketConnection, vtkMPIMToNSocketConnection);
  //@}

  /**
   * Provides the next available identifier. This implementation works locally.
   * without any code distribution. To support the distributed architecture
   * the vtkSMSessionClient override those method to call them on the DATA_SERVER
   * vtkPVSessionBase instance.
   */
  virtual vtkTypeUInt32 GetNextGlobalUniqueIdentifier();

  /**
   * Return the first Id of the requested chunk.
   * 1 = ReverveNextIdChunk(10); | Reserved ids [1,2,3,4,5,6,7,8,9,10]
   * 11 = ReverveNextIdChunk(10);| Reserved ids [11,12,13,14,15,16,17,18,19,20]
   * b = a + 10;
   */
  virtual vtkTypeUInt32 GetNextChunkGlobalUniqueIdentifier(vtkTypeUInt32 chunkSize);

  enum MessageTypes
  {
    PUSH_STATE = 12,
    PULL_STATE = 13,
    EXECUTE_STREAM = 14,
    GATHER_INFORMATION = 15,
    REGISTER_SI = 16,
    UNREGISTER_SI = 17,
  };
  // Methods used to managed MPI satellite
  void PushStateSatelliteCallback();
  void ExecuteStreamSatelliteCallback();
  void GatherInformationStatelliteCallback();
  void RegisterSIObjectSatelliteCallback();
  void UnRegisterSIObjectSatelliteCallback();

  /**
   * Allow the user to fill a vtkCollection with all RemoteObjects
   * This is useful when you want to hold a reference to them to
   * prevent any deletion across several method call.
   */
  virtual void GetAllRemoteObjects(vtkCollection* collection);

  /**
   * Delete SIObject that are held by clients that disappeared
   * from the given list.
   */
  void GarbageCollectSIObject(int* clientIds, int nbClients);

protected:
  vtkPVSessionCore();
  ~vtkPVSessionCore() override;

  /**
   * This will create a vtkSIObject and/or execute some update on the
   * vtkObject that it own.
   */
  virtual void PushStateInternal(vtkSMMessage*);

  /**
   * This will execute localy the given vtkClientServerStream either by
   * calling method on the vtkSIObject or its internal vtkObject.
   */
  virtual void ExecuteStreamInternal(const vtkClientServerStream& stream, bool ignore_errors);

  /**
   * This will gather information on the local vtkObjects
   * through the local vtkSIObjects.
   */
  bool GatherInformationInternal(vtkPVInformation* information, vtkTypeUInt32 globalid);

  /**
   * Gather information across MPI satellites.
   */
  bool CollectInformation(vtkPVInformation*);

  /**
   * Increment reference count of a local vtkSIObject.
   */
  virtual void RegisterSIObjectInternal(vtkSMMessage* message);

  /**
   * Decrement reference count of a local vtkSIObject. This might not result
   * in an actual deletion of the object if this one is used by another
   * SIObject.
   */
  virtual void UnRegisterSIObjectInternal(vtkSMMessage* message);

  /**
   * Callback for reporting interpreter errors.
   */
  void OnInterpreterError(vtkObject*, unsigned long, void* calldata);

  enum
  {
    ROOT_SATELLITE_RMI_TAG = 887822,
    ROOT_SATELLITE_INFO_TAG = 887823
  };

  vtkSIProxyDefinitionManager* ProxyDefinitionManager;
  vtkWeakPointer<vtkMultiProcessController> ParallelController;
  vtkClientServerInterpreter* Interpreter;
  vtkMPIMToNSocketConnection* MPIMToNSocketConnection;

private:
  vtkPVSessionCore(const vtkPVSessionCore&) = delete;
  void operator=(const vtkPVSessionCore&) = delete;

  class vtkInternals;
  vtkInternals* Internals;
  bool SymmetricMPIMode;

  // Local counter for global Ids
  vtkTypeUInt32 LocalGlobalID;

  ostream* LogStream;
};

#endif
