/* SPDX-License-Identifier: GPL-2.0-or-later */

  /*

   * ntfs.h - Defines for NTFS Linux kernel driver.

   *

   * Copyright (c) 2001-2014 Anton Altaparmakov and Tuxera Inc.

   * Copyright (C) 2002 Richard Russon

   */
  
  #ifndef _LINUX_NTFS_H
  #define _LINUX_NTFS_H
  
  #include <linux/stddef.h>
  #include <linux/kernel.h>
  #include <linux/module.h>
  #include <linux/compiler.h>
  #include <linux/fs.h>
  #include <linux/nls.h>
  #include <linux/smp.h>

  #include <linux/pagemap.h>

  
  #include "types.h"
  #include "volume.h"
  #include "layout.h"
  
  typedef enum {
  	NTFS_BLOCK_SIZE		= 512,
  	NTFS_BLOCK_SIZE_BITS	= 9,
  	NTFS_SB_MAGIC		= 0x5346544e,	/* 'NTFS' */
  	NTFS_MAX_NAME_LEN	= 255,

  	NTFS_MAX_ATTR_NAME_LEN	= 255,

  	NTFS_MAX_CLUSTER_SIZE	= 64 * 1024,	/* 64kiB */

  	NTFS_MAX_PAGES_PER_CLUSTER = NTFS_MAX_CLUSTER_SIZE / PAGE_SIZE,

  } NTFS_CONSTANTS;
  
  /* Global variables. */
  
  /* Slab caches (from super.c). */

  extern struct kmem_cache *ntfs_name_cache;
  extern struct kmem_cache *ntfs_inode_cache;
  extern struct kmem_cache *ntfs_big_inode_cache;
  extern struct kmem_cache *ntfs_attr_ctx_cache;
  extern struct kmem_cache *ntfs_index_ctx_cache;

  
  /* The various operations structs defined throughout the driver files. */

  extern const struct address_space_operations ntfs_normal_aops;
  extern const struct address_space_operations ntfs_compressed_aops;

  extern const struct address_space_operations ntfs_mst_aops;

  extern const struct  file_operations ntfs_file_ops;

  extern const struct inode_operations ntfs_file_inode_ops;

  extern const struct  file_operations ntfs_dir_ops;

  extern const struct inode_operations ntfs_dir_inode_ops;

  extern const struct  file_operations ntfs_empty_file_ops;

  extern const struct inode_operations ntfs_empty_inode_ops;

  extern const struct export_operations ntfs_export_ops;

  /**
   * NTFS_SB - return the ntfs volume given a vfs super block
   * @sb:		VFS super block
   *
   * NTFS_SB() returns the ntfs volume associated with the VFS super block @sb.
   */
  static inline ntfs_volume *NTFS_SB(struct super_block *sb)
  {
  	return sb->s_fs_info;
  }
  
  /* Declarations of functions and global variables. */
  
  /* From fs/ntfs/compress.c */
  extern int ntfs_read_compressed_block(struct page *page);
  extern int allocate_compression_buffers(void);
  extern void free_compression_buffers(void);
  
  /* From fs/ntfs/super.c */
  #define default_upcase_len 0x10000

  extern struct mutex ntfs_lock;

  
  typedef struct {
  	int val;
  	char *str;
  } option_t;
  extern const option_t on_errors_arr[];
  
  /* From fs/ntfs/mst.c */
  extern int post_read_mst_fixup(NTFS_RECORD *b, const u32 size);
  extern int pre_write_mst_fixup(NTFS_RECORD *b, const u32 size);
  extern void post_write_mst_fixup(NTFS_RECORD *b);
  
  /* From fs/ntfs/unistr.c */

  extern bool ntfs_are_names_equal(const ntfschar *s1, size_t s1_len,

  		const ntfschar *s2, size_t s2_len,
  		const IGNORE_CASE_BOOL ic,
  		const ntfschar *upcase, const u32 upcase_size);
  extern int ntfs_collate_names(const ntfschar *name1, const u32 name1_len,
  		const ntfschar *name2, const u32 name2_len,
  		const int err_val, const IGNORE_CASE_BOOL ic,
  		const ntfschar *upcase, const u32 upcase_len);
  extern int ntfs_ucsncmp(const ntfschar *s1, const ntfschar *s2, size_t n);
  extern int ntfs_ucsncasecmp(const ntfschar *s1, const ntfschar *s2, size_t n,
  		const ntfschar *upcase, const u32 upcase_size);
  extern void ntfs_upcase_name(ntfschar *name, u32 name_len,
  		const ntfschar *upcase, const u32 upcase_len);
  extern void ntfs_file_upcase_value(FILE_NAME_ATTR *file_name_attr,
  		const ntfschar *upcase, const u32 upcase_len);
  extern int ntfs_file_compare_values(FILE_NAME_ATTR *file_name_attr1,
  		FILE_NAME_ATTR *file_name_attr2,
  		const int err_val, const IGNORE_CASE_BOOL ic,
  		const ntfschar *upcase, const u32 upcase_len);
  extern int ntfs_nlstoucs(const ntfs_volume *vol, const char *ins,
  		const int ins_len, ntfschar **outs);
  extern int ntfs_ucstonls(const ntfs_volume *vol, const ntfschar *ins,
  		const int ins_len, unsigned char **outs, int outs_len);
  
  /* From fs/ntfs/upcase.c */
  extern ntfschar *generate_default_upcase(void);

  static inline int ntfs_ffs(int x)
  {
  	int r = 1;
  
  	if (!x)
  		return 0;
  	if (!(x & 0xffff)) {
  		x >>= 16;
  		r += 16;
  	}
  	if (!(x & 0xff)) {
  		x >>= 8;
  		r += 8;
  	}
  	if (!(x & 0xf)) {
  		x >>= 4;
  		r += 4;
  	}
  	if (!(x & 3)) {
  		x >>= 2;
  		r += 2;
  	}
  	if (!(x & 1)) {
  		x >>= 1;
  		r += 1;
  	}
  	return r;
  }

  #endif /* _LINUX_NTFS_H */