- macosx: change to --prefix=/usr rather than /opt/local.
[platform/upstream/rpm.git] / rpmio / rpmsq.c
index 1c2536c..c49e9cd 100644 (file)
@@ -1,4 +1,3 @@
-/*@-unrecog@*/
 /** \ingroup rpmio
  * \file rpmio/rpmsq.c
  */
 #include "system.h"
 
 #if defined(__LCLINT__)
-struct qelem;
+#define        _BITS_SIGTHREAD_H       /* XXX avoid __sigset_t heartburn. */
+
+/*@-incondefs -protoparammatch@*/
 /*@-exportheader@*/
+/*@constant int SA_SIGINFO@*/
+extern int sighold(int sig)
+       /*@globals errno, systemState @*/;
+extern int sigignore(int sig)
+       /*@globals errno, systemState @*/;
+extern int sigpause(int sig)
+       /*@globals errno, systemState @*/;
+extern int sigrelse(int sig)
+       /*@globals errno, systemState @*/;
+extern void (*sigset(int sig, void (*disp)(int)))(int)
+       /*@globals errno, systemState @*/;
+
+struct qelem;
 extern void insque(struct qelem * __elem, struct qelem * __prev)
-       /*@modifies  __elem, prev @*/;
+       /*@modifies  __elem, __prev @*/;
 extern void remque(struct qelem * __elem)
        /*@modifies  __elem @*/;
+
+extern pthread_t pthread_self(void)
+       /*@*/;
+extern int pthread_equal(pthread_t t1, pthread_t t2)
+       /*@*/;
+
+extern int pthread_create(/*@out@*/ pthread_t *restrict thread,
+               const pthread_attr_t *restrict attr,
+               void *(*start_routine)(void*), void *restrict arg)
+       /*@modifies *thread @*/;
+extern int pthread_join(pthread_t thread, /*@out@*/ void **value_ptr)
+       /*@modifies *value_ptr @*/;
+
+extern int pthread_setcancelstate(int state, /*@out@*/ int *oldstate)
+       /*@globals internalState @*/
+       /*@modifies *oldstate, internalState @*/;
+extern int pthread_setcanceltype(int type, /*@out@*/ int *oldtype)
+       /*@globals internalState @*/
+       /*@modifies *oldtype, internalState @*/;
+extern void pthread_testcancel(void)
+       /*@globals internalState @*/
+       /*@modifies internalState @*/;
+extern void pthread_cleanup_pop(int execute)
+       /*@globals internalState @*/
+       /*@modifies internalState @*/;
+extern void pthread_cleanup_push(void (*routine)(void*), void *arg)
+       /*@globals internalState @*/
+       /*@modifies internalState @*/;
+extern void _pthread_cleanup_pop(/*@out@*/ struct _pthread_cleanup_buffer *__buffer, int execute)
+       /*@globals internalState @*/
+       /*@modifies internalState @*/;
+extern void _pthread_cleanup_push(/*@out@*/ struct _pthread_cleanup_buffer *__buffer, void (*routine)(void*), /*@out@*/ void *arg)
+       /*@globals internalState @*/
+       /*@modifies internalState @*/;
+
+extern int pthread_mutexattr_destroy(pthread_mutexattr_t *attr)
+       /*@globals errno, internalState @*/
+       /*@modifies *attr, errno, internalState @*/;
+extern int pthread_mutexattr_init(/*@out@*/ pthread_mutexattr_t *attr)
+       /*@globals errno, internalState @*/
+       /*@modifies *attr, errno, internalState @*/;
+
+int pthread_mutexattr_gettype(const pthread_mutexattr_t *restrict attr,
+               /*@out@*/ int *restrict type)
+       /*@modifies *type @*/;
+int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type)
+       /*@globals errno, internalState @*/
+       /*@modifies *attr, errno, internalState @*/;
+
+extern int pthread_mutex_destroy(pthread_mutex_t *mutex)
+       /*@modifies *mutex @*/;
+extern int pthread_mutex_init(/*@out@*/ pthread_mutex_t *restrict mutex,
+               /*@null@*/ const pthread_mutexattr_t *restrict attr)
+       /*@globals errno, internalState @*/
+       /*@modifies *mutex, errno, internalState @*/;
+
+extern int pthread_mutex_lock(pthread_mutex_t *mutex)
+       /*@globals errno @*/
+       /*@modifies *mutex, errno @*/;
+extern int pthread_mutex_trylock(pthread_mutex_t *mutex)
+       /*@globals errno @*/
+       /*@modifies *mutex, errno @*/;
+extern int pthread_mutex_unlock(pthread_mutex_t *mutex)
+       /*@globals errno @*/
+       /*@modifies *mutex, errno @*/;
+
+extern int pthread_cond_destroy(pthread_cond_t *cond)
+       /*@modifies *cond @*/;
+extern int pthread_cond_init(/*@out@*/ pthread_cond_t *restrict cond,
+               const pthread_condattr_t *restrict attr)
+       /*@globals errno, internalState @*/
+       /*@modifies *cond, errno, internalState @*/;
+
+extern int pthread_cond_timedwait(pthread_cond_t *restrict cond,
+               pthread_mutex_t *restrict mutex,
+               const struct timespec *restrict abstime)
+       /*@modifies *cond, *mutex @*/;
+extern int pthread_cond_wait(pthread_cond_t *restrict cond,
+               pthread_mutex_t *restrict mutex)
+       /*@modifies *cond, *mutex @*/;
+extern int pthread_cond_broadcast(pthread_cond_t *cond)
+       /*@globals errno, internalState @*/
+       /*@modifies *cond, errno, internalState @*/;
+extern int pthread_cond_signal(pthread_cond_t *cond)
+       /*@globals errno, internalState @*/
+       /*@modifies *cond, errno, internalState @*/;
+
 /*@=exportheader@*/
+/*@=incondefs =protoparammatch@*/
 #endif
 
 #include <signal.h>
@@ -20,31 +122,38 @@ extern     void remque(struct qelem * __elem)
 #include <sys/wait.h>
 #include <search.h>
 
-#if defined(HAVE_PTHREAD_H) && !defined(__LCLINT__)
+#if defined(HAVE_PTHREAD_H)
 
 #include <pthread.h>
 
+#ifndef PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
+/*@unchecked@*/
+static pthread_mutex_t rpmsigTbl_lock = PTHREAD_MUTEX_INITIALIZER;
+#else
 /*@unchecked@*/
+/*@-type@*/
 static pthread_mutex_t rpmsigTbl_lock = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP;
+/*@=type@*/
+#endif
 
 #define        DO_LOCK()       pthread_mutex_lock(&rpmsigTbl_lock);
 #define        DO_UNLOCK()     pthread_mutex_unlock(&rpmsigTbl_lock);
 #define        INIT_LOCK()     \
-     { pthread_mutexattr_t attr; \
-       pthread_mutexattr_init(&attr); \
-       pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE); \
-       pthread_mutex_init (&rpmsigTbl_lock, &attr); \
-       pthread_mutexattr_destroy(&attr); \
+     pthread_mutexattr_t attr; \
+       (void) pthread_mutexattr_init(&attr); \
+       (void) pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE); \
+       (void) pthread_mutex_init (&rpmsigTbl_lock, &attr); \
+       (void) pthread_mutexattr_destroy(&attr); \
        rpmsigTbl_sigchld->active = 0; \
-     }
+    }
 #define        ADD_REF(__tbl)  (__tbl)->active++
 #define        SUB_REF(__tbl)  --(__tbl)->active
 #define        CLEANUP_HANDLER(__handler, __arg, __oldtypeptr) \
-       pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, (__oldtypeptr)); \
+    (void) pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, (__oldtypeptr));\
        pthread_cleanup_push((__handler), (__arg));
 #define        CLEANUP_RESET(__execute, __oldtype) \
-       pthread_cleanup_pop(__execute); \
-       pthread_setcanceltype ((__oldtype), &(__oldtype));
+    pthread_cleanup_pop(__execute); \
+    (void) pthread_setcanceltype ((__oldtype), &(__oldtype));
 
 #define        SAME_THREAD(_a, _b)     pthread_equal(((pthread_t)_a), ((pthread_t)_b))
 
@@ -82,43 +191,35 @@ static struct rpmsqElem rpmsqRock;
 rpmsq rpmsqQueue = &rpmsqRock;
 /*@=compmempass@*/
 
-/*@-mustmod@*/
-int rpmsqInsert(void * elem, /*@unused@*/ void * prev)
+int rpmsqInsert(void * elem, void * prev)
 {
     rpmsq sq = (rpmsq) elem;
     int ret = -1;
 
     if (sq != NULL) {
 #ifdef _RPMSQ_DEBUG
-/*@-modfilesys@*/
 if (_rpmsq_debug)
 fprintf(stderr, "    Insert(%p): %p\n", ME(), sq);
-/*@=modfilesys@*/
 #endif
        ret = sighold(SIGCHLD);
        if (ret == 0) {
            sq->child = 0;
            sq->reaped = 0;
            sq->status = 0;
-           sq->reaper = 1;
+           sq->reaper = 0;
 /*@-bounds@*/
            sq->pipes[0] = sq->pipes[1] = -1;
 /*@=bounds@*/
 
-/*@-unqualifiedtrans@*/
            sq->id = ME();
-/*@=unqualifiedtrans@*/
            ret = pthread_mutex_init(&sq->mutex, NULL);
            ret = pthread_cond_init(&sq->cond, NULL);
-#if !defined(__LCLINT__)       /* XXX FIXME */
-           insque(elem, (prev ? prev : rpmsqQueue));
-#endif
+           insque(elem, (prev != NULL ? prev : rpmsqQueue));
            ret = sigrelse(SIGCHLD);
        }
     }
     return ret;
 }
-/*@=mustmod@*/
 
 int rpmsqRemove(void * elem)
 {
@@ -128,10 +229,8 @@ int rpmsqRemove(void * elem)
     if (elem != NULL) {
 
 #ifdef _RPMSQ_DEBUG
-/*@-modfilesys@*/
 if (_rpmsq_debug)
 fprintf(stderr, "    Remove(%p): %p\n", ME(), sq);
-/*@=modfilesys@*/
 #endif
        ret = sighold (SIGCHLD);
        if (ret == 0) {
@@ -183,11 +282,8 @@ static struct rpmsig_s {
 };
 /*@=fullinitblock@*/
 
-/*@-incondefs@*/
 void rpmsqAction(int signum,
                /*@unused@*/ void * info, /*@unused@*/ void * context)
-       /*@globals rpmsqQueue @*/
-       /*@modifies rpmsqQueue @*/
 {
     int save = errno;
     rpmsig tbl;
@@ -218,9 +314,7 @@ void rpmsqAction(int signum,
                        /*@innercontinue@*/ continue;
                    sq->reaped = reaped;
                    sq->status = status;
-#if defined(HAVE_PTHREAD_H) && !defined(__LCLINT__)
                    (void) pthread_cond_signal(&sq->cond);
-#endif
                    /*@innerbreak@*/ break;
                }
            }
@@ -232,7 +326,6 @@ void rpmsqAction(int signum,
     }
     errno = save;
 }
-/*@=incondefs@*/
 
 int rpmsqEnable(int signum, /*@null@*/ rpmsqAction_t handler)
        /*@globals rpmsigTbl @*/
@@ -243,11 +336,9 @@ int rpmsqEnable(int signum, /*@null@*/ rpmsqAction_t handler)
     rpmsig tbl;
     int ret = -1;
 
-    DO_LOCK ();
-#if !defined(__LCLINT__)
+    (void) DO_LOCK ();
     if (rpmsqQueue->id == NULL)
        rpmsqQueue->id = ME();
-#endif
     for (tbl = rpmsigTbl; tbl->signum >= 0; tbl++) {
        if (tblsignum != tbl->signum)
            continue;
@@ -255,15 +346,23 @@ int rpmsqEnable(int signum, /*@null@*/ rpmsqAction_t handler)
        if (signum >= 0) {                      /* Enable. */
            if (ADD_REF(tbl) <= 0) {
                (void) sigdelset(&rpmsqCaught, tbl->signum);
+
+               /* XXX Don't set a signal handler if already SIG_IGN */
+               (void) sigaction(tbl->signum, NULL, &tbl->oact);
+               if (tbl->oact.sa_handler == SIG_IGN)
+                   continue;
+
                (void) sigemptyset (&sa.sa_mask);
-/*@-compdef -type @*/
                sa.sa_flags = SA_SIGINFO;
+#if defined(__LCLINT__)        /* XXX glibc has union to track handler prototype. */
+               sa.sa_handler = (handler != NULL ? handler : tbl->handler);
+#else
                sa.sa_sigaction = (handler != NULL ? handler : tbl->handler);
+#endif
                if (sigaction(tbl->signum, &sa, &tbl->oact) < 0) {
                    SUB_REF(tbl);
                    break;
                }
-/*@=compdef =type @*/
                tbl->active = 1;                /* XXX just in case */
                if (handler != NULL)
                    tbl->handler = handler;
@@ -279,7 +378,7 @@ int rpmsqEnable(int signum, /*@null@*/ rpmsqAction_t handler)
        ret = tbl->active;
        break;
     }
-    DO_UNLOCK ();
+    (void) DO_UNLOCK ();
     return ret;
 }
 
@@ -291,10 +390,8 @@ pid_t rpmsqFork(rpmsq sq)
     if (sq->reaper) {
        xx = rpmsqInsert(sq, NULL);
 #ifdef _RPMSQ_DEBUG
-/*@-modfilesys@*/
 if (_rpmsq_debug)
 fprintf(stderr, "    Enable(%p): %p\n", ME(), sq);
-/*@=modfilesys@*/
 #endif
        xx = rpmsqEnable(SIGCHLD, NULL);
     }
@@ -314,7 +411,7 @@ fprintf(stderr, "    Enable(%p): %p\n", ME(), sq);
     } else if (pid == (pid_t) 0) {     /* Child. */
        int yy;
 
-       /* Block to permit parent to wait. */
+       /* Block to permit parent time to wait. */
 /*@-bounds@*/
        xx = close(sq->pipes[1]);
        xx = read(sq->pipes[0], &yy, sizeof(yy));
@@ -323,10 +420,8 @@ fprintf(stderr, "    Enable(%p): %p\n", ME(), sq);
 /*@=bounds@*/
 
 #ifdef _RPMSQ_DEBUG
-/*@-modfilesys@*/
 if (_rpmsq_debug)
 fprintf(stderr, "     Child(%p): %p child %d\n", ME(), sq, getpid());
-/*@=modfilesys@*/
 #endif
 
     } else {                           /* Parent. */
@@ -334,10 +429,8 @@ fprintf(stderr, "     Child(%p): %p child %d\n", ME(), sq, getpid());
        sq->child = pid;
 
 #ifdef _RPMSQ_DEBUG
-/*@-modfilesys@*/
 if (_rpmsq_debug)
 fprintf(stderr, "    Parent(%p): %p child %d\n", ME(), sq, sq->child);
-/*@=modfilesys@*/
 #endif
 
     }
@@ -349,6 +442,7 @@ out:
 
 /**
  * Wait for child process to be reaped, and unregister SIGCHLD handler.
+ * @todo Rewrite to use waitpid on helper thread.
  * @param sq           scriptlet queue element
  * @return             0 on success
  */
@@ -356,16 +450,18 @@ static int rpmsqWaitUnregister(rpmsq sq)
        /*@globals fileSystem, internalState @*/
        /*@modifies sq, fileSystem, internalState @*/
 {
-    int same_thread = 0;
+    int nothreads = 0;
     int ret = 0;
     int xx;
 
-    if (same_thread)
-       ret = sighold(SIGCHLD);
-    else
+    /* Protect sq->reaped from handler changes. */
+    ret = sighold(SIGCHLD);
+
+    /* Initialize the cond var mutex. */
+    if (!nothreads)
        ret = pthread_mutex_lock(&sq->mutex);
 
-    /* Start the child. */
+    /* Start the child, linux often runs child before parent. */
 /*@-bounds@*/
     if (sq->pipes[0] >= 0)
        xx = close(sq->pipes[0]);
@@ -374,38 +470,44 @@ static int rpmsqWaitUnregister(rpmsq sq)
     sq->pipes[0] = sq->pipes[1] = -1;
 /*@=bounds@*/
 
+    /* Put a stopwatch on the time spent waiting to measure performance gain. */
     (void) rpmswEnter(&sq->op, -1);
 
+    /* Wait for handler to receive SIGCHLD. */
     /*@-infloops@*/
     while (ret == 0 && sq->reaped != sq->child) {
-       if (same_thread)
+       if (nothreads)
+           /* Note that sigpause re-enables SIGCHLD. */
            ret = sigpause(SIGCHLD);
-       else
+       else {
+           xx = sigrelse(SIGCHLD);
            ret = pthread_cond_wait(&sq->cond, &sq->mutex);
+           xx = sighold(SIGCHLD);
+       }
     }
     /*@=infloops@*/
 
+    /* Accumulate stopwatch time spent waiting, potential performance gain. */
     sq->ms_scriptlets += rpmswExit(&sq->op, -1)/1000;
 
-    if (same_thread)
-       xx = sigrelse(SIGCHLD);
-    else
+    /* Tear down cond var mutex, our child has been reaped. */
+    if (!nothreads)
        xx = pthread_mutex_unlock(&sq->mutex);
+    xx = sigrelse(SIGCHLD);
 
 #ifdef _RPMSQ_DEBUG
-/*@-modfilesys@*/
 if (_rpmsq_debug)
 fprintf(stderr, "      Wake(%p): %p child %d reaper %d ret %d\n", ME(), sq, sq->child, sq->reaper, ret);
-/*@=modfilesys@*/
 #endif
 
+    /* Remove processed SIGCHLD item from queue. */
     xx = rpmsqRemove(sq);
+
+    /* Disable SIGCHLD handler on refcount == 0. */
     xx = rpmsqEnable(-SIGCHLD, NULL);
 #ifdef _RPMSQ_DEBUG
-/*@-modfilesys@*/
 if (_rpmsq_debug)
 fprintf(stderr, "   Disable(%p): %p\n", ME(), sq);
-/*@=modfilesys@*/
 #endif
 
     return ret;
@@ -415,10 +517,8 @@ pid_t rpmsqWait(rpmsq sq)
 {
 
 #ifdef _RPMSQ_DEBUG
-/*@-modfilesys@*/
 if (_rpmsq_debug)
 fprintf(stderr, "      Wait(%p): %p child %d reaper %d\n", ME(), sq, sq->child, sq->reaper);
-/*@=modfilesys@*/
 #endif
 
     if (sq->reaper) {
@@ -432,18 +532,14 @@ fprintf(stderr, "      Wait(%p): %p child %d reaper %d\n", ME(), sq, sq->child,
        sq->reaped = reaped;
        sq->status = status;
 #ifdef _RPMSQ_DEBUG
-/*@-modfilesys@*/
 if (_rpmsq_debug)
 fprintf(stderr, "   Waitpid(%p): %p child %d reaped %d\n", ME(), sq, sq->child, sq->reaped);
-/*@=modfilesys@*/
 #endif
     }
 
 #ifdef _RPMSQ_DEBUG
-/*@-modfilesys@*/
 if (_rpmsq_debug)
 fprintf(stderr, "      Fini(%p): %p child %d status 0x%x\n", ME(), sq, sq->child, sq->status);
-/*@=modfilesys@*/
 #endif
 
     return sq->reaped;
@@ -478,8 +574,8 @@ int rpmsqThreadEqual(void * thread)
  */
 static void
 sigchld_cancel (void *arg)
-       /*@globals fileSystem, internalState @*/
-       /*@modifies fileSystem, internalState @*/
+       /*@globals rpmsigTbl, fileSystem, internalState @*/
+       /*@modifies rpmsigTbl, fileSystem, internalState @*/
 {
     pid_t child = *(pid_t *) arg;
     pid_t result;
@@ -490,29 +586,34 @@ sigchld_cancel (void *arg)
        result = waitpid(child, NULL, 0);
     } while (result == (pid_t)-1 && errno == EINTR);
 
-    DO_LOCK ();
+    (void) DO_LOCK ();
     if (SUB_REF (rpmsigTbl_sigchld) == 0) {
        (void) rpmsqEnable(-SIGQUIT, NULL);
        (void) rpmsqEnable(-SIGINT, NULL);
     }
-    DO_UNLOCK ();
+    (void) DO_UNLOCK ();
 }
 
 /**
  * Execute a command, returning its status.
  */
-/*@-bounds@*/
 int
 rpmsqExecve (const char ** argv)
+       /*@globals rpmsigTbl @*/
+       /*@modifies rpmsigTbl @*/
 {
     int oldtype;
     int status = -1;
-    pid_t pid;
+    pid_t pid = 0;
     pid_t result;
     sigset_t newMask, oldMask;
     rpmsq sq = memset(alloca(sizeof(*sq)), 0, sizeof(*sq));
 
-    DO_LOCK ();
+#ifndef PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
+       INIT_LOCK ();
+#endif
+
+    (void) DO_LOCK ();
     if (ADD_REF (rpmsigTbl_sigchld) == 0) {
        if (rpmsqEnable(SIGINT, NULL) < 0) {
            SUB_REF (rpmsigTbl_sigchld);
@@ -523,12 +624,12 @@ rpmsqExecve (const char ** argv)
            goto out_restore_sigint;
        }
     }
-    DO_UNLOCK ();
+    (void) DO_UNLOCK ();
 
     (void) sigemptyset (&newMask);
     (void) sigaddset (&newMask, SIGCHLD);
     if (sigprocmask (SIG_BLOCK, &newMask, &oldMask) < 0) {
-       DO_LOCK ();
+       (void) DO_LOCK ();
        if (SUB_REF (rpmsigTbl_sigchld) == 0)
            goto out_restore_sigquit_and_sigint;
        goto out;
@@ -561,7 +662,7 @@ rpmsqExecve (const char ** argv)
 
     CLEANUP_RESET(0, oldtype);
 
-    DO_LOCK ();
+    (void) DO_LOCK ();
     if ((SUB_REF (rpmsigTbl_sigchld) == 0 &&
         (rpmsqEnable(-SIGINT, NULL) < 0 || rpmsqEnable (-SIGQUIT, NULL) < 0))
       || sigprocmask (SIG_SETMASK, &oldMask, NULL) != 0)
@@ -575,8 +676,6 @@ out_restore_sigquit_and_sigint:
 out_restore_sigint:
     (void) rpmsqEnable(-SIGINT, NULL);
 out:
-    DO_UNLOCK ();
+    (void) DO_UNLOCK ();
     return status;
 }
-/*@=bounds@*/
-/*@=unrecog@*/