source: trunk/kernel/syscalls/shared_include/shared_pthread.h @ 581

Last change on this file since 581 was 581, checked in by alain, 3 years ago

1) Improve the busylock debug infrastructure.
2) introduce a non-distributed, but portable implementation for the pthread_barrier.

File size: 6.2 KB
Line 
1/*
2 * shared_pthread.h - Shared structures and mnemonics used by the pthread related syscalls.
3 *
4 * Author  Alain Greiner (2016,2017,2018)
5 *
6 * Copyright (c) UPMC Sorbonne Universites
7 *
8 * This file is part of ALMOS-MKH.
9 *
10 * ALMOS-MKH is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2.0 of the License.
13 *
14 * ALMOS-MKH is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24#ifndef _SHARED_PTHREAD_H_
25#define _SHARED_PTHREAD_H_
26
27/*******************************************************************************************
28 *    This file defines the types and mnemonics that are shared by the kernel
29 *    and by the <pthread> user level library.
30 ******************************************************************************************/
31
32
33/*******************************************************************************************
34 * These typedef and enum define the shared information related to the POSIX thread.
35 ******************************************************************************************/
36
37typedef unsigned int    pthread_t;               
38
39typedef struct pthread_attr_s
40{
41        unsigned int        attributes;      /*! user defined attributes bit vector           */
42        unsigned int        cxy;             /*! target cluster identifier                    */
43        unsigned int        lid;             /*! target core local index                      */
44}
45pthread_attr_t;
46
47enum
48{
49    PT_ATTR_DETACH          = 0x0001,    /*! user defined not joinable                    */
50    PT_ATTR_CLUSTER_DEFINED = 0x0002,    /*! user defined target cluster                  */
51    PT_ATTR_CORE_DEFINED    = 0x0004,    /*! user defined core index in cluster           */
52};
53
54/*******************************************************************************************
55 * These typedef and enum define the shared informations related to the POSIX mutex.
56 ******************************************************************************************/
57
58typedef unsigned int    pthread_mutex_t;
59
60typedef unsigned int    pthread_mutexattr_t;         // TODO not implemented
61
62typedef enum
63{
64        MUTEX_INIT,
65        MUTEX_DESTROY,
66        MUTEX_LOCK,
67        MUTEX_UNLOCK,
68    MUTEX_TRYLOCK,
69} 
70mutex_operation_t;
71
72/*******************************************************************************************
73 * These typedef and enum define the shared informations related to the POSIX condvar.
74 ******************************************************************************************/
75
76typedef unsigned int    pthread_cond_t;
77
78typedef unsigned int    pthread_condattr_t;          // TODO not implemented
79
80typedef enum
81{
82        CONDVAR_INIT,
83        CONDVAR_DESTROY,
84    CONDVAR_WAIT,
85    CONDVAR_SIGNAL,
86    CONDVAR_BROADCAST,
87} 
88condvar_operation_t;
89
90/*******************************************************************************************
91 * These typedef define and enum the shared informations related to the POSIX rwlock.
92 ******************************************************************************************/
93
94typedef unsigned int    pthread_rwlock_t;            // TODO not implemented
95
96typedef unsigned int    pthread_rwlockattr_t;        // TODO not implemented
97
98/*******************************************************************************************
99 * These typedef and enum define the shared informations related to POSIX barriers.
100 ******************************************************************************************/
101
102typedef unsigned int    pthread_barrier_t;
103
104typedef struct pthread_barrierattr_s
105{
106    unsigned int        x_size;         /*! number of clusters in a row                   */
107    unsigned int        y_size;         /*! number of clusters in a column                */
108    unsigned int        nthreads;       /*! number of expected threads in a cluster       */
109}
110pthread_barrierattr_t;
111
112typedef enum
113{
114        BARRIER_INIT,
115        BARRIER_DESTROY,
116        BARRIER_WAIT,
117} 
118barrier_operation_t;
119
120/*********************************************************************************************
121 * These structures define another implementation for the POSIX barrier:
122 * It is implemented as a hierarchical, physically distributed quad-tree,
123 * covering all clusters specified, with the following constraints:
124 *   . The involved clusters form a mesh [x_size * y_size]
125 *   . The lower left involved cluster is cluster(0,0) 
126 *   . The number of threads per cluster is the same in all clusters.
127 *
128 * Implementation note:
129 * - The quad three is implemented as a three dimensions array of node[x][y][l]
130 *   . [x][y] are the cluster coordinates / max values are (QDT_XMAX-1), (QDT_YMAX-1)
131 *   . [l] is the node level / 0 for terminal nodes / (QDT_LMAX-1) for the root node
132 ********************************************************************************************/
133
134/*
135
136#define  QDT_XMAX    16                // max number of clusters in a row
137#define  QDT_YMAX    16                // max number of clusters in a column
138#define  QDT_LMAX    5                 // max depth of the quad tree
139#define  QDT_YWIDTH  4                 // Y field in cxy, for cxy <=> (x,y) translation
140#define  QDT_YMASK   0xF               // Y field in cxy, for cxy <=> (x,y) translation
141
142typedef struct sqt_node_s
143{
144    volatile unsigned int sense;       // barrier state (toggle)
145    volatile unsigned int count;       // number of not arrived tasks
146    unsigned int          arity;       // number of locally expected tasks
147    unsigned int          level;       // hierarchical level (0 is bottom)
148    struct sqt_node_s   * parent;      // pointer on parent node (NULL for root)
149    struct sqt_node_s   * child[4];    // pointer on children node (NULL for bottom)
150}
151sqt_node_t;
152
153typedef struct pthread_barrier_s
154{
155    sqt_node_t          * node[QDT_XMAX][QDT_YMAX][QDT_LMAX];
156}
157pthread_barrier_t;
158
159*/
160
161#endif  // _PTHREAD_H_
Note: See TracBrowser for help on using the repository browser.