thread.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-2020 Seagate Technology LLC and/or its Affiliates
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_LIB_THREAD_H__
#define __MOTR_LIB_THREAD_H__

#ifndef __KERNEL__
#  include "lib/user_space/thread.h"
#else
#  include "lib/linux_kernel/thread.h"
#endif
#include "lib/semaphore.h"

#include "lib/list.h"
#include "addb2/counter.h"               /* m0_addb2_sensor */

struct m0_bitmap;
struct m0;
struct m0_addb2_mach;

struct m0_thread;

struct m0_thread_tls {
        struct m0                 *tls_m0_instance;
        struct m0_thread_arch_tls  tls_arch;
        struct m0_addb2_mach      *tls_addb2_mach;
        struct m0_thread          *tls_self;
        struct m0_addb2_sensor     tls_clock;
};

enum m0_thread_state {
        TS_PARKED = 0,
        TS_RUNNING
};

struct m0_thread {
        enum m0_thread_state    t_state;
        struct m0_thread_handle t_h;
        int                   (*t_init)(void *);
        void                  (*t_func)(void *);
        void                   *t_arg;
        struct m0_semaphore     t_wait;
        int                     t_initrc;
        struct m0_thread_tls    t_tls;
        char                    t_namebuf[M0_THREAD_NAME_LEN];
};

#define M0_THREAD_INIT(thread, TYPE, init, func, arg, namefmt, ...)     \
({                                                                      \
        typeof(func) __func = (func);                                   \
        typeof(arg)  __arg  = (arg);                                    \
        TYPE         __dummy;                                           \
        (void)(__func == (void (*)(TYPE))NULL);                         \
        (void)(&__arg == &__dummy);                                     \
        m0_thread_init(thread,                                          \
                       (int  (*)(void *))init,                          \
                       (void (*)(void *))__func,                        \
                       (void *)(unsigned long)__arg,                    \
                       namefmt , ## __VA_ARGS__);                       \
})

M0_INTERNAL int m0_thread_init_impl(struct m0_thread *q, const char *name);

M0_INTERNAL void *m0_thread_trampoline(void *t);

int m0_thread_init(struct m0_thread *q, int (*init)(void *),
                   void (*func)(void *), void *arg, const char *namefmt, ...)
        __attribute__ ((format (printf, 5, 6)));

void m0_thread_fini(struct m0_thread *q);

int m0_thread_join(struct m0_thread *q);

M0_INTERNAL int m0_thread_signal(struct m0_thread *q, int sig);

M0_INTERNAL int m0_thread_confine(struct m0_thread *q,
                                  const struct m0_bitmap *processors);

M0_INTERNAL struct m0_thread *m0_thread_self(void);

M0_INTERNAL struct m0_thread_tls *m0_thread_tls(void);

M0_INTERNAL int m0_threads_init(struct m0 *instance);
M0_INTERNAL void m0_threads_fini(void);

M0_INTERNAL int m0_threads_once_init(void);
M0_INTERNAL void m0_threads_once_fini(void);

M0_INTERNAL void m0_enter_awkward(void);

M0_INTERNAL void m0_exit_awkward(void);

M0_INTERNAL bool m0_is_awkward(void);

M0_INTERNAL uint64_t m0_pid(void);

M0_INTERNAL uint64_t m0_process(void);

M0_INTERNAL int m0_thread_adopt(struct m0_thread *thread, struct m0 *instance);

M0_INTERNAL void m0_thread_shun(void);

M0_INTERNAL int m0_thread_arch_adopt(struct m0_thread *thread,
                                     struct m0 *instance, bool full);
M0_INTERNAL void m0_thread_arch_shun(void);

#endif /* __MOTR_LIB_THREAD_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */