#include <petsc/private/petscimpl.h> /*I "petscsys.h" I*/

/* Logging support */
PetscLogEvent PETSC_Barrier;

/*@C
    PetscBarrier - Blocks until this routine is executed by all processors owning the object `obj`.

   Input Parameters:
.  obj - PETSc object  (`Mat`, `Vec`, `IS`, `SNES` etc...)
        The object must be cast with a (`PetscObject`). `NULL` can be used to indicate the barrier should be across `PETSC_COMM_WORLD`

  Level: intermediate

  Developer Note:
  This routine calls `MPI_Barrier()` with the communicator of the `PetscObject`

  Fortran Note:
    You may pass `PETSC_NULL_VEC` or any other PETSc null object, such as `PETSC_NULL_MAT`, to indicate the barrier should be
    across `PETSC_COMM_WORLD`. You can also pass in any PETSc object, `Vec`, `Mat`, etc

@*/
PetscErrorCode PetscBarrier(PetscObject obj)
{
  MPI_Comm comm;

  PetscFunctionBegin;
  if (obj) PetscValidHeader(obj, 1);
  PetscCall(PetscLogEventBegin(PETSC_Barrier, obj, 0, 0, 0));
  if (obj) PetscCall(PetscObjectGetComm(obj, &comm));
  else comm = PETSC_COMM_WORLD;
  PetscCallMPI(MPI_Barrier(comm));
  PetscCall(PetscLogEventEnd(PETSC_Barrier, obj, 0, 0, 0));
  PetscFunctionReturn(PETSC_SUCCESS);
}