source: trunk/kernel/kern/chdev.c @ 428

Last change on this file since 428 was 428, checked in by alain, 4 years ago

blip

File size: 13.3 KB
Line 
1/*
2 * chdev.c - channel device descriptor operations implementation.
3 *
4 * Authors  Alain Greiner   (2016)
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#include <kernel_config.h>
25#include <hal_types.h>
26#include <hal_special.h>
27#include <hal_irqmask.h>
28#include <printk.h>
29#include <boot_info.h>
30#include <xlist.h>
31#include <kmem.h>
32#include <scheduler.h>
33#include <thread.h>
34#include <rpc.h>
35#include <chdev.h>
36#include <devfs.h>
37
38
39extern chdev_directory_t    chdev_dir;   // allocated in kernel_init.c
40
41#if CONFIG_READ_DEBUG
42extern uint32_t enter_chdev_cmd;
43extern uint32_t exit_chdev_cmd;
44extern uint32_t enter_chdev_server;
45extern uint32_t exit_chdev_server;
46#endif
47
48////////////////////////////////////////////
49char * chdev_func_str( uint32_t func_type ) 
50{
51        if     ( func_type == DEV_FUNC_RAM ) return "RAM";
52        else if( func_type == DEV_FUNC_ROM ) return "ROM";
53        else if( func_type == DEV_FUNC_FBF ) return "FBF";
54        else if( func_type == DEV_FUNC_IOB ) return "IOB";
55        else if( func_type == DEV_FUNC_IOC ) return "IOC";
56        else if( func_type == DEV_FUNC_MMC ) return "MMC";
57        else if( func_type == DEV_FUNC_DMA ) return "DMA";
58        else if( func_type == DEV_FUNC_NIC ) return "NIC";
59        else if( func_type == DEV_FUNC_TIM ) return "TIM";
60        else if( func_type == DEV_FUNC_TXT ) return "TXT";
61        else if( func_type == DEV_FUNC_ICU ) return "ICU";
62        else if( func_type == DEV_FUNC_PIC ) return "PIC";
63    else                                 return "undefined";
64}
65
66/////////////////////////////////////////
67chdev_t * chdev_create( uint32_t    func,
68                        uint32_t    impl,
69                        uint32_t    channel,
70                        uint32_t    is_rx,
71                        xptr_t      base )
72{
73    chdev_t    * chdev;
74    kmem_req_t   req;
75
76    // allocate memory for chdev
77    req.type   = KMEM_DEVICE;
78    req.flags  = AF_ZERO;
79    chdev      = (chdev_t *)kmem_alloc( &req );
80
81    if( chdev == NULL ) return NULL;
82
83    // initialize waiting threads queue and associated lock
84    remote_spinlock_init( XPTR( local_cxy , &chdev->wait_lock ) );
85    xlist_root_init( XPTR( local_cxy , &chdev->wait_root ) );
86
87    // initialize attributes
88    chdev->func    =  func;
89    chdev->impl    =  impl;
90    chdev->channel =  channel;
91    chdev->is_rx   =  is_rx;
92    chdev->base    =  base; 
93
94    return chdev;
95
96}  // end chdev_create()
97
98///////////////////////////////////
99void chdev_print( chdev_t * chdev )
100{
101    printk("\n - func      = %s"
102           "\n - channel   = %d"
103           "\n - base      = %l"
104           "\n - cmd       = %x"
105           "\n - isr       = %x"
106           "\n - chdev     = %x\n",
107           chdev_func_str(chdev->func),
108           chdev->channel,
109           chdev->base,
110           chdev->cmd,
111           chdev->isr,
112           chdev );
113}
114
115//////////////////////////////////////////////////
116void chdev_register_command( xptr_t     chdev_xp )
117{
118    thread_t * server_ptr;    // local pointer on server thread associated to chdev
119    core_t   * core_ptr;      // local pointer on core running the server thread
120    uint32_t   lid;           // core running the server thread local index
121    xptr_t     lock_xp;       // extended pointer on lock protecting the chdev queue
122    uint32_t   different;     // non zero if server thread core != client thread core
123    uint32_t   save_sr;       // for critical section
124
125#if CONFIG_READ_DEBUG
126enter_chdev_cmd = hal_time_stamp();
127#endif
128
129    thread_t * this = CURRENT_THREAD;
130
131chdev_dmsg("\n[DBG] %s : core[%x,%d] (thread %s) enter / cycle %d\n",
132__FUNCTION__, local_cxy, this->core->lid, thread_type_str(this->type) , hal_time_stamp() );
133
134    // get device descriptor cluster and local pointer
135    cxy_t     chdev_cxy = GET_CXY( chdev_xp );
136    chdev_t * chdev_ptr = (chdev_t *)GET_PTR( chdev_xp );
137
138    // build extended pointers on client thread xlist and device root
139    xptr_t  list_xp = XPTR( local_cxy , &this->wait_list );
140    xptr_t  root_xp = XPTR( chdev_cxy , &chdev_ptr->wait_root );
141
142    // get local pointer on server thread
143    server_ptr = (thread_t *)hal_remote_lpt( XPTR( chdev_cxy , &chdev_ptr->server) );
144
145chdev_dmsg("\n[DBG] %s : core[%x,%d] (thread %s) / server_cxy %x / server_ptr %x / server_type %\n",
146__FUNCTION__, local_cxy, this->core->lid, server_cxy, server_ptr,
147thread_type_str( hal_remote_lw( XPTR( server_cxy , &server_ptr->type) ) ) );
148
149    // build extended pointer on chdev lock protecting queue
150    lock_xp = XPTR( chdev_cxy , &chdev_ptr->wait_lock );
151
152    // get local pointer on core running the server thread
153    core_ptr = (core_t *)hal_remote_lpt( XPTR( chdev_cxy , &server_ptr->core ) );
154
155    // get core local index
156    lid = hal_remote_lw( XPTR( chdev_cxy , &core_ptr->lid ) );
157
158    // compute server core != thread core
159    different = (lid != this->core->lid) || (local_cxy != chdev_cxy);
160
161    // enter critical section to make atomic :
162    // (1) client blocking
163    // (2) client registration in server queue
164    // (3) IPI to force server scheduling
165    // (4) descheduling
166    // ... in this order
167    hal_disable_irq( &save_sr );
168
169    // block current thread
170    thread_block( CURRENT_THREAD , THREAD_BLOCKED_IO );
171
172    // register client thread in waiting queue
173    remote_spinlock_lock( lock_xp );
174    xlist_add_last( root_xp , list_xp );
175    remote_spinlock_unlock( lock_xp );
176
177    // send IPI to core running the server thread if required
178    if( different ) dev_pic_send_ipi( chdev_cxy , lid ); 
179   
180chdev_dmsg("\n[DBG] %s : core[%x,%d] (thread %s) deschedules / cycle %d\n",
181__FUNCTION__, local_cxy, this->core->lid, thread_type_str(this->type) , hal_time_stamp() );
182
183    // deschedule
184    assert( thread_can_yield( this ) , __FUNCTION__ , "illegal sched_yield\n" );
185    sched_yield("blocked on I/O");
186
187chdev_dmsg("\n[DBG] %s : core[%x,%d] (thread %s) resumes / cycle %d\n",
188__FUNCTION__, local_cxy, this->core->lid, thread_type_str(this->type) , hal_time_stamp() );
189
190    // exit critical section
191    hal_restore_irq( save_sr );
192
193#if CONFIG_READ_DEBUG
194exit_chdev_cmd = hal_time_stamp();
195#endif
196
197}  // end chdev_register_command()
198
199///////////////////////////////////////////////
200void chdev_sequencial_server( chdev_t * chdev )
201{
202    xptr_t          client_xp;    // extended pointer on waiting thread
203    cxy_t           client_cxy;   // cluster of client thread
204    thread_t      * client_ptr;   // local pointer on client thread
205    thread_t      * server;       // local pointer on server thread
206    xptr_t          root_xp;      // extended pointer on device waiting queue root
207    xptr_t          lock_xp;      // extended pointer on lock ptotecting chdev queue
208
209    server = CURRENT_THREAD;
210
211chdev_dmsg("\n[DBG] %s : enter / server = %x / chdev = %x / cycle %d\n",
212__FUNCTION__ , server , chdev , hal_time_stamp() );
213
214    root_xp = XPTR( local_cxy , &chdev->wait_root );
215    lock_xp = XPTR( local_cxy , &chdev->wait_lock );
216
217        // This infinite loop is executed by the DEV thread
218    // to handle commands registered in the chdev queue.
219    while( 1 )
220    {
221        // get the lock protecting the waiting queue
222        remote_spinlock_lock( lock_xp );
223
224        // check waiting queue state
225        if( xlist_is_empty( root_xp ) ) // waiting queue empty
226        {
227            // release lock
228            remote_spinlock_unlock( lock_xp );
229
230chdev_dmsg("\n[DBG] %s : thread %x deschedule /cycle %d\n",
231__FUNCTION__ , server , hal_time_stamp() );
232
233            // deschedule
234            sched_yield("I/O queue empty");
235
236chdev_dmsg("\n[DBG] %s : thread %x resume /cycle %d\n",
237__FUNCTION__ , server , hal_time_stamp() );
238
239        } 
240        else                            // waiting queue not empty
241        {
242
243#if CONFIG_READ_DEBUG
244enter_chdev_server = hal_time_stamp();
245#endif
246            // release lock
247            remote_spinlock_unlock( lock_xp );
248
249            // get extended pointer on first client thread
250            client_xp = XLIST_FIRST_ELEMENT( root_xp , thread_t , wait_list );
251
252            // get client thread cluster, local pointer, and identifier
253            client_cxy = GET_CXY( client_xp );
254            client_ptr = (thread_t *)GET_PTR( client_xp );
255
256            // call driver command function to execute I/O operation
257            chdev->cmd( client_xp );
258       
259            // remove the client thread from waiting queue
260            remote_spinlock_lock( lock_xp );
261            xlist_unlink( XPTR( client_cxy , &client_ptr->wait_list ) );
262            remote_spinlock_unlock( lock_xp );
263
264            // unblock client thread
265            thread_unblock( client_xp , THREAD_BLOCKED_IO );
266
267chdev_dmsg("\n[DBG] %s : thread %x complete operation for client %x / cycle %d\n",
268__FUNCTION__ , server , client_ptr , hal_time_stamp() );
269
270#if CONFIG_READ_DEBUG
271exit_chdev_server = hal_time_stamp();
272#endif
273
274        }
275    }  // end while
276}  // end chdev_sequencial_server()
277
278////////////////////////////////////////
279xptr_t chdev_from_file( xptr_t file_xp )
280{
281    cxy_t         file_cxy;
282    vfs_file_t  * file_ptr;
283    uint32_t      inode_type;
284    vfs_inode_t * inode_ptr;
285    chdev_t     * chdev_ptr;
286
287    // get cluster and local pointer on remote file descriptor
288    // associated inode and chdev are stored in same cluster as the file desc.
289    file_cxy  = GET_CXY( file_xp );
290    file_ptr  = (vfs_file_t *)GET_PTR( file_xp );
291
292    // get inode type from file descriptor
293    inode_type = hal_remote_lw( XPTR( file_cxy , &file_ptr->type ) );
294    inode_ptr  = (vfs_inode_t *)hal_remote_lpt( XPTR( file_cxy , &file_ptr->inode ) );
295
296    assert( (inode_type == INODE_TYPE_DEV) , __FUNCTION__ ,
297    "inode type %d is not INODE_TYPE_DEV", inode_type );
298
299    // get chdev local pointer from inode extension
300    chdev_ptr = (chdev_t *)hal_remote_lpt( XPTR( file_cxy , &inode_ptr->extend ) );
301
302    return XPTR( file_cxy , chdev_ptr );
303
304}  // end chdev_from_file()
305
306////////////////////////
307void chdev_dir_display()
308{
309    uint32_t  i;
310    cxy_t     cxy;
311    chdev_t * ptr;
312    uint32_t  base;
313    reg_t     save_sr;
314
315    // get pointers on TXT0 chdev
316    xptr_t    txt0_xp  = chdev_dir.txt_tx[0];
317    cxy_t     txt0_cxy = GET_CXY( txt0_xp );
318    chdev_t * txt0_ptr = GET_PTR( txt0_xp );
319
320    // get extended pointer on remote TXT0 chdev lock
321    xptr_t  lock_xp = XPTR( txt0_cxy , &txt0_ptr->wait_lock );
322
323    // get TXT0 lock in busy waiting mode
324    remote_spinlock_lock_busy( lock_xp , &save_sr );
325
326    // header
327    nolock_printk("\n***** external chdevs directory *****\n");
328
329    // IOB
330    cxy  = GET_CXY( chdev_dir.iob );
331    ptr  = GET_PTR( chdev_dir.iob );
332    base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
333    nolock_printk("  - iob       : cxy = %X / ptr = %X / base = %X\n", cxy, ptr, base);
334
335    // PIC
336    cxy  = GET_CXY( chdev_dir.pic );
337    ptr  = GET_PTR( chdev_dir.pic );
338    base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
339    nolock_printk("  - pic       : cxy = %X / ptr = %X / base = %X\n", cxy, ptr, base);
340
341    // TXT
342    for( i = 0 ; i < LOCAL_CLUSTER->nb_txt_channels ; i++ )
343    {
344        cxy = GET_CXY( chdev_dir.txt_rx[i] );
345        ptr = GET_PTR( chdev_dir.txt_rx[i] );
346        base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
347        nolock_printk("  - txt_rx[%d] : cxy = %X / ptr = %X / base = %X\n", i, cxy, ptr, base);
348
349        cxy = GET_CXY( chdev_dir.txt_tx[i] );
350        ptr = GET_PTR( chdev_dir.txt_tx[i] );
351        base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
352        nolock_printk("  - txt_tx[%d] : cxy = %X / ptr = %X / base = %X\n", i, cxy, ptr, base);
353    }
354
355    // IOC
356    for( i = 0 ; i < LOCAL_CLUSTER->nb_ioc_channels ; i++ )
357    {
358        cxy = GET_CXY( chdev_dir.ioc[i] );
359        ptr = GET_PTR( chdev_dir.ioc[i] );
360        base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
361        nolock_printk("  - ioc[%d]    : cxy = %X / ptr = %X / base = %X\n", i, cxy, ptr, base);
362    }
363
364    // FBF
365    for( i = 0 ; i < LOCAL_CLUSTER->nb_fbf_channels ; i++ )
366    {
367        cxy  = GET_CXY( chdev_dir.fbf[i] );
368        ptr  = GET_PTR( chdev_dir.fbf[i] );
369        base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
370        nolock_printk("  - fbf[%d]    : cxy = %X / ptr = %X / base = %X\n", i, cxy, ptr, base);
371    }
372
373    // NIC
374    for( i = 0 ; i < LOCAL_CLUSTER->nb_nic_channels ; i++ )
375    {
376        cxy = GET_CXY( chdev_dir.nic_rx[i] );
377        ptr = GET_PTR( chdev_dir.nic_rx[i] );
378        base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
379        nolock_printk("  - nic_rx[%d] : cxy = %X / ptr = %X / base = %X\n", i, cxy, ptr, base);
380
381        cxy = GET_CXY( chdev_dir.nic_tx[i] );
382        ptr = GET_PTR( chdev_dir.nic_tx[i] );
383        base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
384        nolock_printk("  - nic_tx[%d] : cxy = %X / ptr = %X / base = %X\n", i, cxy, ptr, base);
385    }
386
387    // release lock
388    remote_spinlock_unlock_busy( lock_xp , save_sr );
389
390}  // end chdev_dir_display()
391
Note: See TracBrowser for help on using the repository browser.