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 [sun.com URL with a
  20  * copy of GPLv2].
  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
 122 int64_t cfs_waitq_timedwait(struct cfs_waitlink *link, cfs_task_state_t state,
 123                             int64_t timeout)
 124 {
 125         LASSERT(link != NULL);
 126         (void)link;
 127         return 0;
 128 }
 129
 130 void cfs_schedule_timeout(cfs_task_state_t state, int64_t timeout)
 131 {
 132         cfs_waitlink_t    l;
 133         /* sleep(timeout) here instead? */
 134         cfs_waitq_timedwait(&l, state, timeout);
 135 }
 136
 137 void
 138 cfs_pause(cfs_duration_t d)
 139 {
 140         struct timespec s;
 141
 142         cfs_duration_nsec(d, &s);
 143         nanosleep(&s, NULL);
 144 }
 145
 146 /*
 147  * Timer
 148  */
 149
 150 void cfs_init_timer(cfs_timer_t *t)
 151 {
 152         CFS_INIT_LIST_HEAD(&t->tl_list);
 153 }
 154
 155 void cfs_timer_init(cfs_timer_t *l, cfs_timer_func_t *func, void *arg)
 156 {
 157         CFS_INIT_LIST_HEAD(&l->tl_list);
 158         l->function = func;
 159         l->data = (unsigned long)arg;
 160         return;
 161 }
 162
 163 #define cfs_jiffies                             \
 164 ({                                              \
 165         unsigned long _ret = 0;                 \
 166         struct timeval tv;                      \
 167         if (gettimeofday(&tv, NULL) == 0)       \
 168                 _ret = tv.tv_sec;               \
 169         _ret;                                   \
 170 })
 171
 172 int cfs_timer_is_armed(cfs_timer_t *l)
 173 {
 174         if (cfs_time_before(cfs_jiffies, l->expires))
 175                 return 1;
 176         else
 177                 return 0;
 178 }
 179
 180 void cfs_timer_arm(cfs_timer_t *l, cfs_time_t deadline)
 181 {
 182         l->expires = deadline;
 183 }
 184
 185 void cfs_timer_disarm(cfs_timer_t *l)
 186 {
 187 }
 188
 189 long cfs_timer_deadline(cfs_timer_t *l)
 190 {
 191         return l->expires;
 192 }
 193
 194
 195 #ifdef HAVE_LIBPTHREAD
 196
 197 /*
 198  * Threads
 199  */
 200
 201 struct lustre_thread_arg {
 202         cfs_thread_t f;
 203         void *arg;
 204 };
 205 static void *cfs_thread_helper(void *data)
 206 {
 207         struct lustre_thread_arg *targ = data;
 208         cfs_thread_t f  = targ->f;
 209         void *arg = targ->arg;
 210
 211         free(targ);
 212
 213         (void)f(arg);
 214         return NULL;
 215 }
 216 int cfs_create_thread(cfs_thread_t func, void *arg)
 217 {
 218         pthread_t tid;
 219         pthread_attr_t tattr;
 220         int rc;
 221         struct lustre_thread_arg *targ_p = malloc(sizeof(struct lustre_thread_arg));
 222
 223         if ( targ_p == NULL )
 224                 return -ENOMEM;
 225
 226         targ_p->f = func;
 227         targ_p->arg = arg;
 228
 229         pthread_attr_init(&tattr);
 230         pthread_attr_setdetachstate(&tattr, PTHREAD_CREATE_DETACHED);
 231         rc = pthread_create(&tid, &tattr, cfs_thread_helper, targ_p);
 232         pthread_attr_destroy(&tattr);
 233         return -rc;
 234 }
 235 #endif
 236
 237 uid_t cfs_curproc_uid(void)
 238 {
 239         return getuid();
 240 }
 241
 242 int cfs_parse_int_tunable(int *value, char *name)
 243 {
 244         char    *env = getenv(name);
 245         char    *end;
 246
 247         if (env == NULL)
 248                 return 0;
 249
 250         *value = strtoull(env, &end, 0);
 251         if (*end == 0)
 252                 return 0;
 253
 254         CERROR("Can't parse tunable %s=%s\n", name, env);
 255         return -EINVAL;
 256 }
 257
 258
 259 void cfs_enter_debugger(void)
 260 {
 261         /*
 262          * nothing for now.
 263          */
 264 }
 265
 266 void cfs_daemonize(char *str)
 267 {
 268         return;
 269 }
 270
 271 int cfs_daemonize_ctxt(char *str)
 272 {
 273         return 0;
 274 }
 275
 276 cfs_sigset_t cfs_block_allsigs(void)
 277 {
 278         cfs_sigset_t   all;
 279         cfs_sigset_t   old;
 280         int            rc;
 281
 282         sigfillset(&all);
 283         rc = sigprocmask(SIG_SETMASK, &all, &old);
 284         LASSERT(rc == 0);
 285
 286         return old;
 287 }
 288
 289 cfs_sigset_t cfs_block_sigs(cfs_sigset_t blocks)
 290 {
 291         cfs_sigset_t   old;
 292         int   rc;
 293
 294         rc = sigprocmask(SIG_SETMASK, &blocks, &old);
 295         LASSERT (rc == 0);
 296
 297         return old;
 298 }
 299
 300 void cfs_restore_sigs(cfs_sigset_t old)
 301 {
 302         int   rc = sigprocmask(SIG_SETMASK, &old, NULL);
 303
 304         LASSERT (rc == 0);
 305 }
 306
 307 int cfs_signal_pending(void)
 308 {
 309         cfs_sigset_t    empty;
 310         cfs_sigset_t    set;
 311         int  rc;
 312
 313         rc = sigpending(&set);
 314         LASSERT (rc == 0);
 315
 316         sigemptyset(&empty);
 317
 318         return !memcmp(&empty, &set, sizeof(set));
 319 }
 320
 321 void cfs_clear_sigpending(void)
 322 {
 323         return;
 324 }
 325
 326 #ifdef __linux__
 327
 328 /*
 329  * In glibc (NOT in Linux, so check above is not right), implement
 330  * stack-back-tracing through backtrace() function.
 331  */
 332 #include <execinfo.h>
 333
 334 void cfs_stack_trace_fill(struct cfs_stack_trace *trace)
 335 {
 336         backtrace(trace->frame, ARRAY_SIZE(trace->frame));
 337 }
 338
 339 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no)
 340 {
 341         if (0 <= frame_no && frame_no < ARRAY_SIZE(trace->frame))
 342                 return trace->frame[frame_no];
 343         else
 344                 return NULL;
 345 }
 346
 347 #else
 348
 349 void cfs_stack_trace_fill(struct cfs_stack_trace *trace)
 350 {}
 351 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no)
 352 {
 353         return NULL;
 354 }
 355
 356 /* __linux__ */
 357 #endif
 358
 359 void lbug_with_loc(char *file, const char *func, const int line)
 360 {
 361         /* No libcfs_catastrophe in userspace! */
 362         libcfs_debug_msg(NULL, 0, D_EMERG, file, func, line, "LBUG\n");
 363         abort();
 364 }
 365
 366 /* !__KERNEL__ */
 367 #endif
 368
 369 /*
 370  * Local variables:
 371  * c-indentation-style: "K&R"
 372  * c-basic-offset: 8
 373  * tab-width: 8
 374  * fill-column: 80
 375  * scroll-step: 1
 376  * End:
 377  */