libcfs/libcfs/user-prim.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * libcfs/libcfs/user-prim.c
  37  *
  38  * Implementations of portable APIs for liblustre
  39  *
  40  * Author: Nikita Danilov <nikita@clusterfs.com>
  41  */
  42
  43 /*
  44  * liblustre is single-threaded, so most "synchronization" APIs are trivial.
  45  */
  46
  47 #ifndef __KERNEL__
  48
  49 #include <libcfs/libcfs.h>
  50
  51 /*
  52  * Wait queue. No-op implementation.
  53  */
  54
  55 void cfs_waitq_init(struct cfs_waitq *waitq)
  56 {
  57         LASSERT(waitq != NULL);
  58         (void)waitq;
  59 }
  60
  61 void cfs_waitlink_init(struct cfs_waitlink *link)
  62 {
  63         LASSERT(link != NULL);
  64         (void)link;
  65 }
  66
  67 void cfs_waitq_add(struct cfs_waitq *waitq, struct cfs_waitlink *link)
  68 {
  69         LASSERT(waitq != NULL);
  70         LASSERT(link != NULL);
  71         (void)waitq;
  72         (void)link;
  73 }
  74
  75 void cfs_waitq_add_exclusive(struct cfs_waitq *waitq, struct cfs_waitlink *link)
  76 {
  77         LASSERT(waitq != NULL);
  78         LASSERT(link != NULL);
  79         (void)waitq;
  80         (void)link;
  81 }
  82
  83 void cfs_waitq_del(struct cfs_waitq *waitq, struct cfs_waitlink *link)
  84 {
  85         LASSERT(waitq != NULL);
  86         LASSERT(link != NULL);
  87         (void)waitq;
  88         (void)link;
  89 }
  90
  91 int cfs_waitq_active(struct cfs_waitq *waitq)
  92 {
  93         LASSERT(waitq != NULL);
  94         (void)waitq;
  95         return 0;
  96 }
  97
  98 void cfs_waitq_signal(struct cfs_waitq *waitq)
  99 {
 100         LASSERT(waitq != NULL);
 101         (void)waitq;
 102 }
 103
 104 void cfs_waitq_signal_nr(struct cfs_waitq *waitq, int nr)
 105 {
 106         LASSERT(waitq != NULL);
 107         (void)waitq;
 108 }
 109
 110 void cfs_waitq_broadcast(struct cfs_waitq *waitq)
 111 {
 112         LASSERT(waitq != NULL);
 113         (void)waitq;
 114 }
 115
 116 void cfs_waitq_wait(struct cfs_waitlink *link, cfs_task_state_t state)
 117 {
 118         LASSERT(link != NULL);
 119         (void)link;
 120
 121         /* well, wait for something to happen */
 122         call_wait_handler(0);
 123 }
 124
 125 int64_t cfs_waitq_timedwait(struct cfs_waitlink *link, cfs_task_state_t state,
 126                             int64_t timeout)
 127 {
 128         LASSERT(link != NULL);
 129         (void)link;
 130         call_wait_handler(timeout);
 131         return 0;
 132 }
 133
 134 void cfs_schedule_timeout(cfs_task_state_t state, int64_t timeout)
 135 {
 136         cfs_waitlink_t    l;
 137         /* sleep(timeout) here instead? */
 138         cfs_waitq_timedwait(&l, state, timeout);
 139 }
 140
 141 void
 142 cfs_pause(cfs_duration_t d)
 143 {
 144         struct timespec s;
 145
 146         cfs_duration_nsec(d, &s);
 147         nanosleep(&s, NULL);
 148 }
 149
 150 int cfs_need_resched(void)
 151 {
 152         return 0;
 153 }
 154
 155 void cfs_cond_resched(void)
 156 {
 157 }
 158
 159 /*
 160  * Timer
 161  */
 162
 163 void cfs_init_timer(cfs_timer_t *t)
 164 {
 165         CFS_INIT_LIST_HEAD(&t->tl_list);
 166 }
 167
 168 void cfs_timer_init(cfs_timer_t *l, cfs_timer_func_t *func, void *arg)
 169 {
 170         CFS_INIT_LIST_HEAD(&l->tl_list);
 171         l->function = func;
 172         l->data = (ulong_ptr_t)arg;
 173         return;
 174 }
 175
 176 int cfs_timer_is_armed(cfs_timer_t *l)
 177 {
 178         if (cfs_time_before(cfs_time_current(), l->expires))
 179                 return 1;
 180         else
 181                 return 0;
 182 }
 183
 184 void cfs_timer_arm(cfs_timer_t *l, cfs_time_t deadline)
 185 {
 186         l->expires = deadline;
 187 }
 188
 189 void cfs_timer_disarm(cfs_timer_t *l)
 190 {
 191 }
 192 cfs_time_t cfs_timer_deadline(cfs_timer_t *l)
 193 {
 194         return l->expires;
 195 }
 196
 197
 198 #ifdef HAVE_LIBPTHREAD
 199
 200 /*
 201  * Threads
 202  */
 203
 204 struct lustre_thread_arg {
 205         cfs_thread_t f;
 206         void *arg;
 207 };
 208 static void *cfs_thread_helper(void *data)
 209 {
 210         struct lustre_thread_arg *targ = data;
 211         cfs_thread_t f  = targ->f;
 212         void *arg = targ->arg;
 213
 214         free(targ);
 215
 216         (void)f(arg);
 217         return NULL;
 218 }
 219 int cfs_create_thread(cfs_thread_t func, void *arg)
 220 {
 221         pthread_t tid;
 222         pthread_attr_t tattr;
 223         int rc;
 224         struct lustre_thread_arg *targ_p = malloc(sizeof(struct lustre_thread_arg));
 225
 226         if ( targ_p == NULL )
 227                 return -ENOMEM;
 228
 229         targ_p->f = func;
 230         targ_p->arg = arg;
 231
 232         pthread_attr_init(&tattr);
 233         pthread_attr_setdetachstate(&tattr, PTHREAD_CREATE_DETACHED);
 234         rc = pthread_create(&tid, &tattr, cfs_thread_helper, targ_p);
 235         pthread_attr_destroy(&tattr);
 236         return -rc;
 237 }
 238 #endif
 239
 240 uid_t cfs_curproc_uid(void)
 241 {
 242         return getuid();
 243 }
 244
 245 void cfs_enter_debugger(void)
 246 {
 247         /*
 248          * nothing for now.
 249          */
 250 }
 251
 252 void cfs_daemonize(char *str)
 253 {
 254         return;
 255 }
 256
 257 int cfs_daemonize_ctxt(char *str)
 258 {
 259         return 0;
 260 }
 261
 262 cfs_sigset_t cfs_block_allsigs(void)
 263 {
 264         cfs_sigset_t   all;
 265         cfs_sigset_t   old;
 266         int            rc;
 267
 268         sigfillset(&all);
 269         rc = sigprocmask(SIG_SETMASK, &all, &old);
 270         LASSERT(rc == 0);
 271
 272         return old;
 273 }
 274
 275 cfs_sigset_t cfs_block_sigs(cfs_sigset_t blocks)
 276 {
 277         cfs_sigset_t   old;
 278         int   rc;
 279
 280         rc = sigprocmask(SIG_SETMASK, &blocks, &old);
 281         LASSERT (rc == 0);
 282
 283         return old;
 284 }
 285
 286 void cfs_restore_sigs(cfs_sigset_t old)
 287 {
 288         int   rc = sigprocmask(SIG_SETMASK, &old, NULL);
 289
 290         LASSERT (rc == 0);
 291 }
 292
 293 int cfs_signal_pending(void)
 294 {
 295         cfs_sigset_t    empty;
 296         cfs_sigset_t    set;
 297         int  rc;
 298
 299         rc = sigpending(&set);
 300         LASSERT (rc == 0);
 301
 302         sigemptyset(&empty);
 303
 304         return !memcmp(&empty, &set, sizeof(set));
 305 }
 306
 307 void cfs_clear_sigpending(void)
 308 {
 309         return;
 310 }
 311
 312 #ifdef __linux__
 313
 314 /*
 315  * In glibc (NOT in Linux, so check above is not right), implement
 316  * stack-back-tracing through backtrace() function.
 317  */
 318 #include <execinfo.h>
 319
 320 void cfs_stack_trace_fill(struct cfs_stack_trace *trace)
 321 {
 322         backtrace(trace->frame, ARRAY_SIZE(trace->frame));
 323 }
 324
 325 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no)
 326 {
 327         if (0 <= frame_no && frame_no < ARRAY_SIZE(trace->frame))
 328                 return trace->frame[frame_no];
 329         else
 330                 return NULL;
 331 }
 332
 333 #else
 334
 335 void cfs_stack_trace_fill(struct cfs_stack_trace *trace)
 336 {}
 337 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no)
 338 {
 339         return NULL;
 340 }
 341
 342 /* __linux__ */
 343 #endif
 344
 345 void lbug_with_loc(const char *file, const char *func, const int line)
 346 {
 347         /* No libcfs_catastrophe in userspace! */
 348         libcfs_debug_msg(NULL, 0, D_EMERG, file, func, line, "LBUG\n");
 349         abort();
 350 }
 351
 352 /* !__KERNEL__ */
 353 #endif
 354
 355 /*
 356  * Local variables:
 357  * c-indentation-style: "K&R"
 358  * c-basic-offset: 8
 359  * tab-width: 8
 360  * fill-column: 80
 361  * scroll-step: 1
 362  * End:
 363  */