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

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

Introduce the chdev_queue_display() function.

File size: 17.9 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_remote.h>
28#include <hal_irqmask.h>
29#include <printk.h>
30#include <boot_info.h>
31#include <xlist.h>
32#include <kmem.h>
33#include <scheduler.h>
34#include <thread.h>
35#include <rpc.h>
36#include <chdev.h>
37#include <devfs.h>
38
39
40extern chdev_directory_t    chdev_dir;   // allocated in kernel_init.c
41
42#if (DEBUG_SYS_READ & 1)
43extern uint32_t enter_chdev_cmd_read;
44extern uint32_t exit_chdev_cmd_read;
45extern uint32_t enter_chdev_server_read;
46extern uint32_t exit_chdev_server_read;
47#endif
48
49#if (DEBUG_SYS_WRITE & 1)
50extern uint32_t enter_chdev_cmd_write;
51extern uint32_t exit_chdev_cmd_write;
52extern uint32_t enter_chdev_server_write;
53extern uint32_t exit_chdev_server_write;
54#endif
55
56////////////////////////////////////////////
57char * chdev_func_str( uint32_t func_type ) 
58{
59        if     ( func_type == DEV_FUNC_RAM ) return "RAM";
60        else if( func_type == DEV_FUNC_ROM ) return "ROM";
61        else if( func_type == DEV_FUNC_FBF ) return "FBF";
62        else if( func_type == DEV_FUNC_IOB ) return "IOB";
63        else if( func_type == DEV_FUNC_IOC ) return "IOC";
64        else if( func_type == DEV_FUNC_MMC ) return "MMC";
65        else if( func_type == DEV_FUNC_DMA ) return "DMA";
66        else if( func_type == DEV_FUNC_NIC ) return "NIC";
67        else if( func_type == DEV_FUNC_TIM ) return "TIM";
68        else if( func_type == DEV_FUNC_TXT ) return "TXT";
69        else if( func_type == DEV_FUNC_ICU ) return "ICU";
70        else if( func_type == DEV_FUNC_PIC ) return "PIC";
71    else                                 return "undefined";
72}
73
74/////////////////////////////////////////
75chdev_t * chdev_create( uint32_t    func,
76                        uint32_t    impl,
77                        uint32_t    channel,
78                        uint32_t    is_rx,
79                        xptr_t      base )
80{
81    chdev_t    * chdev;
82    kmem_req_t   req;
83
84    // allocate memory for chdev
85    req.type   = KMEM_DEVICE;
86    req.flags  = AF_ZERO;
87    chdev      = (chdev_t *)kmem_alloc( &req );
88
89    if( chdev == NULL ) return NULL;
90
91    // initialize waiting threads queue and associated lock
92    remote_spinlock_init( XPTR( local_cxy , &chdev->wait_lock ) );
93    xlist_root_init( XPTR( local_cxy , &chdev->wait_root ) );
94
95    // initialize attributes
96    chdev->func    =  func;
97    chdev->impl    =  impl;
98    chdev->channel =  channel;
99    chdev->is_rx   =  is_rx;
100    chdev->base    =  base; 
101
102    return chdev;
103
104}  // end chdev_create()
105
106///////////////////////////////////
107void chdev_print( chdev_t * chdev )
108{
109    printk("\n - func      = %s"
110           "\n - channel   = %d"
111           "\n - base      = %l"
112           "\n - cmd       = %x"
113           "\n - isr       = %x"
114           "\n - chdev     = %x\n",
115           chdev_func_str(chdev->func),
116           chdev->channel,
117           chdev->base,
118           chdev->cmd,
119           chdev->isr,
120           chdev );
121}
122
123//////////////////////////////////////////////////
124void chdev_register_command( xptr_t     chdev_xp )
125{
126    thread_t * server_ptr;    // local pointer on server thread associated to chdev
127    xptr_t     server_xp;     // extended pointer on server thread
128    core_t   * core_ptr;      // local pointer on core running the server thread
129    uint32_t   lid;           // core running the server thread local index
130    xptr_t     lock_xp;       // extended pointer on lock protecting the chdev queue
131    uint32_t   different;     // non zero if server thread core != client thread core
132    uint32_t   save_sr;       // for critical section
133
134#if (DEBUG_SYS_READ & 1)
135enter_chdev_cmd_read = (uint32_t)hal_get_cycles();
136#endif
137
138#if (DEBUG_SYS_WRITE & 1)
139enter_chdev_cmd_write = (uint32_t)hal_get_cycles();
140#endif
141
142    thread_t * this = CURRENT_THREAD;
143
144    // get chdev cluster and local pointer
145    cxy_t     chdev_cxy = GET_CXY( chdev_xp );
146    chdev_t * chdev_ptr = GET_PTR( chdev_xp );
147
148    // get local and extended pointers on server thread
149    server_ptr = (thread_t *)hal_remote_lpt( XPTR( chdev_cxy , &chdev_ptr->server) );
150    server_xp  = XPTR( chdev_cxy , server_ptr );
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 server core local index
156    lid = hal_remote_lw( XPTR( chdev_cxy , &core_ptr->lid ) );
157
158#if (DEBUG_CHDEV_CMD_RX || DEBUG_CHDEV_CMD_TX)
159bool_t is_rx = hal_remote_lw( XPTR( chdev_cxy , &chdev_ptr->is_rx ) );
160#endif
161   
162#if DEBUG_CHDEV_CMD_RX
163uint32_t rx_cycle = (uint32_t)hal_get_cycles();
164if( (is_rx) && (DEBUG_CHDEV_CMD_RX < rx_cycle) )
165printk("\n[DBG] %s : client_thread %x (%s) enter for RX / cycle %d\n",
166__FUNCTION__, this, thread_type_str(this->type) , rx_cycle );
167#endif
168
169#if DEBUG_CHDEV_CMD_TX
170uint32_t tx_cycle = (uint32_t)hal_get_cycles();
171if( (is_rx == 0) && (DEBUG_CHDEV_CMD_TX < tx_cycle) )
172printk("\n[DBG] %s : client_thread %x (%s) enter for TX / cycle %d\n",
173__FUNCTION__, this, thread_type_str(this->type) , tx_cycle );
174#endif
175
176    // build extended pointer on client thread xlist
177    xptr_t  list_xp    = XPTR( local_cxy , &this->wait_list );
178
179    // build extended pointer on chdev waiting queue root
180    xptr_t  root_xp    = XPTR( chdev_cxy , &chdev_ptr->wait_root );
181
182    // build extended pointer on server thread blocked state
183    xptr_t  blocked_xp = XPTR( chdev_cxy , &server_ptr->blocked );
184
185    // build extended pointer on lock protecting chdev waiting queue
186    lock_xp = XPTR( chdev_cxy , &chdev_ptr->wait_lock );
187
188    // critical section for the following sequence:
189    // (1) take the lock protecting waiting queue
190    // (2) block the client thread
191    // (3) unblock the server thread if required
192    // (4) register client thread in server queue
193    // (5) send IPI to force server scheduling
194    // (6) release the lock protecting waiting queue
195    // (7) deschedule
196    // ... in this order
197
198    // enter critical section
199    hal_disable_irq( &save_sr );
200
201    // take the lock protecting chdev waiting queue
202    remote_spinlock_lock( lock_xp );
203
204    // block current thread
205    thread_block( XPTR( local_cxy , CURRENT_THREAD ) , THREAD_BLOCKED_IO );
206
207    // unblock server thread if required
208    if( hal_remote_lw( blocked_xp ) & THREAD_BLOCKED_IDLE )
209    thread_unblock( server_xp , THREAD_BLOCKED_IDLE );
210
211    // register client thread in waiting queue
212    xlist_add_last( root_xp , list_xp );
213
214    // send IPI to core running the server thread when server != client
215    different = (lid != this->core->lid) || (local_cxy != chdev_cxy);
216    if( different ) dev_pic_send_ipi( chdev_cxy , lid ); 
217   
218    // release lock
219    remote_spinlock_unlock( lock_xp );
220
221    // deschedule
222    assert( thread_can_yield( this ) , __FUNCTION__ , "illegal sched_yield\n" );
223    sched_yield("blocked on I/O");
224
225    // exit critical section
226    hal_restore_irq( save_sr );
227
228#if DEBUG_CHDEV_CMD_RX
229rx_cycle = (uint32_t)hal_get_cycles();
230if( (is_rx) && (DEBUG_CHDEV_CMD_RX < rx_cycle) )
231printk("\n[DBG] %s : client_thread %x (%s) exit for RX / cycle %d\n",
232__FUNCTION__, this, thread_type_str(this->type) , rx_cycle );
233#endif
234
235#if DEBUG_CHDEV_CMD_TX
236tx_cycle = (uint32_t)hal_get_cycles();
237if( (is_rx == 0) && (DEBUG_CHDEV_CMD_TX < tx_cycle) )
238printk("\n[DBG] %s : client_thread %x (%s) exit for TX / cycle %d\n",
239__FUNCTION__, this, thread_type_str(this->type) , tx_cycle );
240#endif
241
242#if (DEBUG_SYS_READ & 1)
243exit_chdev_cmd_read = (uint32_t)hal_get_cycles();
244#endif
245
246#if (DEBUG_SYS_WRITE & 1)
247exit_chdev_cmd_write = (uint32_t)hal_get_cycles();
248#endif
249
250}  // end chdev_register_command()
251
252///////////////////////////////////////////////
253void chdev_sequencial_server( chdev_t * chdev )
254{
255    xptr_t          client_xp;    // extended pointer on waiting thread
256    cxy_t           client_cxy;   // cluster of client thread
257    thread_t      * client_ptr;   // local pointer on client thread
258    thread_t      * server;       // local pointer on server thread
259    xptr_t          root_xp;      // extended pointer on device waiting queue root
260    xptr_t          lock_xp;      // extended pointer on lock ptotecting chdev queue
261
262    server = CURRENT_THREAD;
263
264    // get root and lock on command queue
265    root_xp = XPTR( local_cxy , &chdev->wait_root );
266    lock_xp = XPTR( local_cxy , &chdev->wait_lock );
267
268        // This infinite loop is executed by the DEV thread
269    // to handle commands registered in the chdev queue.
270    while( 1 )
271    {
272        // get the lock protecting the waiting queue
273        remote_spinlock_lock( lock_xp );
274
275        // check waiting queue state
276        if( xlist_is_empty( root_xp ) ) // waiting queue empty
277        {
278            // release lock
279            remote_spinlock_unlock( lock_xp );
280
281            // block
282            thread_block( XPTR( local_cxy , server ) , THREAD_BLOCKED_IDLE ); 
283
284            // deschedule
285            assert( thread_can_yield( server ) , __FUNCTION__ , "illegal sched_yield\n" );
286            sched_yield("I/O queue empty");
287        } 
288        else                            // waiting queue not empty
289        {
290            // get extended pointer on first client thread
291            client_xp = XLIST_FIRST_ELEMENT( root_xp , thread_t , wait_list );
292
293            // get client thread cluster and local pointer
294            client_cxy = GET_CXY( client_xp );
295            client_ptr = GET_PTR( client_xp );
296
297            // remove this first client thread from waiting queue
298            xlist_unlink( XPTR( client_cxy , &client_ptr->wait_list ) );
299
300            // release lock
301            remote_spinlock_unlock( lock_xp );
302
303#if DEBUG_CHDEV_SERVER_RX
304uint32_t rx_cycle = (uint32_t)hal_get_cycles();
305if( (chdev->is_rx) && (DEBUG_CHDEV_SERVER_RX < rx_cycle) )
306printk("\n[DBG] %s : server_thread %x start RX / client %x / cycle %d\n",
307__FUNCTION__ , server , client_ptr , rx_cycle );
308#endif
309
310#if DEBUG_CHDEV_SERVER_TX
311uint32_t tx_cycle = (uint32_t)hal_get_cycles();
312if( (chdev->is_rx == 0) && (DEBUG_CHDEV_SERVER_TX < tx_cycle) )
313printk("\n[DBG] %s : server_thread %x start TX / client %x / cycle %d\n",
314__FUNCTION__ , server , client_ptr , tx_cycle );
315#endif
316
317#if (DEBUG_SYS_READ & 1)
318enter_chdev_server_read = (uint32_t)hal_get_cycles();
319#endif
320
321#if (DEBUG_SYS_WRITE & 1)
322enter_chdev_server_write = (uint32_t)hal_get_cycles();
323#endif
324
325            // call driver command function to execute I/O operation
326            chdev->cmd( client_xp );
327       
328            // unblock client thread
329            thread_unblock( client_xp , THREAD_BLOCKED_IO );
330
331#if DEBUG_CHDEV_SERVER_RX
332rx_cycle = (uint32_t)hal_get_cycles();
333if( (chdev->is_rx) && (DEBUG_CHDEV_SERVER_RX < rx_cycle) )
334printk("\n[DBG] %s : server_thread %x completes RX / client %x / cycle %d\n",
335__FUNCTION__ , server , client_ptr , rx_cycle );
336#endif
337
338#if DEBUG_CHDEV_SERVER_TX
339tx_cycle = (uint32_t)hal_get_cycles();
340if( (chdev->is_rx == 0) && (DEBUG_CHDEV_SERVER_TX < tx_cycle) )
341printk("\n[DBG] %s : server_thread %x completes TX / client %x / cycle %d\n",
342__FUNCTION__ , server , client_ptr , tx_cycle );
343#endif
344
345#if (DEBUG_SYS_READ & 1)
346exit_chdev_server_read = (uint32_t)hal_get_cycles();
347#endif
348
349#if (DEBUG_SYS_WRITE & 1)
350exit_chdev_server_write = (uint32_t)hal_get_cycles();
351#endif
352
353        }
354    }  // end while
355}  // end chdev_sequencial_server()
356
357////////////////////////////////////////
358xptr_t chdev_from_file( xptr_t file_xp )
359{
360    cxy_t         file_cxy;
361    vfs_file_t  * file_ptr;
362    uint32_t      inode_type;
363    vfs_inode_t * inode_ptr;
364    chdev_t     * chdev_ptr;
365
366    assert( (file_xp != XPTR_NULL) , __FUNCTION__,
367    "file_xp == XPTR_NULL\n" );
368
369    // get cluster and local pointer on remote file descriptor
370    // associated inode and chdev are stored in same cluster as the file desc.
371    file_cxy  = GET_CXY( file_xp );
372    file_ptr  = (vfs_file_t *)GET_PTR( file_xp );
373
374    // get inode type from file descriptor
375    inode_type = hal_remote_lw( XPTR( file_cxy , &file_ptr->type ) );
376    inode_ptr  = (vfs_inode_t *)hal_remote_lpt( XPTR( file_cxy , &file_ptr->inode ) );
377
378    assert( (inode_type == INODE_TYPE_DEV) , __FUNCTION__ ,
379    "inode type %d is not INODE_TYPE_DEV\n", inode_type );
380
381    // get chdev local pointer from inode extension
382    chdev_ptr = (chdev_t *)hal_remote_lpt( XPTR( file_cxy , &inode_ptr->extend ) );
383
384    return XPTR( file_cxy , chdev_ptr );
385
386}  // end chdev_from_file()
387
388////////////////////////
389void chdev_dir_display()
390{
391    uint32_t  i;
392    cxy_t     cxy;
393    chdev_t * ptr;
394    uint32_t  base;
395    reg_t     save_sr;
396
397    // get pointers on TXT0 chdev
398    xptr_t    txt0_xp  = chdev_dir.txt_tx[0];
399    cxy_t     txt0_cxy = GET_CXY( txt0_xp );
400    chdev_t * txt0_ptr = GET_PTR( txt0_xp );
401
402    // get extended pointer on remote TXT0 chdev lock
403    xptr_t  lock_xp = XPTR( txt0_cxy , &txt0_ptr->wait_lock );
404
405    // get TXT0 lock in busy waiting mode
406    remote_spinlock_lock_busy( lock_xp , &save_sr );
407
408    // header
409    nolock_printk("\n***** external chdevs directory *****\n");
410
411    // IOB
412    cxy  = GET_CXY( chdev_dir.iob );
413    ptr  = GET_PTR( chdev_dir.iob );
414    base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
415    nolock_printk("  - iob       : cxy = %X / ptr = %X / base = %X\n", cxy, ptr, base);
416
417    // PIC
418    cxy  = GET_CXY( chdev_dir.pic );
419    ptr  = GET_PTR( chdev_dir.pic );
420    base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
421    nolock_printk("  - pic       : cxy = %X / ptr = %X / base = %X\n", cxy, ptr, base);
422
423    // TXT
424    for( i = 0 ; i < LOCAL_CLUSTER->nb_txt_channels ; i++ )
425    {
426        cxy = GET_CXY( chdev_dir.txt_rx[i] );
427        ptr = GET_PTR( chdev_dir.txt_rx[i] );
428        base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
429        nolock_printk("  - txt_rx[%d] : cxy = %X / ptr = %X / base = %X\n", i, cxy, ptr, base);
430
431        cxy = GET_CXY( chdev_dir.txt_tx[i] );
432        ptr = GET_PTR( chdev_dir.txt_tx[i] );
433        base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
434        nolock_printk("  - txt_tx[%d] : cxy = %X / ptr = %X / base = %X\n", i, cxy, ptr, base);
435    }
436
437    // IOC
438    for( i = 0 ; i < LOCAL_CLUSTER->nb_ioc_channels ; i++ )
439    {
440        cxy = GET_CXY( chdev_dir.ioc[i] );
441        ptr = GET_PTR( chdev_dir.ioc[i] );
442        base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
443        nolock_printk("  - ioc[%d]    : cxy = %X / ptr = %X / base = %X\n", i, cxy, ptr, base);
444    }
445
446    // FBF
447    for( i = 0 ; i < LOCAL_CLUSTER->nb_fbf_channels ; i++ )
448    {
449        cxy  = GET_CXY( chdev_dir.fbf[i] );
450        ptr  = GET_PTR( chdev_dir.fbf[i] );
451        base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
452        nolock_printk("  - fbf[%d]    : cxy = %X / ptr = %X / base = %X\n", i, cxy, ptr, base);
453    }
454
455    // NIC
456    for( i = 0 ; i < LOCAL_CLUSTER->nb_nic_channels ; i++ )
457    {
458        cxy = GET_CXY( chdev_dir.nic_rx[i] );
459        ptr = GET_PTR( chdev_dir.nic_rx[i] );
460        base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
461        nolock_printk("  - nic_rx[%d] : cxy = %X / ptr = %X / base = %X\n", i, cxy, ptr, base);
462
463        cxy = GET_CXY( chdev_dir.nic_tx[i] );
464        ptr = GET_PTR( chdev_dir.nic_tx[i] );
465        base = (uint32_t)hal_remote_lwd( XPTR( cxy , &ptr->base ) );
466        nolock_printk("  - nic_tx[%d] : cxy = %X / ptr = %X / base = %X\n", i, cxy, ptr, base);
467    }
468
469    // release lock
470    remote_spinlock_unlock_busy( lock_xp , save_sr );
471
472}  // end chdev_dir_display()
473
474///////////////////////////////////////////
475void chdev_queue_display( xptr_t chdev_xp )
476{
477    cxy_t       chdev_cxy;          // chdev cluster
478    chdev_t   * chdev_ptr;          // chdev local pointer
479    xptr_t      root_xp;            // extended pointer on waiting queuue root
480    char        name[16];           // local copie of chdev name
481    xptr_t      iter_xp;            // extended pointer on xlist_t field in waiting thread
482    xptr_t      thread_xp;          // extended pointer on thread registered in queue
483    cxy_t       thread_cxy;         // cluster identifier for waiting thread
484    thread_t  * thread_ptr;         // local pointer on waiting thread
485    trdid_t     trdid;              // waiting thread identifier
486    process_t * process;            // waiting thread process descriptor
487    pid_t       pid;                // waiting thread process identifier
488
489    // get cluster and local pointer on chdev
490    chdev_cxy = GET_CXY( chdev_xp );
491    chdev_ptr = GET_PTR( chdev_xp );
492
493    // get extended pointer on root of requests queue
494    root_xp = hal_remote_lwd( XPTR( chdev_cxy , &chdev_ptr->wait_root ) );
495
496    // get chdev name
497    hal_remote_strcpy( XPTR( local_cxy , name ), XPTR( chdev_cxy , chdev_ptr->name ) );
498
499    // check queue empty
500    if( xlist_is_empty( root_xp ) )
501    {
502        printk("\n***** Waiting queue empty for chdev %s\n", name ); 
503    }
504    else
505    {
506        printk("\n***** Waiting queue for chdev %s\n", name ); 
507
508        // scan the waiting queue
509        XLIST_FOREACH( root_xp , iter_xp )
510        {
511            thread_xp  = XLIST_ELEMENT( iter_xp , thread_t , wait_list );
512            thread_cxy = GET_CXY( thread_xp );
513            thread_ptr = GET_PTR( thread_xp );
514            trdid      = hal_remote_lw ( XPTR( thread_cxy , &thread_ptr->trdid   ) );
515            process    = hal_remote_lpt( XPTR( thread_cxy , &thread_ptr->process ) );
516                        pid        = hal_remote_lw ( XPTR( thread_cxy , &process->pid        ) );
517
518            printk("- trdid %X / pid %X\n", trdid, pid );
519        }
520    }
521}  // end chdev_queue_display()
522
Note: See TracBrowser for help on using the repository browser.