[thirdparty/gcc.git] / gcc / doc / gccint / gimple / tuple-specific-accessors / gimpleompparallel.rst

..
  Copyright 1988-2022 Free Software Foundation, Inc.
  This is part of the GCC manual.
  For copying conditions, see the copyright.rst file.

.. index:: GIMPLE_OMP_PARALLEL

GIMPLE_OMP_PARALLEL
^^^^^^^^^^^^^^^^^^^

.. function:: gomp_parallel *gimple_build_omp_parallel (gimple_seq body, tree clauses, tree child_fn, tree data_arg)

  Build a ``GIMPLE_OMP_PARALLEL`` statement.

  ``BODY`` is sequence of statements which are executed in parallel.
  ``CLAUSES``, are the ``OMP`` parallel construct's clauses.  ``CHILD_FN`` is
  the function created for the parallel threads to execute.
  ``DATA_ARG`` are the shared data argument(s).

.. function:: bool gimple_omp_parallel_combined_p (gimple g)

  Return true if ``OMP`` parallel statement ``G`` has the
  ``GF_OMP_PARALLEL_COMBINED`` flag set.

.. function:: void gimple_omp_parallel_set_combined_p (gimple g)

  Set the ``GF_OMP_PARALLEL_COMBINED`` field in ``OMP`` parallel statement
  ``G``.

.. function:: gimple_seq gimple_omp_body (gimple g)

  Return the body for the ``OMP`` statement ``G``.

.. function:: void gimple_omp_set_body (gimple g, gimple_seq body)

  Set ``BODY`` to be the body for the ``OMP`` statement ``G``.

.. function:: tree gimple_omp_parallel_clauses (gimple g)

  Return the clauses associated with ``OMP_PARALLEL`` ``G``.

.. function:: tree * gimple_omp_parallel_clauses_ptr ( gomp_parallel *g)

  Return a pointer to the clauses associated with ``OMP_PARALLEL`` ``G``.

.. function:: void gimple_omp_parallel_set_clauses ( gomp_parallel *g, tree clauses)

  Set ``CLAUSES`` to be the list of clauses associated with
  ``OMP_PARALLEL`` ``G``.

.. function:: tree gimple_omp_parallel_child_fn ( const gomp_parallel *g)

  Return the child function used to hold the body of ``OMP_PARALLEL``
  ``G``.

.. function:: tree * gimple_omp_parallel_child_fn_ptr ( gomp_parallel *g)

  Return a pointer to the child function used to hold the body of
  ``OMP_PARALLEL`` ``G``.

.. function:: void gimple_omp_parallel_set_child_fn ( gomp_parallel *g, tree child_fn)

  Set ``CHILD_FN`` to be the child function for ``OMP_PARALLEL`` ``G``.

.. function:: tree gimple_omp_parallel_data_arg ( const gomp_parallel *g)

  Return the artificial argument used to send variables and values
  from the parent to the children threads in ``OMP_PARALLEL`` ``G``.

.. function:: tree * gimple_omp_parallel_data_arg_ptr ( gomp_parallel *g)

  Return a pointer to the data argument for ``OMP_PARALLEL`` ``G``.

.. function:: void gimple_omp_parallel_set_data_arg ( gomp_parallel *g, tree data_arg)

  Set ``DATA_ARG`` to be the data argument for ``OMP_PARALLEL`` ``G``.
Commit	Line	Data
c63539ff ML	1	..
	2	Copyright 1988-2022 Free Software Foundation, Inc.
	3	This is part of the GCC manual.
	4	For copying conditions, see the copyright.rst file.
	5
	6	.. index:: GIMPLE_OMP_PARALLEL
	7
	8	GIMPLE_OMP_PARALLEL
	9	^^^^^^^^^^^^^^^^^^^
	10
	11	.. function:: gomp_parallel *gimple_build_omp_parallel (gimple_seq body, tree clauses, tree child_fn, tree data_arg)
	12
	13	Build a ``GIMPLE_OMP_PARALLEL`` statement.
	14
	15	``BODY`` is sequence of statements which are executed in parallel.
	16	``CLAUSES``, are the ``OMP`` parallel construct's clauses. ``CHILD_FN`` is
	17	the function created for the parallel threads to execute.
	18	``DATA_ARG`` are the shared data argument(s).
	19
	20	.. function:: bool gimple_omp_parallel_combined_p (gimple g)
	21
	22	Return true if ``OMP`` parallel statement ``G`` has the
	23	``GF_OMP_PARALLEL_COMBINED`` flag set.
	24
	25	.. function:: void gimple_omp_parallel_set_combined_p (gimple g)
	26
	27	Set the ``GF_OMP_PARALLEL_COMBINED`` field in ``OMP`` parallel statement
	28	``G``.
	29
	30	.. function:: gimple_seq gimple_omp_body (gimple g)
	31
	32	Return the body for the ``OMP`` statement ``G``.
	33
	34	.. function:: void gimple_omp_set_body (gimple g, gimple_seq body)
	35
	36	Set ``BODY`` to be the body for the ``OMP`` statement ``G``.
	37
	38	.. function:: tree gimple_omp_parallel_clauses (gimple g)
	39
	40	Return the clauses associated with ``OMP_PARALLEL`` ``G``.
	41
	42	.. function:: tree * gimple_omp_parallel_clauses_ptr ( gomp_parallel *g)
	43
	44	Return a pointer to the clauses associated with ``OMP_PARALLEL`` ``G``.
	45
	46	.. function:: void gimple_omp_parallel_set_clauses ( gomp_parallel *g, tree clauses)
	47
	48	Set ``CLAUSES`` to be the list of clauses associated with
	49	``OMP_PARALLEL`` ``G``.
	50
	51	.. function:: tree gimple_omp_parallel_child_fn ( const gomp_parallel *g)
	52
	53	Return the child function used to hold the body of ``OMP_PARALLEL``
	54	``G``.
	55
	56	.. function:: tree * gimple_omp_parallel_child_fn_ptr ( gomp_parallel *g)
	57
	58	Return a pointer to the child function used to hold the body of
	59	``OMP_PARALLEL`` ``G``.
	60
	61	.. function:: void gimple_omp_parallel_set_child_fn ( gomp_parallel *g, tree child_fn)
	62
	63	Set ``CHILD_FN`` to be the child function for ``OMP_PARALLEL`` ``G``.
	64
65	.. function:: tree gimple_omp_parallel_data_arg ( const gomp_parallel *g)
66
67	Return the artificial argument used to send variables and values
68	from the parent to the children threads in ``OMP_PARALLEL`` ``G``.
69
70	.. function:: tree * gimple_omp_parallel_data_arg_ptr ( gomp_parallel *g)
71
72	Return a pointer to the data argument for ``OMP_PARALLEL`` ``G``.
73
74	.. function:: void gimple_omp_parallel_set_data_arg ( gomp_parallel *g, tree data_arg)
75
3ed1b4ce	76	Set ``DATA_ARG`` to be the data argument for ``OMP_PARALLEL`` ``G``.