libcfs/libcfs/linux/linux-curproc.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2015, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * libcfs/libcfs/linux/linux-curproc.c
  33  *
  34  * Lustre curproc API implementation for Linux kernel
  35  *
  36  * Author: Nikita Danilov <nikita@clusterfs.com>
  37  */
  38
  39 #include <linux/sched.h>
  40 #include <linux/fs_struct.h>
  41
  42 #include <linux/compat.h>
  43 #include <linux/thread_info.h>
  44
  45 #define DEBUG_SUBSYSTEM S_LNET
  46
  47 #include <libcfs/libcfs.h>
  48
  49 /*
  50  * Implementation of cfs_curproc API (see portals/include/libcfs/curproc.h)
  51  * for Linux kernel.
  52  */
  53
  54 /* Currently all the CFS_CAP_* defines match CAP_* ones. */
  55 #define cfs_cap_pack(cap) (cap)
  56 #define cfs_cap_unpack(cap) (cap)
  57
  58 void cfs_cap_raise(cfs_cap_t cap)
  59 {
  60         struct cred *cred;
  61         if ((cred = prepare_creds())) {
  62                 cap_raise(cred->cap_effective, cfs_cap_unpack(cap));
  63                 commit_creds(cred);
  64         }
  65 }
  66
  67 void cfs_cap_lower(cfs_cap_t cap)
  68 {
  69         struct cred *cred;
  70         if ((cred = prepare_creds())) {
  71                 cap_lower(cred->cap_effective, cfs_cap_unpack(cap));
  72                 commit_creds(cred);
  73         }
  74 }
  75
  76 int cfs_cap_raised(cfs_cap_t cap)
  77 {
  78         return cap_raised(current_cap(), cfs_cap_unpack(cap));
  79 }
  80
  81 static void cfs_kernel_cap_pack(kernel_cap_t kcap, cfs_cap_t *cap)
  82 {
  83 #if defined (_LINUX_CAPABILITY_VERSION) && _LINUX_CAPABILITY_VERSION == 0x19980330
  84         *cap = cfs_cap_pack(kcap);
  85 #elif defined (_LINUX_CAPABILITY_VERSION) && _LINUX_CAPABILITY_VERSION == 0x20071026
  86         *cap = cfs_cap_pack(kcap[0]);
  87 #elif defined(_KERNEL_CAPABILITY_VERSION) && _KERNEL_CAPABILITY_VERSION == 0x20080522
  88         /* XXX lost high byte */
  89         *cap = cfs_cap_pack(kcap.cap[0]);
  90 #else
  91         #error "need correct _KERNEL_CAPABILITY_VERSION "
  92 #endif
  93 }
  94
  95 static void cfs_kernel_cap_unpack(kernel_cap_t *kcap, cfs_cap_t cap)
  96 {
  97 #if defined (_LINUX_CAPABILITY_VERSION) && _LINUX_CAPABILITY_VERSION == 0x19980330
  98         *kcap = cfs_cap_unpack(cap);
  99 #elif defined (_LINUX_CAPABILITY_VERSION) && _LINUX_CAPABILITY_VERSION == 0x20071026
 100         (*kcap)[0] = cfs_cap_unpack(cap);
 101 #elif defined(_KERNEL_CAPABILITY_VERSION) && _KERNEL_CAPABILITY_VERSION == 0x20080522
 102         kcap->cap[0] = cfs_cap_unpack(cap);
 103 #else
 104         #error "need correct _KERNEL_CAPABILITY_VERSION "
 105 #endif
 106 }
 107
 108 cfs_cap_t cfs_curproc_cap_pack(void)
 109 {
 110         cfs_cap_t cap;
 111         cfs_kernel_cap_pack(current_cap(), &cap);
 112         return cap;
 113 }
 114
 115 void cfs_curproc_cap_unpack(cfs_cap_t cap)
 116 {
 117         struct cred *cred;
 118         if ((cred = prepare_creds())) {
 119                 cfs_kernel_cap_unpack(&cred->cap_effective, cap);
 120                 commit_creds(cred);
 121         }
 122 }
 123
 124 int cfs_capable(cfs_cap_t cap)
 125 {
 126         return capable(cfs_cap_unpack(cap));
 127 }
 128
 129 static int cfs_access_process_vm(struct task_struct *tsk,
 130                                  struct mm_struct *mm,
 131                                  unsigned long addr,
 132                                  void *buf, int len, int write)
 133 {
 134         /* Just copied from kernel for the kernels which doesn't
 135          * have access_process_vm() exported */
 136         struct vm_area_struct *vma;
 137         struct page *page;
 138         void *old_buf = buf;
 139
 140         /* Avoid deadlocks on mmap_sem if called from sys_mmap_pgoff(),
 141          * which is already holding mmap_sem for writes.  If some other
 142          * thread gets the write lock in the meantime, this thread will
 143          * block, but at least it won't deadlock on itself.  LU-1735 */
 144         if (down_read_trylock(&mm->mmap_sem) == 0)
 145                 return -EDEADLK;
 146
 147         /* ignore errors, just check how much was successfully transferred */
 148         while (len) {
 149                 int bytes, rc, offset;
 150                 void *maddr;
 151
 152 #ifdef HAVE_GET_USER_PAGES_6ARG
 153                 rc = get_user_pages(addr, 1, write, 1, &page, &vma);
 154 #else
 155                 rc = get_user_pages(tsk, mm, addr, 1, write, 1, &page, &vma);
 156 #endif
 157                 if (rc <= 0)
 158                         break;
 159
 160                 bytes = len;
 161                 offset = addr & (PAGE_SIZE-1);
 162                 if (bytes > PAGE_SIZE-offset)
 163                         bytes = PAGE_SIZE-offset;
 164
 165                 maddr = kmap(page);
 166                 if (write) {
 167                         copy_to_user_page(vma, page, addr,
 168                                           maddr + offset, buf, bytes);
 169                         set_page_dirty_lock(page);
 170                 } else {
 171                         copy_from_user_page(vma, page, addr,
 172                                             buf, maddr + offset, bytes);
 173                 }
 174                 kunmap(page);
 175                 put_page(page);
 176                 len -= bytes;
 177                 buf += bytes;
 178                 addr += bytes;
 179         }
 180         up_read(&mm->mmap_sem);
 181
 182         return buf - old_buf;
 183 }
 184
 185 /* Read the environment variable of current process specified by @key. */
 186 int cfs_get_environ(const char *key, char *value, int *val_len)
 187 {
 188         struct mm_struct *mm;
 189         char *buffer;
 190         int buf_len = PAGE_SIZE;
 191         int key_len = strlen(key);
 192         unsigned long addr;
 193         int rc;
 194         bool skip = false;
 195         ENTRY;
 196
 197         buffer = kmalloc(buf_len, GFP_USER);
 198         if (!buffer)
 199                 RETURN(-ENOMEM);
 200
 201         mm = get_task_mm(current);
 202         if (!mm) {
 203                 kfree(buffer);
 204                 RETURN(-EINVAL);
 205         }
 206
 207         addr = mm->env_start;
 208         while (addr < mm->env_end) {
 209                 int this_len, retval, scan_len;
 210                 char *env_start, *env_end;
 211
 212                 memset(buffer, 0, buf_len);
 213
 214                 this_len = min_t(int, mm->env_end - addr, buf_len);
 215                 retval = cfs_access_process_vm(current, mm, addr, buffer,
 216                                                this_len, 0);
 217                 if (retval < 0)
 218                         GOTO(out, rc = retval);
 219                 else if (retval != this_len)
 220                         break;
 221
 222                 addr += retval;
 223
 224                 /* Parse the buffer to find out the specified key/value pair.
 225                  * The "key=value" entries are separated by '\0'. */
 226                 env_start = buffer;
 227                 scan_len = this_len;
 228                 while (scan_len) {
 229                         char *entry;
 230                         int entry_len;
 231
 232                         env_end = memscan(env_start, '\0', scan_len);
 233                         LASSERT(env_end >= env_start &&
 234                                 env_end <= env_start + scan_len);
 235
 236                         /* The last entry of this buffer cross the buffer
 237                          * boundary, reread it in next cycle. */
 238                         if (unlikely(env_end - env_start == scan_len)) {
 239                                 /* Just skip the entry larger than page size,
 240                                  * it can't be jobID env variable. */
 241                                 if (unlikely(scan_len == this_len))
 242                                         skip = true;
 243                                 else
 244                                         addr -= scan_len;
 245                                 break;
 246                         } else if (unlikely(skip)) {
 247                                 skip = false;
 248                                 goto skip;
 249                         }
 250
 251                         entry = env_start;
 252                         entry_len = env_end - env_start;
 253
 254                         /* Key length + length of '=' */
 255                         if (entry_len > key_len + 1 &&
 256                             !memcmp(entry, key, key_len)) {
 257                                 entry += key_len + 1;
 258                                 entry_len -= key_len + 1;
 259                                 /* The 'value' buffer passed in is too small.*/
 260                                 if (entry_len >= *val_len)
 261                                         GOTO(out, rc = -EOVERFLOW);
 262
 263                                 memcpy(value, entry, entry_len);
 264                                 *val_len = entry_len;
 265                                 GOTO(out, rc = 0);
 266                         }
 267 skip:
 268                         scan_len -= (env_end - env_start + 1);
 269                         env_start = env_end + 1;
 270                 }
 271         }
 272         GOTO(out, rc = -ENOENT);
 273
 274 out:
 275         mmput(mm);
 276         kfree((void *)buffer);
 277         return rc;
 278 }
 279 EXPORT_SYMBOL(cfs_get_environ);
 280
 281 EXPORT_SYMBOL(cfs_cap_raise);
 282 EXPORT_SYMBOL(cfs_cap_lower);
 283 EXPORT_SYMBOL(cfs_cap_raised);
 284 EXPORT_SYMBOL(cfs_curproc_cap_pack);
 285 EXPORT_SYMBOL(cfs_capable);
 286
 287 /*
 288  * Local variables:
 289  * c-indentation-style: "K&R"
 290  * c-basic-offset: 8
 291  * tab-width: 8
 292  * fill-column: 80
 293  * scroll-step: 1
 294  * End:
 295  */