plist.c

/*-
 * Copyright (c) 2008-2015 Juan Romero Pardines.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#include <errno.h>
#include <pthread.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
 
#include "xbps_api_impl.h"
 
struct thread_data {
        pthread_t thread;
        xbps_array_t array;
        xbps_dictionary_t dict;
        struct xbps_handle *xhp;
        unsigned int start;
        unsigned int arraycount;
        unsigned int *reserved;
        pthread_mutex_t *reserved_lock;
        unsigned int slicecount;
        int (*fn)(struct xbps_handle *, xbps_object_t, const char *, void *, bool *);
        void *fn_arg;
        int r;
};
 
/**
 * @file lib/plist.c
 * @brief PropertyList generic routines
 * @defgroup plist PropertyList generic functions
 *
 * These functions manipulate plist files and objects shared by almost
 * all library functions.
 */
static void *
array_foreach_thread(void *arg)
{
        xbps_object_t obj, pkgd;
        struct thread_data *thd = arg;
        const char *key;
        int r;
        bool loop_done = false;
        unsigned i = thd->start;
        unsigned int end = i + thd->slicecount;
 
        while(i < thd->arraycount) {
                /* process pkgs from start until end */
                for (; i < end && i < thd->arraycount; i++) {
                        obj = xbps_array_get(thd->array, i);
                        if (xbps_object_type(thd->dict) == XBPS_TYPE_DICTIONARY) {
                                pkgd = xbps_dictionary_get_keysym(thd->dict, obj);
                                key = xbps_dictionary_keysym_cstring_nocopy(obj);
                                /* ignore internal objs */
                                if (strncmp(key, "_XBPS_", 6) == 0)
                                        continue;
                        } else {
                                pkgd = obj;
                                key = NULL;
                        }
                        r = (*thd->fn)(thd->xhp, pkgd, key, thd->fn_arg, &loop_done);
                        if (r != 0 || loop_done) {
                                thd->r = r;
                                return NULL;
                        }
                }
                /* Reserve more elements to compute */
                pthread_mutex_lock(thd->reserved_lock);
                i = *thd->reserved;
                end = i + thd->slicecount;
                *thd->reserved = end;
                pthread_mutex_unlock(thd->reserved_lock);
        }
        return NULL;
}
 
int
xbps_array_foreach_cb_multi(struct xbps_handle *xhp,
        xbps_array_t array,
        xbps_dictionary_t dict,
        int (*fn)(struct xbps_handle *, xbps_object_t, const char *, void *, bool *),
        void *arg)
{
        struct thread_data *thd;
        unsigned int arraycount, slicecount;
        int r, error = 0, i, maxthreads;
        unsigned int reserved;
        pthread_mutex_t reserved_lock = PTHREAD_MUTEX_INITIALIZER;
 
        assert(fn != NULL);
 
        if (xbps_object_type(array) != XBPS_TYPE_ARRAY)
                return -EINVAL;
 
        arraycount = xbps_array_count(array);
        if (arraycount == 0)
                return 0;
 
        maxthreads = (int)sysconf(_SC_NPROCESSORS_ONLN);
        if (maxthreads <= 1 || arraycount <= 1) /* use single threaded routine */
                return xbps_array_foreach_cb(xhp, array, dict, fn, arg);
 
        thd = calloc(maxthreads, sizeof(*thd));
        if (!thd)
                return xbps_error_oom();
 
        // maxthread is boundchecked to be > 1
        if((unsigned int)maxthreads >= arraycount) {
                maxthreads = arraycount;
                slicecount = 1;
        } else {
                slicecount = arraycount / maxthreads;
                if (slicecount > 32) {
                        slicecount = 32;
                }
        }
 
        reserved = slicecount * maxthreads;
 
        for (i = 0; i < maxthreads; i++) {
                thd[i].array = array;
                thd[i].dict = dict;
                thd[i].xhp = xhp;
                thd[i].fn = fn;
                thd[i].fn_arg = arg;
                thd[i].start = i * slicecount;
                thd[i].reserved = &reserved;
                thd[i].reserved_lock = &reserved_lock;
                thd[i].slicecount = slicecount;
                thd[i].arraycount = arraycount;
 
                r = -pthread_create(&thd[i].thread, NULL, array_foreach_thread, &thd[i]);
                if (r < 0) {
                        xbps_error_printf(
                            "failed to create thread: %s\n", strerror(-r));
                        break;
                }
        }
 
        // if we are unable to create any threads, just do single threaded.
        if (i == 0) {
                pthread_mutex_destroy(&reserved_lock);
                free(thd);
                return xbps_array_foreach_cb(xhp, array, dict, fn, arg);
        }
 
        /* wait for all threads that were created successfully */
        for (int c = 0; c < i; c++) {
                r = -pthread_join(thd[c].thread, NULL);
                if (r < 0) {
                        xbps_error_printf(
                            "failed to wait on thread: %s\n", strerror(-r));
                        error++;
                }
        }
 
        pthread_mutex_destroy(&reserved_lock);
 
        if (error != 0) {
                free(thd);
                return -EAGAIN;
        }
 
        r = 0;
        for (int j = 0; j < i; j++) {
                if (thd[j].r == 0)
                        continue;
                r = thd[j].r;
                break;
        }
 
        free(thd);
        return r;
}
 
int
xbps_array_foreach_cb(struct xbps_handle *xhp,
        xbps_array_t array,
        xbps_dictionary_t dict,
        int (*fn)(struct xbps_handle *, xbps_object_t, const char *, void *, bool *),
        void *arg)
{
        xbps_dictionary_t pkgd;
        xbps_object_t obj;
        const char *key;
        int r = 0;
        bool loop_done = false;
 
        for (unsigned int i = 0; i < xbps_array_count(array); i++) {
                obj = xbps_array_get(array, i);
                if (xbps_object_type(dict) == XBPS_TYPE_DICTIONARY) {
                        pkgd = xbps_dictionary_get_keysym(dict, obj);
                        key = xbps_dictionary_keysym_cstring_nocopy(obj);
                        /* ignore internal objs */
                        if (strncmp(key, "_XBPS_", 6) == 0)
                                continue;
                } else {
                        pkgd = obj;
                        key = NULL;
                }
                r = (*fn)(xhp, pkgd, key, arg, &loop_done);
                if (r != 0 || loop_done)
                        return r;
        }
        return 0;
}
 
xbps_object_iterator_t
xbps_array_iter_from_dict(xbps_dictionary_t dict, const char *key)
{
        xbps_array_t array;
 
        assert(xbps_object_type(dict) == XBPS_TYPE_DICTIONARY);
        assert(key != NULL);
 
        array = xbps_dictionary_get(dict, key);
        if (xbps_object_type(array) != XBPS_TYPE_ARRAY) {
                errno = EINVAL;
                return NULL;
        }
 
        return xbps_array_iterator(array);
}
 
static int
array_replace_dict(xbps_array_t array,
                   xbps_dictionary_t dict,
                   const char *str,
                   bool bypattern)
{
        xbps_object_t obj;
        const char *pkgver, *pkgname;
 
        assert(xbps_object_type(array) == XBPS_TYPE_ARRAY);
        assert(xbps_object_type(dict) == XBPS_TYPE_DICTIONARY);
        assert(str != NULL);
 
        for (unsigned int i = 0; i < xbps_array_count(array); i++) {
                obj = xbps_array_get(array, i);
                if (obj == NULL) {
                        continue;
                }
                if (!xbps_dictionary_get_cstring_nocopy(obj, "pkgver", &pkgver)) {
                        continue;
                }
                if (bypattern) {
                        /* pkgpattern match */
                        if (xbps_pkgpattern_match(pkgver, str)) {
                                if (!xbps_array_set(array, i, dict)) {
                                        return EINVAL;
                                }
                                return 0;
                        }
                } else {
                        /* pkgname match */
                        xbps_dictionary_get_cstring_nocopy(obj, "pkgname", &pkgname);
                        if (strcmp(pkgname, str) == 0) {
                                if (!xbps_array_set(array, i, dict)) {
                                        return EINVAL;
                                }
                                return 0;
                        }
                }
        }
        /* no match */
        return ENOENT;
}
 
int HIDDEN
xbps_array_replace_dict_by_name(xbps_array_t array,
                                xbps_dictionary_t dict,
                                const char *pkgver)
{
        return array_replace_dict(array, dict, pkgver, false);
}
 
int HIDDEN
xbps_array_replace_dict_by_pattern(xbps_array_t array,
                                   xbps_dictionary_t dict,
                                   const char *pattern)
{
        return array_replace_dict(array, dict, pattern, true);
}