fs/sdcardfs/sdcardfs.h

   1 /*
   2  * fs/sdcardfs/sdcardfs.h
   3  *
   4  * The sdcardfs v2.0
   5  *   This file system replaces the sdcard daemon on Android
   6  *   On version 2.0, some of the daemon functions have been ported
   7  *   to support the multi-user concepts of Android 4.4
   8  *
   9  * Copyright (c) 2013 Samsung Electronics Co. Ltd
  10  *   Authors: Daeho Jeong, Woojoong Lee, Seunghwan Hyun,
  11  *               Sunghwan Yun, Sungjong Seo
  12  *
  13  * This program has been developed as a stackable file system based on
  14  * the WrapFS which written by
  15  *
  16  * Copyright (c) 1998-2011 Erez Zadok
  17  * Copyright (c) 2009     Shrikar Archak
  18  * Copyright (c) 2003-2011 Stony Brook University
  19  * Copyright (c) 2003-2011 The Research Foundation of SUNY
  20  *
  21  * This file is dual licensed.  It may be redistributed and/or modified
  22  * under the terms of the Apache 2.0 License OR version 2 of the GNU
  23  * General Public License.
  24  */
  25
  26 #ifndef _SDCARDFS_H_
  27 #define _SDCARDFS_H_
  28
  29 #include <linux/dcache.h>
  30 #include <linux/file.h>
  31 #include <linux/fs.h>
  32 #include <linux/mm.h>
  33 #include <linux/mount.h>
  34 #include <linux/namei.h>
  35 #include <linux/seq_file.h>
  36 #include <linux/statfs.h>
  37 #include <linux/fs_stack.h>
  38 #include <linux/magic.h>
  39 #include <linux/uaccess.h>
  40 #include <linux/slab.h>
  41 #include <linux/sched.h>
  42 #include <linux/types.h>
  43 #include <linux/security.h>
  44 #include <linux/string.h>
  45 #include <linux/list.h>
  46 #include "multiuser.h"
  47
  48 /* the file system name */
  49 #define SDCARDFS_NAME "sdcardfs"
  50
  51 /* sdcardfs root inode number */
  52 #define SDCARDFS_ROOT_INO     1
  53
  54 /* useful for tracking code reachability */
  55 #define UDBG printk(KERN_DEFAULT "DBG:%s:%s:%d\n", __FILE__, __func__, __LINE__)
  56
  57 #define SDCARDFS_DIRENT_SIZE 256
  58
  59 /* temporary static uid settings for development */
  60 #define AID_ROOT             0  /* uid for accessing /mnt/sdcard & extSdcard */
  61 #define AID_MEDIA_RW      1023  /* internal media storage write access */
  62
  63 #define AID_SDCARD_RW     1015  /* external storage write access */
  64 #define AID_SDCARD_R      1028  /* external storage read access */
  65 #define AID_SDCARD_PICS   1033  /* external storage photos access */
  66 #define AID_SDCARD_AV     1034  /* external storage audio/video access */
  67 #define AID_SDCARD_ALL    1035  /* access all users external storage */
  68
  69 #define AID_PACKAGE_INFO  1027
  70
  71 #define fix_derived_permission(x)       \
  72         do {                                            \
  73                 (x)->i_uid = make_kuid(&init_user_ns, SDCARDFS_I(x)->d_uid);    \
  74                 (x)->i_gid = make_kgid(&init_user_ns, get_gid(SDCARDFS_I(x)));  \
  75                 (x)->i_mode = ((x)->i_mode & S_IFMT) | get_mode(SDCARDFS_I(x));\
  76         } while (0)
  77
  78
  79 /* OVERRIDE_CRED() and REVERT_CRED()
  80  *      OVERRID_CRED()
  81  *              backup original task->cred
  82  *              and modifies task->cred->fsuid/fsgid to specified value.
  83  *      REVERT_CRED()
  84  *              restore original task->cred->fsuid/fsgid.
  85  * These two macro should be used in pair, and OVERRIDE_CRED() should be
  86  * placed at the beginning of a function, right after variable declaration.
  87  */
  88 #define OVERRIDE_CRED(sdcardfs_sbi, saved_cred)         \
  89         saved_cred = override_fsids(sdcardfs_sbi);      \
  90         if (!saved_cred) { return -ENOMEM; }
  91
  92 #define OVERRIDE_CRED_PTR(sdcardfs_sbi, saved_cred)     \
  93         saved_cred = override_fsids(sdcardfs_sbi);      \
  94         if (!saved_cred) { return ERR_PTR(-ENOMEM); }
  95
  96 #define REVERT_CRED(saved_cred) revert_fsids(saved_cred)
  97
  98 #define DEBUG_CRED()            \
  99         printk("KAKJAGI: %s:%d fsuid %d fsgid %d\n",    \
 100                 __FUNCTION__, __LINE__,                 \
 101                 (int)current->cred->fsuid,              \
 102                 (int)current->cred->fsgid);
 103
 104 /* Android 5.0 support */
 105
 106 /* Permission mode for a specific node. Controls how file permissions
 107  * are derived for children nodes. */
 108 typedef enum {
 109     /* Nothing special; this node should just inherit from its parent. */
 110     PERM_INHERIT,
 111     /* This node is one level above a normal root; used for legacy layouts
 112      * which use the first level to represent user_id. */
 113     PERM_PRE_ROOT,
 114     /* This node is "/" */
 115     PERM_ROOT,
 116     /* This node is "/Android" */
 117     PERM_ANDROID,
 118     /* This node is "/Android/data" */
 119     PERM_ANDROID_DATA,
 120     /* This node is "/Android/obb" */
 121     PERM_ANDROID_OBB,
 122     /* This node is "/Android/media" */
 123     PERM_ANDROID_MEDIA,
 124 } perm_t;
 125
 126 typedef enum {
 127         LOWER_FS_EXT4,
 128         LOWER_FS_FAT,
 129 } lower_fs_t;
 130
 131 struct sdcardfs_sb_info;
 132 struct sdcardfs_mount_options;
 133
 134 /* Do not directly use this function. Use OVERRIDE_CRED() instead. */
 135 const struct cred * override_fsids(struct sdcardfs_sb_info* sbi);
 136 /* Do not directly use this function, use REVERT_CRED() instead. */
 137 void revert_fsids(const struct cred * old_cred);
 138
 139 /* operations vectors defined in specific files */
 140 extern const struct file_operations sdcardfs_main_fops;
 141 extern const struct file_operations sdcardfs_dir_fops;
 142 extern const struct inode_operations sdcardfs_main_iops;
 143 extern const struct inode_operations sdcardfs_dir_iops;
 144 extern const struct inode_operations sdcardfs_symlink_iops;
 145 extern const struct super_operations sdcardfs_sops;
 146 extern const struct dentry_operations sdcardfs_ci_dops;
 147 extern const struct address_space_operations sdcardfs_aops, sdcardfs_dummy_aops;
 148 extern const struct vm_operations_struct sdcardfs_vm_ops;
 149
 150 extern int sdcardfs_init_inode_cache(void);
 151 extern void sdcardfs_destroy_inode_cache(void);
 152 extern int sdcardfs_init_dentry_cache(void);
 153 extern void sdcardfs_destroy_dentry_cache(void);
 154 extern int new_dentry_private_data(struct dentry *dentry);
 155 extern void free_dentry_private_data(struct dentry *dentry);
 156 extern struct dentry *sdcardfs_lookup(struct inode *dir, struct dentry *dentry,
 157                                 unsigned int flags);
 158 extern struct inode *sdcardfs_iget(struct super_block *sb,
 159                                  struct inode *lower_inode, userid_t id);
 160 extern int sdcardfs_interpose(struct dentry *dentry, struct super_block *sb,
 161                             struct path *lower_path, userid_t id);
 162
 163 /* file private data */
 164 struct sdcardfs_file_info {
 165         struct file *lower_file;
 166         const struct vm_operations_struct *lower_vm_ops;
 167 };
 168
 169 /* sdcardfs inode data in memory */
 170 struct sdcardfs_inode_info {
 171         struct inode *lower_inode;
 172         /* state derived based on current position in hierachy */
 173         perm_t perm;
 174         userid_t userid;
 175         uid_t d_uid;
 176         bool under_android;
 177
 178         struct inode vfs_inode;
 179 };
 180
 181
 182 /* sdcardfs dentry data in memory */
 183 struct sdcardfs_dentry_info {
 184         spinlock_t lock;        /* protects lower_path */
 185         struct path lower_path;
 186         struct path orig_path;
 187 };
 188
 189 struct sdcardfs_mount_options {
 190         uid_t fs_low_uid;
 191         gid_t fs_low_gid;
 192         userid_t fs_user_id;
 193         gid_t gid;
 194         lower_fs_t lower_fs;
 195         mode_t mask;
 196         bool multiuser;
 197         unsigned int reserved_mb;
 198 };
 199
 200 /* sdcardfs super-block data in memory */
 201 struct sdcardfs_sb_info {
 202         struct super_block *sb;
 203         struct super_block *lower_sb;
 204         /* derived perm policy : some of options have been added
 205          * to sdcardfs_mount_options (Android 4.4 support) */
 206         struct sdcardfs_mount_options options;
 207         spinlock_t lock;        /* protects obbpath */
 208         char *obbpath_s;
 209         struct path obbpath;
 210         void *pkgl_id;
 211         struct list_head list;
 212 };
 213
 214 /*
 215  * inode to private data
 216  *
 217  * Since we use containers and the struct inode is _inside_ the
 218  * sdcardfs_inode_info structure, SDCARDFS_I will always (given a non-NULL
 219  * inode pointer), return a valid non-NULL pointer.
 220  */
 221 static inline struct sdcardfs_inode_info *SDCARDFS_I(const struct inode *inode)
 222 {
 223         return container_of(inode, struct sdcardfs_inode_info, vfs_inode);
 224 }
 225
 226 /* dentry to private data */
 227 #define SDCARDFS_D(dent) ((struct sdcardfs_dentry_info *)(dent)->d_fsdata)
 228
 229 /* superblock to private data */
 230 #define SDCARDFS_SB(super) ((struct sdcardfs_sb_info *)(super)->s_fs_info)
 231
 232 /* file to private Data */
 233 #define SDCARDFS_F(file) ((struct sdcardfs_file_info *)((file)->private_data))
 234
 235 /* file to lower file */
 236 static inline struct file *sdcardfs_lower_file(const struct file *f)
 237 {
 238         return SDCARDFS_F(f)->lower_file;
 239 }
 240
 241 static inline void sdcardfs_set_lower_file(struct file *f, struct file *val)
 242 {
 243         SDCARDFS_F(f)->lower_file = val;
 244 }
 245
 246 /* inode to lower inode. */
 247 static inline struct inode *sdcardfs_lower_inode(const struct inode *i)
 248 {
 249         return SDCARDFS_I(i)->lower_inode;
 250 }
 251
 252 static inline void sdcardfs_set_lower_inode(struct inode *i, struct inode *val)
 253 {
 254         SDCARDFS_I(i)->lower_inode = val;
 255 }
 256
 257 /* superblock to lower superblock */
 258 static inline struct super_block *sdcardfs_lower_super(
 259         const struct super_block *sb)
 260 {
 261         return SDCARDFS_SB(sb)->lower_sb;
 262 }
 263
 264 static inline void sdcardfs_set_lower_super(struct super_block *sb,
 265                                           struct super_block *val)
 266 {
 267         SDCARDFS_SB(sb)->lower_sb = val;
 268 }
 269
 270 /* path based (dentry/mnt) macros */
 271 static inline void pathcpy(struct path *dst, const struct path *src)
 272 {
 273         dst->dentry = src->dentry;
 274         dst->mnt = src->mnt;
 275 }
 276
 277 /* sdcardfs_get_pname functions calls path_get()
 278  * therefore, the caller must call "proper" path_put functions
 279  */
 280 #define SDCARDFS_DENT_FUNC(pname) \
 281 static inline void sdcardfs_get_##pname(const struct dentry *dent, \
 282                                         struct path *pname) \
 283 { \
 284         spin_lock(&SDCARDFS_D(dent)->lock); \
 285         pathcpy(pname, &SDCARDFS_D(dent)->pname); \
 286         path_get(pname); \
 287         spin_unlock(&SDCARDFS_D(dent)->lock); \
 288         return; \
 289 } \
 290 static inline void sdcardfs_put_##pname(const struct dentry *dent, \
 291                                         struct path *pname) \
 292 { \
 293         path_put(pname); \
 294         return; \
 295 } \
 296 static inline void sdcardfs_set_##pname(const struct dentry *dent, \
 297                                         struct path *pname) \
 298 { \
 299         spin_lock(&SDCARDFS_D(dent)->lock); \
 300         pathcpy(&SDCARDFS_D(dent)->pname, pname); \
 301         spin_unlock(&SDCARDFS_D(dent)->lock); \
 302         return; \
 303 } \
 304 static inline void sdcardfs_reset_##pname(const struct dentry *dent) \
 305 { \
 306         spin_lock(&SDCARDFS_D(dent)->lock); \
 307         SDCARDFS_D(dent)->pname.dentry = NULL; \
 308         SDCARDFS_D(dent)->pname.mnt = NULL; \
 309         spin_unlock(&SDCARDFS_D(dent)->lock); \
 310         return; \
 311 } \
 312 static inline void sdcardfs_put_reset_##pname(const struct dentry *dent) \
 313 { \
 314         struct path pname; \
 315         spin_lock(&SDCARDFS_D(dent)->lock); \
 316         if(SDCARDFS_D(dent)->pname.dentry) { \
 317                 pathcpy(&pname, &SDCARDFS_D(dent)->pname); \
 318                 SDCARDFS_D(dent)->pname.dentry = NULL; \
 319                 SDCARDFS_D(dent)->pname.mnt = NULL; \
 320                 spin_unlock(&SDCARDFS_D(dent)->lock); \
 321                 path_put(&pname); \
 322         } else \
 323                 spin_unlock(&SDCARDFS_D(dent)->lock); \
 324         return; \
 325 }
 326
 327 SDCARDFS_DENT_FUNC(lower_path)
 328 SDCARDFS_DENT_FUNC(orig_path)
 329
 330 static inline int get_gid(struct sdcardfs_inode_info *info) {
 331         struct sdcardfs_sb_info *sb_info = SDCARDFS_SB(info->vfs_inode.i_sb);
 332         if (sb_info->options.gid == AID_SDCARD_RW) {
 333                 /* As an optimization, certain trusted system components only run
 334                  * as owner but operate across all users. Since we're now handing
 335                  * out the sdcard_rw GID only to trusted apps, we're okay relaxing
 336                  * the user boundary enforcement for the default view. The UIDs
 337                  * assigned to app directories are still multiuser aware. */
 338                 return AID_SDCARD_RW;
 339         } else {
 340                 return multiuser_get_uid(info->userid, sb_info->options.gid);
 341         }
 342 }
 343 static inline int get_mode(struct sdcardfs_inode_info *info) {
 344         int owner_mode;
 345         int filtered_mode;
 346         struct sdcardfs_sb_info *sb_info = SDCARDFS_SB(info->vfs_inode.i_sb);
 347         int visible_mode = 0775 & ~sb_info->options.mask;
 348
 349         if (info->perm == PERM_PRE_ROOT) {
 350                 /* Top of multi-user view should always be visible to ensure
 351                 * secondary users can traverse inside. */
 352                 visible_mode = 0711;
 353         } else if (info->under_android) {
 354                 /* Block "other" access to Android directories, since only apps
 355                 * belonging to a specific user should be in there; we still
 356                 * leave +x open for the default view. */
 357                 if (sb_info->options.gid == AID_SDCARD_RW) {
 358                         visible_mode = visible_mode & ~0006;
 359                 } else {
 360                         visible_mode = visible_mode & ~0007;
 361                 }
 362         }
 363         owner_mode = info->lower_inode->i_mode & 0700;
 364         filtered_mode = visible_mode & (owner_mode | (owner_mode >> 3) | (owner_mode >> 6));
 365         return filtered_mode;
 366 }
 367
 368 static inline int has_graft_path(const struct dentry *dent)
 369 {
 370         int ret = 0;
 371
 372         spin_lock(&SDCARDFS_D(dent)->lock);
 373         if (SDCARDFS_D(dent)->orig_path.dentry != NULL)
 374                 ret = 1;
 375         spin_unlock(&SDCARDFS_D(dent)->lock);
 376
 377         return ret;
 378 }
 379
 380 static inline void sdcardfs_get_real_lower(const struct dentry *dent,
 381                                                 struct path *real_lower)
 382 {
 383         /* in case of a local obb dentry
 384          * the orig_path should be returned
 385          */
 386         if(has_graft_path(dent))
 387                 sdcardfs_get_orig_path(dent, real_lower);
 388         else
 389                 sdcardfs_get_lower_path(dent, real_lower);
 390 }
 391
 392 static inline void sdcardfs_put_real_lower(const struct dentry *dent,
 393                                                 struct path *real_lower)
 394 {
 395         if(has_graft_path(dent))
 396                 sdcardfs_put_orig_path(dent, real_lower);
 397         else
 398                 sdcardfs_put_lower_path(dent, real_lower);
 399 }
 400
 401 extern struct mutex sdcardfs_super_list_lock;
 402 extern struct list_head sdcardfs_super_list;
 403
 404 /* for packagelist.c */
 405 extern appid_t get_appid(void *pkgl_id, const char *app_name);
 406 extern int check_caller_access_to_name(struct inode *parent_node, const char* name);
 407 extern int open_flags_to_access_mode(int open_flags);
 408 extern int packagelist_init(void);
 409 extern void packagelist_exit(void);
 410
 411 /* for derived_perm.c */
 412 extern void setup_derived_state(struct inode *inode, perm_t perm,
 413                         userid_t userid, uid_t uid, bool under_android);
 414 extern void get_derived_permission(struct dentry *parent, struct dentry *dentry);
 415 extern void get_derived_permission_new(struct dentry *parent, struct dentry *dentry, struct dentry *newdentry);
 416 extern void get_derive_permissions_recursive(struct dentry *parent);
 417
 418 extern void update_derived_permission_lock(struct dentry *dentry);
 419 extern int need_graft_path(struct dentry *dentry);
 420 extern int is_base_obbpath(struct dentry *dentry);
 421 extern int is_obbpath_invalid(struct dentry *dentry);
 422 extern int setup_obb_dentry(struct dentry *dentry, struct path *lower_path);
 423
 424 /* locking helpers */
 425 static inline struct dentry *lock_parent(struct dentry *dentry)
 426 {
 427         struct dentry *dir = dget_parent(dentry);
 428         mutex_lock_nested(&d_inode(dir)->i_mutex, I_MUTEX_PARENT);
 429         return dir;
 430 }
 431
 432 static inline void unlock_dir(struct dentry *dir)
 433 {
 434         mutex_unlock(&d_inode(dir)->i_mutex);
 435         dput(dir);
 436 }
 437
 438 static inline int prepare_dir(const char *path_s, uid_t uid, gid_t gid, mode_t mode)
 439 {
 440         int err;
 441         struct dentry *dent;
 442         struct iattr attrs;
 443         struct path parent;
 444
 445         dent = kern_path_locked(path_s, &parent);
 446         if (IS_ERR(dent)) {
 447                 err = PTR_ERR(dent);
 448                 if (err == -EEXIST)
 449                         err = 0;
 450                 goto out_unlock;
 451         }
 452
 453         err = vfs_mkdir(d_inode(parent.dentry), dent, mode);
 454         if (err) {
 455                 if (err == -EEXIST)
 456                         err = 0;
 457                 goto out_dput;
 458         }
 459
 460         attrs.ia_uid = make_kuid(&init_user_ns, uid);
 461         attrs.ia_gid = make_kgid(&init_user_ns, gid);
 462         attrs.ia_valid = ATTR_UID | ATTR_GID;
 463         mutex_lock(&d_inode(dent)->i_mutex);
 464         notify_change(dent, &attrs, NULL);
 465         mutex_unlock(&d_inode(dent)->i_mutex);
 466
 467 out_dput:
 468         dput(dent);
 469
 470 out_unlock:
 471         /* parent dentry locked by lookup_create */
 472         mutex_unlock(&d_inode(parent.dentry)->i_mutex);
 473         path_put(&parent);
 474         return err;
 475 }
 476
 477 /*
 478  * Return 1, if a disk has enough free space, otherwise 0.
 479  * We assume that any files can not be overwritten.
 480  */
 481 static inline int check_min_free_space(struct dentry *dentry, size_t size, int dir)
 482 {
 483         int err;
 484         struct path lower_path;
 485         struct kstatfs statfs;
 486         u64 avail;
 487         struct sdcardfs_sb_info *sbi = SDCARDFS_SB(dentry->d_sb);
 488
 489         if (sbi->options.reserved_mb) {
 490                 /* Get fs stat of lower filesystem. */
 491                 sdcardfs_get_lower_path(dentry, &lower_path);
 492                 err = vfs_statfs(&lower_path, &statfs);
 493                 sdcardfs_put_lower_path(dentry, &lower_path);
 494
 495                 if (unlikely(err))
 496                         return 0;
 497
 498                 /* Invalid statfs informations. */
 499                 if (unlikely(statfs.f_bsize == 0))
 500                         return 0;
 501
 502                 /* if you are checking directory, set size to f_bsize. */
 503                 if (unlikely(dir))
 504                         size = statfs.f_bsize;
 505
 506                 /* available size */
 507                 avail = statfs.f_bavail * statfs.f_bsize;
 508
 509                 /* not enough space */
 510                 if ((u64)size > avail)
 511                         return 0;
 512
 513                 /* enough space */
 514                 if ((avail - size) > (sbi->options.reserved_mb * 1024 * 1024))
 515                         return 1;
 516
 517                 return 0;
 518         } else
 519                 return 1;
 520 }
 521
 522 /* Copies attrs and maintains sdcardfs managed attrs */
 523 static inline void sdcardfs_copy_and_fix_attrs(struct inode *dest, const struct inode *src)
 524 {
 525         dest->i_mode = (src->i_mode  & S_IFMT) | get_mode(SDCARDFS_I(dest));
 526         dest->i_uid = make_kuid(&init_user_ns, SDCARDFS_I(dest)->d_uid);
 527         dest->i_gid = make_kgid(&init_user_ns, get_gid(SDCARDFS_I(dest)));
 528         dest->i_rdev = src->i_rdev;
 529         dest->i_atime = src->i_atime;
 530         dest->i_mtime = src->i_mtime;
 531         dest->i_ctime = src->i_ctime;
 532         dest->i_blkbits = src->i_blkbits;
 533         dest->i_flags = src->i_flags;
 534         set_nlink(dest, src->i_nlink);
 535 }
 536 #endif  /* not _SDCARDFS_H_ */