Whamcloud - gitweb
LU-1855 build: fix 'out-of-bounds access' errors
[fs/lustre-release.git] / libcfs / libcfs / user-prim.c
index 5719623..0cc1e3d 100644 (file)
@@ -1,29 +1,44 @@
-/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
- * vim:expandtab:shiftwidth=8:tabstop=8:
+/*
+ * GPL HEADER START
  *
- * Copyright (C) 2004 Cluster File Systems, Inc.
- * Author: Nikita Danilov <nikita@clusterfs.com>
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
- * This file is part of Lustre, http://www.lustre.org.
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 only,
+ * as published by the Free Software Foundation.
  *
- * Lustre is free software; you can redistribute it and/or modify it under the
- * terms of version 2 of the GNU General Public License as published by the
- * Free Software Foundation.
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License version 2 for more details (a copy is included
+ * in the LICENSE file that accompanied this code).
  *
- * Lustre is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
- * details.
+ * You should have received a copy of the GNU General Public License
+ * version 2 along with this program; If not, see
+ * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  *
- * You should have received a copy of the GNU General Public License along
- * with Lustre; if not, write to the Free Software Foundation, Inc., 675 Mass
- * Ave, Cambridge, MA 02139, USA.
+ * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
  *
- * Implementation of portable APIs for user-level.
+ * GPL HEADER END
+ */
+/*
+ * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
+ * Use is subject to license terms.
  *
+ * Copyright (c) 2011, Whamcloud, Inc.
+ */
+/*
+ * This file is part of Lustre, http://www.lustre.org/
+ * Lustre is a trademark of Sun Microsystems, Inc.
+ *
+ * libcfs/libcfs/user-prim.c
+ *
+ * Implementations of portable APIs for liblustre
+ *
+ * Author: Nikita Danilov <nikita@clusterfs.com>
  */
-
-/* Implementations of portable APIs for liblustre */
 
 /*
  * liblustre is single-threaded, so most "synchronization" APIs are trivial.
 
 #ifndef __KERNEL__
 
-#include <libcfs/libcfs.h>
-
-#include <sys/mman.h>
-#ifndef  __CYGWIN__
-#include <stdint.h>
-#ifdef HAVE_ASM_PAGE_H
-#include <asm/page.h>
-#endif
-#ifdef HAVE_SYS_USER_H
-#include <sys/user.h>
-#endif
-#else
-#include <sys/types.h>
-#endif
-#include <stdlib.h>
 #include <string.h>
-#include <signal.h>
-#include <errno.h>
-#include <sys/stat.h>
-#ifdef HAVE_SYS_VFS_H
-#include <sys/vfs.h>
-#endif
+#include <libcfs/libcfs.h>
 
 /*
- * Sleep channel. No-op implementation.
+ * Wait queue. No-op implementation.
  */
 
 void cfs_waitq_init(struct cfs_waitq *waitq)
@@ -86,12 +81,9 @@ void cfs_waitq_add_exclusive(struct cfs_waitq *waitq, struct cfs_waitlink *link)
         (void)link;
 }
 
-void cfs_waitq_forward(struct cfs_waitlink *link, struct cfs_waitq *waitq)
+void cfs_waitq_add_exclusive_head(struct cfs_waitq *waitq, struct cfs_waitlink *link)
 {
-        LASSERT(waitq != NULL);
-        LASSERT(link != NULL);
-        (void)waitq;
-        (void)link;
+        cfs_waitq_add_exclusive(waitq, link);
 }
 
 void cfs_waitq_del(struct cfs_waitq *waitq, struct cfs_waitlink *link)
@@ -127,19 +119,88 @@ void cfs_waitq_broadcast(struct cfs_waitq *waitq)
         (void)waitq;
 }
 
-void cfs_waitq_wait(struct cfs_waitlink *link, int state)
+void cfs_waitq_wait(struct cfs_waitlink *link, cfs_task_state_t state)
 {
         LASSERT(link != NULL);
         (void)link;
+
+        /* well, wait for something to happen */
+        cfs_call_wait_handler(0);
 }
 
-int64_t cfs_waitq_timedwait(struct cfs_waitlink *link, int state, int64_t timeout)
+int64_t cfs_waitq_timedwait(struct cfs_waitlink *link, cfs_task_state_t state,
+                            int64_t timeout)
 {
         LASSERT(link != NULL);
         (void)link;
+        cfs_call_wait_handler(timeout);
         return 0;
 }
 
+void cfs_schedule_timeout_and_set_state(cfs_task_state_t state, int64_t timeout)
+{
+        cfs_waitlink_t    l;
+        /* sleep(timeout) here instead? */
+        cfs_waitq_timedwait(&l, state, timeout);
+}
+
+void
+cfs_pause(cfs_duration_t d)
+{
+        struct timespec s;
+
+        cfs_duration_nsec(d, &s);
+        nanosleep(&s, NULL);
+}
+
+int cfs_need_resched(void)
+{
+        return 0;
+}
+
+void cfs_cond_resched(void)
+{
+}
+
+/*
+ * Timer
+ */
+
+void cfs_init_timer(cfs_timer_t *t)
+{
+        CFS_INIT_LIST_HEAD(&t->tl_list);
+}
+
+void cfs_timer_init(cfs_timer_t *l, cfs_timer_func_t *func, void *arg)
+{
+        CFS_INIT_LIST_HEAD(&l->tl_list);
+        l->function = func;
+        l->data = (ulong_ptr_t)arg;
+        return;
+}
+
+int cfs_timer_is_armed(cfs_timer_t *l)
+{
+        if (cfs_time_before(cfs_time_current(), l->expires))
+                return 1;
+        else
+                return 0;
+}
+
+void cfs_timer_arm(cfs_timer_t *l, cfs_time_t deadline)
+{
+        l->expires = deadline;
+}
+
+void cfs_timer_disarm(cfs_timer_t *l)
+{
+}
+cfs_time_t cfs_timer_deadline(cfs_timer_t *l)
+{
+        return l->expires;
+}
+
+
 #ifdef HAVE_LIBPTHREAD
 
 /*
@@ -147,7 +208,7 @@ int64_t cfs_waitq_timedwait(struct cfs_waitlink *link, int state, int64_t timeou
  */
 
 struct lustre_thread_arg {
-        cfs_thread_t f; 
+        cfs_thread_t f;
         void *arg;
 };
 static void *cfs_thread_helper(void *data)
@@ -157,11 +218,12 @@ static void *cfs_thread_helper(void *data)
         void *arg = targ->arg;
 
         free(targ);
-        
+
         (void)f(arg);
         return NULL;
 }
-int cfs_create_thread(cfs_thread_t func, void *arg)
+
+int cfs_create_thread(cfs_thread_t func, void *arg, unsigned long flags)
 {
         pthread_t tid;
         pthread_attr_t tattr;
@@ -170,11 +232,11 @@ int cfs_create_thread(cfs_thread_t func, void *arg)
 
         if ( targ_p == NULL )
                 return -ENOMEM;
-        
+
         targ_p->f = func;
         targ_p->arg = arg;
 
-        pthread_attr_init(&tattr); 
+        pthread_attr_init(&tattr);
         pthread_attr_setdetachstate(&tattr, PTHREAD_CREATE_DETACHED);
         rc = pthread_create(&tid, &tattr, cfs_thread_helper, targ_p);
         pthread_attr_destroy(&tattr);
@@ -187,94 +249,62 @@ uid_t cfs_curproc_uid(void)
         return getuid();
 }
 
-int cfs_parse_int_tunable(int *value, char *name)
+gid_t cfs_curproc_gid(void)
 {
-        char    *env = getenv(name);
-        char    *end;
-
-        if (env == NULL)
-                return 0;
-
-        *value = strtoull(env, &end, 0);
-        if (*end == 0)
-                return 0;
-
-        CERROR("Can't parse tunable %s=%s\n", name, env);
-        return -EINVAL;
+        return getgid();
 }
 
-/*
- * Allocator
- */
-
-cfs_page_t *cfs_alloc_page(unsigned int flags)
+uid_t cfs_curproc_fsuid(void)
 {
-        cfs_page_t *pg = malloc(sizeof(*pg));
-
-        if (!pg)
-                return NULL;
-        pg->addr = malloc(CFS_PAGE_SIZE);
-
-        if (!pg->addr) {
-                free(pg);
-                return NULL;
-        }
-        return pg;
+        return getuid();
 }
 
-void cfs_free_page(cfs_page_t *pg)
+gid_t cfs_curproc_fsgid(void)
 {
-        free(pg->addr);
-        free(pg);
+        return getgid();
 }
 
-void *cfs_page_address(cfs_page_t *pg)
+#ifndef HAVE_STRLCPY /* not in glibc for RHEL 5.x, remove when obsolete */
+size_t strlcpy(char *tgt, const char *src, size_t tgt_len)
 {
-        return pg->addr;
-}
+       int src_len = strlen(src);
 
-void *cfs_kmap(cfs_page_t *pg)
-{
-        return pg->addr;
-}
+       strncpy(tgt, src, tgt_len - 1);
+       tgt[tgt_len - 1] = '\0';
 
-void cfs_kunmap(cfs_page_t *pg)
-{
+       return src_len + 1;
 }
+#endif
 
-/*
- * SLAB allocator
- */
-
-cfs_mem_cache_t *
-cfs_mem_cache_create(const char *name, size_t objsize, size_t off, unsigned long flags)
+#ifndef HAVE_STRLCAT /* not in glibc for RHEL 5.x, remove when obsolete */
+size_t strlcat(char *tgt, const char *src, size_t size)
 {
-        cfs_mem_cache_t *c;
+       size_t tgt_len = strlen(tgt);
 
-        c = malloc(sizeof(*c));
-        if (!c)
-                return NULL;
-        c->size = objsize;
-        CDEBUG(D_MALLOC, "alloc slab cache %s at %p, objsize %d\n",
-               name, c, (int)objsize);
-        return c;
-}
+       if (size > tgt_len) {
+               strncat(tgt, src, size - tgt_len - 1);
+               tgt[size - 1] = '\0';
+       }
 
-int cfs_mem_cache_destroy(cfs_mem_cache_t *c)
-{
-        CDEBUG(D_MALLOC, "destroy slab cache %p, objsize %u\n", c, c->size);
-        free(c);
-        return 0;
+       return tgt_len + strlen(src);
 }
+#endif
 
-void *cfs_mem_cache_alloc(cfs_mem_cache_t *c, int gfp)
+/* Read the environment variable of current process specified by @key. */
+int cfs_get_environ(const char *key, char *value, int *val_len)
 {
-        return cfs_alloc(c->size, gfp);
-}
+       char *entry;
+       int len;
 
-void cfs_mem_cache_free(cfs_mem_cache_t *c, void *addr)
-{
-        cfs_free(addr);
+       entry = getenv(key);
+       if (entry == NULL)
+               return -ENOENT;
+
+       len = strlcpy(value, entry, *val_len);
+       if (len >= *val_len)
+               return -EOVERFLOW;
+
+       return 0;
 }
 
 void cfs_enter_debugger(void)
@@ -296,24 +326,39 @@ int cfs_daemonize_ctxt(char *str)
 
 cfs_sigset_t cfs_block_allsigs(void)
 {
-        cfs_sigset_t   all;
-        cfs_sigset_t   old;
-        int            rc;
+       cfs_sigset_t   all;
+       cfs_sigset_t   old;
+       int            rc;
 
-        sigfillset(&all);
-        rc = sigprocmask(SIG_SETMASK, &all, &old);
-        LASSERT(rc == 0);
+       sigfillset(&all);
+       rc = sigprocmask(SIG_BLOCK, &all, &old);
+       LASSERT(rc == 0);
 
-        return old;
+       return old;
 }
 
-cfs_sigset_t cfs_block_sigs(cfs_sigset_t blocks)
+cfs_sigset_t cfs_block_sigs(unsigned long sigs)
 {
-        cfs_sigset_t   old;
-        int   rc;
-        
-        rc = sigprocmask(SIG_SETMASK, &blocks, &old);
-        LASSERT (rc == 0);
+       cfs_sigset_t   old;
+       cfs_sigset_t   blocks = { { sigs } }; /* kludge */
+       int   rc;
+
+       rc = sigprocmask(SIG_BLOCK, &blocks, &old);
+       LASSERT (rc == 0);
+
+       return old;
+}
+
+/* Block all signals except for the @sigs. It's only used in
+ * Linux kernel, just a dummy here. */
+cfs_sigset_t cfs_block_sigsinv(unsigned long sigs)
+{
+        cfs_sigset_t old;
+        int rc;
+
+        /* Return old blocked sigs */
+        rc = sigprocmask(SIG_SETMASK, NULL, &old);
+        LASSERT(rc == 0);
 
         return old;
 }
@@ -354,12 +399,12 @@ void cfs_clear_sigpending(void)
 
 void cfs_stack_trace_fill(struct cfs_stack_trace *trace)
 {
-        backtrace(trace->frame, sizeof_array(trace->frame));
+        backtrace(trace->frame, ARRAY_SIZE(trace->frame));
 }
 
 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no)
 {
-        if (0 <= frame_no && frame_no < sizeof_array(trace->frame))
+        if (0 <= frame_no && frame_no < ARRAY_SIZE(trace->frame))
                 return trace->frame[frame_no];
         else
                 return NULL;
@@ -377,10 +422,10 @@ void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no)
 /* __linux__ */
 #endif
 
-void lbug_with_loc(char *file, const char *func, const int line)
+void lbug_with_loc(struct libcfs_debug_msg_data *msgdata)
 {
         /* No libcfs_catastrophe in userspace! */
-        libcfs_debug_msg(NULL, 0, D_EMERG, file, func, line, "LBUG\n");
+        libcfs_debug_msg(msgdata, "LBUG\n");
         abort();
 }