~ubuntu-branches/ubuntu/vivid/mpich/vivid-proposed

« back to all changes in this revision

Viewing changes to man/man3/MPI_T_init_thread.3

  • Committer: Package Import Robot
  • Author(s): Anton Gladky
  • Date: 2014-04-01 20:24:20 UTC
  • mfrom: (5.2.4 sid)
  • Revision ID: package-import@ubuntu.com-20140401202420-t5ey1ia2klt5dkq3
Tags: 3.1-4
* [c3e3398] Disable test_primitives, which is unreliable on some platforms.
            (Closes: #743047)
* [265a699] Add minimal autotest.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH MPI_T_init_thread 3 "4/24/2013" " " "MPI"
 
1
.TH MPI_T_init_thread 3 "2/20/2014" " " "MPI"
2
2
.SH NAME
3
 
MPI_T_init_thread \-  XXX description here 
 
3
MPI_T_init_thread \-  Initialize the MPI_T execution environment 
4
4
.SH SYNOPSIS
5
5
.nf
6
6
int MPI_T_init_thread(int required, int *provided)
19
19
- provided level of thread support (integer)
20
20
.PD 1
21
21
 
 
22
.SH NOTES
 
23
.SH THE VALID VALUES FOR THE LEVEL OF THREAD SUPPORT ARE
 
24
.PD 0
 
25
.TP
 
26
.B MPI_THREAD_SINGLE 
 
27
- Only one thread will execute.
 
28
.PD 1
 
29
.PD 0
 
30
.TP
 
31
.B MPI_THREAD_FUNNELED 
 
32
- The process may be multi-threaded, but only the main
 
33
thread will make MPI_T calls (all MPI_T calls are funneled to the
 
34
main thread).
 
35
.PD 1
 
36
.PD 0
 
37
.TP
 
38
.B MPI_THREAD_SERIALIZED 
 
39
- The process may be multi-threaded, and multiple
 
40
threads may make MPI_T calls, but only one at a time: MPI_T calls are not
 
41
made concurrently from two distinct threads (all MPI_T calls are serialized).
 
42
.PD 1
 
43
.PD 0
 
44
.TP
 
45
.B MPI_THREAD_MULTIPLE 
 
46
- Multiple threads may call MPI_T, with no restrictions.
 
47
.PD 1
 
48
 
22
49
.SH THREAD AND INTERRUPT SAFETY
23
50
 
24
51
This routine is thread-safe.  This means that this routine may be
28
55
.I malloc
29
56
or other non-MPICH runtime routines that are themselves not interrupt-safe.
30
57
 
31
 
.SH NOTES FOR FORTRAN
32
 
All MPI routines in Fortran (except for 
33
 
.I MPI_WTIME
34
 
and 
35
 
.I MPI_WTICK
36
 
) have
37
 
an additional argument 
38
 
.I ierr
39
 
at the end of the argument list.  
40
 
.I ierr
41
 
is an integer and has the same meaning as the return value of the routine
42
 
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
43
 
.I call
44
 
statement.
45
 
 
46
 
All MPI objects (e.g., 
47
 
.I MPI_Datatype
48
 
49
 
.I MPI_Comm
50
 
) are of type 
51
 
.I INTEGER
52
 
in Fortran.
53
 
 
54
58
.SH ERRORS
55
59
 
56
60
All MPI routines (except 
80
84
an error; however, MPI implementations will attempt to continue whenever
81
85
possible.
82
86
 
 
87
.PD 0
 
88
.TP
 
89
.B MPI_SUCCESS 
 
90
- No error; MPI routine completed successfully.
 
91
.PD 1
 
92
 
 
93
.SH SEE ALSO
 
94
MPI_T_finalize
 
95
.br
83
96
.SH LOCATION
84
 
src/mpi_t/mpit_init_thread.c
 
97
/tmp/gyCYfBi4J6/mpich-3.1/src/mpi_t/mpit_initthread.c