Code coverage tests

This page documents the degree to which the PARI/GP source code is tested by our public test suite, distributed with the source distribution in directory src/test/. This is measured by the gcov utility; we then process gcov output using the lcov frond-end.

We test a few variants depending on Configure flags on the pari.math.u-bordeaux1.fr machine (x86_64 architecture), and agregate them in the final report:

The target is 90% coverage for all mathematical modules (given that branches depending on DEBUGLEVEL or DEBUGMEM are not covered). This script is run to produce the results below.

LCOV - code coverage report
Current view: top level - mt - pthread.c (source / functions) Hit Total Coverage
Test: PARI/GP v2.8.0 lcov report (development 17411-5d2797e) Lines: 154 166 92.8 %
Date: 2015-01-31 Functions: 14 15 93.3 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 55 72 76.4 %

           Branch data     Line data    Source code
       1                 :            : /* Copyright (C) 2013  The PARI group.
       2                 :            : 
       3                 :            : This file is part of the PARI/GP package.
       4                 :            : 
       5                 :            : PARI/GP is free software; you can redistribute it and/or modify it under the
       6                 :            : terms of the GNU General Public License as published by the Free Software
       7                 :            : Foundation. It is distributed in the hope that it will be useful, but WITHOUT
       8                 :            : ANY WARRANTY WHATSOEVER.
       9                 :            : 
      10                 :            : Check the License for details. You should have received a copy of it, along
      11                 :            : with the package; see the file 'COPYING'. If not, write to the Free Software
      12                 :            : Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */
      13                 :            : #include "pari.h"
      14                 :            : #include "paripriv.h"
      15                 :            : #include "mt.h"
      16                 :            : #include <pthread.h>
      17                 :            : 
      18                 :            : struct mt_queue
      19                 :            : {
      20                 :            :   long no;
      21                 :            :   pari_sp avma;
      22                 :            :   GEN input, output;
      23                 :            :   GEN worker;
      24                 :            :   long workid;
      25                 :            :   pthread_cond_t cond;
      26                 :            :   pthread_mutex_t mut;
      27                 :            :   pthread_cond_t *pcond;
      28                 :            :   pthread_mutex_t *pmut;
      29                 :            : };
      30                 :            : 
      31                 :            : struct mt_pstate
      32                 :            : {
      33                 :            :   pthread_t *th;
      34                 :            :   struct pari_thread *pth;
      35                 :            :   struct mt_queue *mq;
      36                 :            :   long n, nbint, last;
      37                 :            :   long pending;
      38                 :            :   pthread_cond_t pcond;
      39                 :            :   pthread_mutex_t pmut;
      40                 :            : };
      41                 :            : 
      42                 :            : static THREAD long mt_thread_no = -1;
      43                 :            : static struct mt_pstate *pari_mt;
      44                 :            : 
      45                 :            : #define LOCK(x) pthread_mutex_lock(x); do
      46                 :            : #define UNLOCK(x) while(0); pthread_mutex_unlock(x)
      47                 :            : 
      48                 :            : void
      49                 :   41546141 : mt_sigint_block(void)
      50                 :            : {
      51         [ +  + ]:   41546141 :   if (mt_thread_no>=0)
      52                 :      64049 :     pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED,NULL);
      53                 :   41546215 : }
      54                 :            : 
      55                 :            : void
      56                 :   41546177 : mt_sigint_unblock(void)
      57                 :            : {
      58         [ +  + ]:   41546177 :   if (mt_thread_no>=0)
      59                 :      64069 :     pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS,NULL);
      60                 :   41546240 : }
      61                 :            : 
      62                 :            : void
      63                 :        821 : mt_err_recover(long er)
      64                 :            : {
      65                 :            :   (void) er;
      66         [ +  + ]:        821 :   if (mt_thread_no>=0)
      67                 :            :   {
      68                 :          2 :     struct mt_pstate *mt = pari_mt;
      69                 :          2 :     struct mt_queue *mq = mt->mq+mt_thread_no;
      70                 :          2 :     LOCK(mq->pmut)
      71                 :            :     {
      72                 :          2 :       mq->output = pari_err_last();
      73                 :          2 :       pthread_cond_signal(mq->pcond);
      74                 :          2 :     } UNLOCK(mq->pmut);
      75                 :          2 :     pthread_exit((void*)1);
      76                 :            :   }
      77                 :        819 : }
      78                 :            : 
      79                 :            : void
      80                 :          0 : mt_sigint(void)
      81                 :            : {
      82         [ #  # ]:          0 :   if (pari_mt) pthread_cond_broadcast(&pari_mt->pcond);
      83                 :          0 : }
      84                 :            : 
      85                 :            : int
      86                 :     187131 : mt_is_parallel(void)
      87                 :            : {
      88                 :     187131 :   return !!pari_mt;
      89                 :            : }
      90                 :            : 
      91                 :            : int
      92                 :    5596988 : mt_is_thread(void)
      93                 :            : {
      94                 :    5596988 :   return mt_thread_no>=0;
      95                 :            : }
      96                 :            : 
      97                 :          1 : void mt_broadcast(GEN code) {(void) code;}
      98                 :            : 
      99                 :        177 : void pari_mt_init(void)
     100                 :            : {
     101                 :        177 :   pari_mt = NULL;
     102                 :            : #ifdef _SC_NPROCESSORS_CONF
     103                 :        177 :   pari_mt_nbthreads = sysconf(_SC_NPROCESSORS_CONF);
     104                 :            : #else
     105                 :            :   pari_mt_nbthreads = 1;
     106                 :            : #endif
     107                 :        177 : }
     108                 :            : 
     109                 :        177 : void pari_mt_close(void) { }
     110                 :            : 
     111                 :            : static void*
     112                 :        248 : mt_queue_run(void *arg)
     113                 :            : {
     114                 :        248 :   GEN args = pari_thread_start((struct pari_thread*) arg);
     115                 :        286 :   pari_sp av = avma;
     116                 :        286 :   struct mt_queue *mq = (struct mt_queue *) args;
     117                 :        286 :   mt_thread_no = mq->no;
     118                 :        286 :   LOCK(mq->pmut)
     119                 :            :   {
     120                 :        288 :     mq->avma = av;
     121                 :        288 :     pthread_cond_signal(mq->pcond);
     122                 :        288 :   } UNLOCK(mq->pmut);
     123                 :            :   for(;;)
     124                 :            :   {
     125                 :            :     GEN work, done;
     126                 :       6827 :     LOCK(&mq->mut)
     127                 :            :     {
     128         [ +  + ]:      13000 :       while(!mq->input)
     129                 :       6440 :         pthread_cond_wait(&mq->cond, &mq->mut);
     130                 :       6560 :     } UNLOCK(&mq->mut);
     131                 :       6566 :     avma = mq->avma;
     132                 :       6566 :     work = mq->input;
     133                 :       6566 :     pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS,NULL);
     134                 :       6569 :     done = closure_callgenvec(mq->worker,work);
     135                 :       6510 :     pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED,NULL);
     136                 :       6532 :     LOCK(mq->pmut)
     137                 :            :     {
     138                 :       6540 :       mq->avma = av;
     139                 :       6540 :       mq->input = NULL;
     140                 :       6540 :       mq->output = done;
     141                 :       6540 :       pthread_cond_signal(mq->pcond);
     142                 :       6540 :     } UNLOCK(mq->pmut);
     143                 :       6539 :   }
     144                 :            : }
     145                 :            : 
     146                 :            : static long
     147                 :      17078 : mt_queue_check(struct mt_pstate *mt)
     148                 :            : {
     149                 :            :   long i;
     150         [ +  + ]:     232976 :   for(i=0; i<mt->n; i++)
     151                 :            :   {
     152                 :     222440 :     struct mt_queue *mq = mt->mq+i;
     153         [ +  + ]:     222440 :     if (mq->output) return i;
     154                 :            :   }
     155                 :      17078 :   return -1;
     156                 :            : }
     157                 :            : 
     158                 :            : static GEN
     159                 :       6734 : mtpthread_queue_get(struct mt_state *junk, long *workid, long *pending)
     160                 :            : {
     161                 :       6734 :   struct mt_pstate *mt = pari_mt;
     162                 :            :   struct mt_queue *mq;
     163                 :       6734 :   GEN done = NULL;
     164                 :            :   long last;
     165                 :            :   (void) junk;
     166         [ +  + ]:       6734 :   if (mt->nbint<mt->n) { mt->last = mt->nbint; *pending = mt->pending; return NULL; }
     167         [ +  + ]:       6542 :   if ((last = mt_queue_check(mt)) < 0)
     168                 :            :   {
     169         [ +  - ]:       5271 :     BLOCK_SIGINT_START
     170                 :       5271 :     LOCK(&mt->pmut)
     171                 :            :     {
     172         [ +  + ]:      10536 :       while ((last = mt_queue_check(mt)) < 0)
     173                 :            :       {
     174                 :       5265 :         pthread_cond_wait(&mt->pcond, &mt->pmut);
     175         [ -  + ]:       5265 :         if (PARI_SIGINT_pending)
     176                 :            :         {
     177                 :          0 :           int sig = PARI_SIGINT_pending;
     178                 :          0 :           PARI_SIGINT_pending = 0;
     179                 :          0 :           pthread_mutex_unlock(&mt->pmut);
     180                 :          0 :           PARI_SIGINT_block = 0;
     181                 :          0 :           raise(sig);
     182                 :          0 :           PARI_SIGINT_block = 1;
     183                 :          0 :           pthread_mutex_lock(&mt->pmut);
     184                 :            :         }
     185                 :            :       }
     186                 :       5271 :     } UNLOCK(&mt->pmut);
     187 [ +  - ][ +  - ]:       5271 :     BLOCK_SIGINT_END
                 [ -  + ]
     188                 :            :   }
     189                 :       6542 :   mq = mt->mq+last;
     190         [ -  + ]:       6542 :   if (mq->output==err_e_STACK) pari_err(e_STACKTHREAD);
     191                 :       6542 :   done = gcopy(mq->output);
     192                 :       6542 :   mq->output = NULL;
     193         [ +  + ]:       6542 :   if (workid) *workid = mq->workid;
     194         [ +  + ]:       6542 :   if (typ(done)==t_ERROR) pari_err(0,done);
     195                 :       6540 :   mt->last = last;
     196                 :       6540 :   mt->pending--;
     197                 :       6540 :   *pending = mt->pending;
     198                 :       6732 :   return done;
     199                 :            : }
     200                 :            : 
     201                 :            : static void
     202                 :       6734 : mtpthread_queue_submit(struct mt_state *junk, long workid, GEN work)
     203                 :            : {
     204                 :       6734 :   struct mt_pstate *mt = pari_mt;
     205                 :       6734 :   struct mt_queue *mq = mt->mq+mt->last;
     206                 :            :   (void) junk;
     207         [ +  + ]:      13306 :   if (!work) { mt->nbint=mt->n; return; }
     208         [ +  - ]:       6572 :   BLOCK_SIGINT_START
     209         [ +  + ]:       6572 :   if (mt->nbint<mt->n)
     210                 :            :   {
     211                 :        204 :     mt->nbint++;
     212         [ +  + ]:        204 :     if (!mq->avma)
     213                 :            :     {
     214                 :         35 :       LOCK(mq->pmut)
     215                 :            :       {
     216         [ +  + ]:        135 :         while(!mq->avma)
     217                 :        100 :           pthread_cond_wait(mq->pcond, mq->pmut);
     218                 :         35 :       } UNLOCK(mq->pmut);
     219                 :            :     }
     220                 :            :   }
     221                 :       6572 :   LOCK(&mq->mut)
     222                 :            :   {
     223                 :       6572 :     mq->output = NULL;
     224                 :       6572 :     mq->workid = workid;
     225                 :       6572 :     mq->input = gcopy_avma(work, &mq->avma);
     226                 :       6572 :     pthread_cond_signal(&mq->cond);
     227                 :       6572 :   } UNLOCK(&mq->mut);
     228                 :       6572 :   mt->pending++;
     229 [ +  - ][ +  - ]:       6572 :   BLOCK_SIGINT_END
                 [ -  + ]
     230                 :            : }
     231                 :            : 
     232                 :            : void
     233                 :         18 : mt_queue_reset(void)
     234                 :            : {
     235                 :         18 :   struct mt_pstate *mt = pari_mt;
     236                 :            :   long i;
     237         [ +  + ]:        306 :   for (i=0; i<mt->n; i++)
     238                 :        288 :     pthread_cancel(mt->th[i]);
     239         [ +  + ]:        306 :   for (i=0; i<mt->n; i++)
     240                 :        288 :     pthread_join(mt->th[i],NULL);
     241         [ -  + ]:         18 :   if (DEBUGLEVEL) pari_warn(warner,"stop threads");
     242                 :         18 :   pari_mt = NULL;
     243         [ +  + ]:        306 :   for (i=0;i<mt->n;i++)
     244                 :            :   {
     245                 :        288 :     struct mt_queue *mq = mt->mq+i;
     246                 :        288 :     pthread_cond_destroy(&mq->cond);
     247                 :        288 :     pthread_mutex_destroy(&mq->mut);
     248                 :        288 :     pari_thread_free(&mt->pth[i]);
     249                 :            :   }
     250                 :         18 :   pari_free(mt->mq);
     251                 :         18 :   pari_free(mt->pth);
     252                 :         18 :   pari_free(mt->th);
     253                 :         18 :   pari_free(mt);
     254                 :         18 : }
     255                 :            : 
     256                 :            : void
     257                 :         18 : mt_queue_start(struct pari_mt *pt, GEN worker)
     258                 :            : {
     259         [ -  + ]:         18 :   if (pari_mt)
     260                 :          0 :     mtsingle_queue_start(pt, worker);
     261                 :            :   else
     262                 :            :   {
     263                 :         18 :     long NBT = pari_mt_nbthreads;
     264                 :         18 :     struct mt_pstate *mt =
     265                 :            :            (struct mt_pstate*) pari_malloc(sizeof(struct mt_pstate));
     266         [ -  + ]:         18 :     long mtparisize = GP_DATA->threadsize? GP_DATA->threadsize: pari_mainstack->rsize;
     267                 :         18 :     long mtparisizemax = GP_DATA->threadsizemax;
     268                 :            :     long i;
     269                 :         18 :     mt->mq  = (struct mt_queue *) pari_malloc(sizeof(*mt->mq)*NBT);
     270                 :         18 :     mt->th  = (pthread_t *) pari_malloc(sizeof(*mt->th)*NBT);
     271                 :         18 :     mt->pth = (struct pari_thread *) pari_malloc(sizeof(*mt->pth)*NBT);
     272                 :         18 :     mt->pending = 0;
     273                 :         18 :     mt->n = NBT;
     274                 :         18 :     mt->nbint = 0;
     275                 :         18 :     mt->last = 0;
     276                 :         18 :     pari_mt = mt;
     277                 :         18 :     pthread_cond_init(&mt->pcond,NULL);
     278                 :         18 :     pthread_mutex_init(&mt->pmut,NULL);
     279         [ +  + ]:        306 :     for (i=0;i<NBT;i++)
     280                 :            :     {
     281                 :        288 :       struct mt_queue *mq = mt->mq+i;
     282                 :        288 :       mq->no     = i;
     283                 :        288 :       mq->avma   = 0;
     284                 :        288 :       mq->worker = worker;
     285                 :        288 :       mq->input  = NULL;
     286                 :        288 :       mq->output = NULL;
     287                 :        288 :       mq->pcond  = &mt->pcond;
     288                 :        288 :       mq->pmut   = &mt->pmut;
     289                 :        288 :       pthread_cond_init(&mq->cond,NULL);
     290                 :        288 :       pthread_mutex_init(&mq->mut,NULL);
     291         [ -  + ]:        288 :       if (mtparisizemax)
     292                 :          0 :         pari_thread_valloc(&mt->pth[i],mtparisize,mtparisizemax,(GEN)mq);
     293                 :            :       else
     294                 :        288 :         pari_thread_alloc(&mt->pth[i],mtparisize,(GEN)mq);
     295                 :            :     }
     296         [ -  + ]:         18 :     if (DEBUGLEVEL) pari_warn(warner,"start threads");
     297         [ +  + ]:        306 :     for (i=0;i<NBT;i++)
     298                 :        288 :       pthread_create(&mt->th[i],NULL, &mt_queue_run, (void*)&mt->pth[i]);
     299                 :         18 :     pt->get=&mtpthread_queue_get;
     300                 :         18 :     pt->submit=&mtpthread_queue_submit;
     301                 :         18 :     pt->end=&mt_queue_reset;
     302                 :            :   }
     303                 :         18 : }

Generated by: LCOV version 1.9