libgomp/barrier.c

/* Copyright (C) 2005-2026 Free Software Foundation, Inc.
   Contributed by Richard Henderson <rth@redhat.com>.

   This file is part of the GNU Offloading and Multi Processing Library
   (libgomp).

   Libgomp is free software; you can redistribute it and/or modify it
   under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3, or (at your option)
   any later version.

   Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
   FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
   more details.

   Under Section 7 of GPL version 3, you are granted additional
   permissions described in the GCC Runtime Library Exception, version
   3.1, as published by the Free Software Foundation.

   You should have received a copy of the GNU General Public License and
   a copy of the GCC Runtime Library Exception along with this program;
   see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
   <http://www.gnu.org/licenses/>.  */

/* This file handles the BARRIER construct.  */

#include "libgomp.h"

/* GOMP_barrier is no longer called by new code; it is only kept for
   backward compatibility. New code uses GOMP_barrier_ext.  */

void
GOMP_barrier (void)
{
  struct gomp_thread *thr = gomp_thread ();
  struct gomp_team *team = thr->ts.team;

  /* It is legal to have orphaned barriers.  */
  if (team == NULL)
    return;

  gomp_team_barrier_wait (&team->barrier);
}

void
GOMP_barrier_ext (int kind __attribute__ ((unused)))
{
  struct gomp_thread *thr = gomp_thread ();
  struct gomp_team *team = thr->ts.team;

  /* It is legal to have orphaned barriers.  */
  if (team == NULL)
    return;

  gomp_team_barrier_wait (&team->barrier);
}

/* GOMP_barrier_cancel is no longer called by new code; it is only kept for
   backward compatibility. New code uses GOMP_barrier_cancel_ext.  */

bool
GOMP_barrier_cancel (void)
{
  struct gomp_thread *thr = gomp_thread ();
  struct gomp_team *team = thr->ts.team;

  /* The compiler transforms to barrier_cancel when it sees that the
     barrier is within a construct that can cancel.  Thus we should
     never have an orphaned cancellable barrier.  */
  return gomp_team_barrier_wait_cancel (&team->barrier);
}

bool
GOMP_barrier_cancel_ext (int kind __attribute__ ((unused)))
{
  struct gomp_thread *thr = gomp_thread ();
  struct gomp_team *team = thr->ts.team;

  /* The compiler transforms to barrier_cancel when it sees that the
     barrier is within a construct that can cancel.  Thus we should
     never have an orphaned cancellable barrier.  */
  return gomp_team_barrier_wait_cancel (&team->barrier);
}