LXR linux/arch/powerpc/platforms/cell/spufs/spufs.h

   1/*
   2 * SPU file system
   3 *
   4 * (C) Copyright IBM Deutschland Entwicklung GmbH 2005
   5 *
   6 * Author: Arnd Bergmann <arndb@de.ibm.com>
   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 as published by
  10 * the Free Software Foundation; either version 2, or (at your option)
  11 * any later version.
  12 *
  13 * This program is distributed in the hope that it will be useful,
  14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 * GNU General Public License for more details.
  17 *
  18 * You should have received a copy of the GNU General Public License
  19 * along with this program; if not, write to the Free Software
  20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 */
  22#ifndef SPUFS_H
  23#define SPUFS_H
  24
  25#include <linux/kref.h>
  26#include <linux/mutex.h>
  27#include <linux/spinlock.h>
  28#include <linux/fs.h>
  29#include <linux/cpumask.h>
  30
  31#include <asm/spu.h>
  32#include <asm/spu_csa.h>
  33#include <asm/spu_info.h>
  34
  35#define SPUFS_PS_MAP_SIZE       0x20000
  36#define SPUFS_MFC_MAP_SIZE      0x1000
  37#define SPUFS_CNTL_MAP_SIZE     0x1000
  38#define SPUFS_SIGNAL_MAP_SIZE   PAGE_SIZE
  39#define SPUFS_MSS_MAP_SIZE      0x1000
  40
  41/* The magic number for our file system */
  42enum {
  43        SPUFS_MAGIC = 0x23c9b64e,
  44};
  45
  46struct spu_context_ops;
  47struct spu_gang;
  48
  49/* ctx->sched_flags */
  50enum {
  51        SPU_SCHED_NOTIFY_ACTIVE,
  52        SPU_SCHED_WAS_ACTIVE,   /* was active upon spu_acquire_saved()  */
  53        SPU_SCHED_SPU_RUN,      /* context is within spu_run */
  54};
  55
  56enum {
  57        SWITCH_LOG_BUFSIZE = 4096,
  58};
  59
  60enum {
  61        SWITCH_LOG_START,
  62        SWITCH_LOG_STOP,
  63        SWITCH_LOG_EXIT,
  64};
  65
  66struct switch_log {
  67        wait_queue_head_t       wait;
  68        unsigned long           head;
  69        unsigned long           tail;
  70        struct switch_log_entry {
  71                struct timespec tstamp;
  72                s32             spu_id;
  73                u32             type;
  74                u32             val;
  75                u64             timebase;
  76        } log[];
  77};
  78
  79struct spu_context {
  80        struct spu *spu;                  /* pointer to a physical SPU */
  81        struct spu_state csa;             /* SPU context save area. */
  82        spinlock_t mmio_lock;             /* protects mmio access */
  83        struct address_space *local_store; /* local store mapping.  */
  84        struct address_space *mfc;         /* 'mfc' area mappings. */
  85        struct address_space *cntl;        /* 'control' area mappings. */
  86        struct address_space *signal1;     /* 'signal1' area mappings. */
  87        struct address_space *signal2;     /* 'signal2' area mappings. */
  88        struct address_space *mss;         /* 'mss' area mappings. */
  89        struct address_space *psmap;       /* 'psmap' area mappings. */
  90        struct mutex mapping_lock;
  91        u64 object_id;             /* user space pointer for oprofile */
  92
  93        enum { SPU_STATE_RUNNABLE, SPU_STATE_SAVED } state;
  94        struct mutex state_mutex;
  95        struct mutex run_mutex;
  96
  97        struct mm_struct *owner;
  98
  99        struct kref kref;
 100        wait_queue_head_t ibox_wq;
 101        wait_queue_head_t wbox_wq;
 102        wait_queue_head_t stop_wq;
 103        wait_queue_head_t mfc_wq;
 104        wait_queue_head_t run_wq;
 105        struct fasync_struct *ibox_fasync;
 106        struct fasync_struct *wbox_fasync;
 107        struct fasync_struct *mfc_fasync;
 108        u32 tagwait;
 109        struct spu_context_ops *ops;
 110        struct work_struct reap_work;
 111        unsigned long flags;
 112        unsigned long event_return;
 113
 114        struct list_head gang_list;
 115        struct spu_gang *gang;
 116        struct kref *prof_priv_kref;
 117        void ( * prof_priv_release) (struct kref *kref);
 118
 119        /* owner thread */
 120        pid_t tid;
 121
 122        /* scheduler fields */
 123        struct list_head rq;
 124        unsigned int time_slice;
 125        unsigned long sched_flags;
 126        cpumask_t cpus_allowed;
 127        int policy;
 128        int prio;
 129        int last_ran;
 130
 131        /* statistics */
 132        struct {
 133                /* updates protected by ctx->state_mutex */
 134                enum spu_utilization_state util_state;
 135                unsigned long long tstamp;      /* time of last state switch */
 136                unsigned long long times[SPU_UTIL_MAX];
 137                unsigned long long vol_ctx_switch;
 138                unsigned long long invol_ctx_switch;
 139                unsigned long long min_flt;
 140                unsigned long long maj_flt;
 141                unsigned long long hash_flt;
 142                unsigned long long slb_flt;
 143                unsigned long long slb_flt_base; /* # at last ctx switch */
 144                unsigned long long class2_intr;
 145                unsigned long long class2_intr_base; /* # at last ctx switch */
 146                unsigned long long libassist;
 147        } stats;
 148
 149        /* context switch log */
 150        struct switch_log *switch_log;
 151
 152        struct list_head aff_list;
 153        int aff_head;
 154        int aff_offset;
 155};
 156
 157struct spu_gang {
 158        struct list_head list;
 159        struct mutex mutex;
 160        struct kref kref;
 161        int contexts;
 162
 163        struct spu_context *aff_ref_ctx;
 164        struct list_head aff_list_head;
 165        struct mutex aff_mutex;
 166        int aff_flags;
 167        struct spu *aff_ref_spu;
 168        atomic_t aff_sched_count;
 169};
 170
 171/* Flag bits for spu_gang aff_flags */
 172#define AFF_OFFSETS_SET         1
 173#define AFF_MERGED              2
 174
 175struct mfc_dma_command {
 176        int32_t pad;    /* reserved */
 177        uint32_t lsa;   /* local storage address */
 178        uint64_t ea;    /* effective address */
 179        uint16_t size;  /* transfer size */
 180        uint16_t tag;   /* command tag */
 181        uint16_t class; /* class ID */
 182        uint16_t cmd;   /* command opcode */
 183};
 184
 185
 186/* SPU context query/set operations. */
 187struct spu_context_ops {
 188        int (*mbox_read) (struct spu_context * ctx, u32 * data);
 189         u32(*mbox_stat_read) (struct spu_context * ctx);
 190        unsigned int (*mbox_stat_poll)(struct spu_context *ctx,
 191                                        unsigned int events);
 192        int (*ibox_read) (struct spu_context * ctx, u32 * data);
 193        int (*wbox_write) (struct spu_context * ctx, u32 data);
 194         u32(*signal1_read) (struct spu_context * ctx);
 195        void (*signal1_write) (struct spu_context * ctx, u32 data);
 196         u32(*signal2_read) (struct spu_context * ctx);
 197        void (*signal2_write) (struct spu_context * ctx, u32 data);
 198        void (*signal1_type_set) (struct spu_context * ctx, u64 val);
 199         u64(*signal1_type_get) (struct spu_context * ctx);
 200        void (*signal2_type_set) (struct spu_context * ctx, u64 val);
 201         u64(*signal2_type_get) (struct spu_context * ctx);
 202         u32(*npc_read) (struct spu_context * ctx);
 203        void (*npc_write) (struct spu_context * ctx, u32 data);
 204         u32(*status_read) (struct spu_context * ctx);
 205        char*(*get_ls) (struct spu_context * ctx);
 206        void (*privcntl_write) (struct spu_context *ctx, u64 data);
 207         u32 (*runcntl_read) (struct spu_context * ctx);
 208        void (*runcntl_write) (struct spu_context * ctx, u32 data);
 209        void (*runcntl_stop) (struct spu_context * ctx);
 210        void (*master_start) (struct spu_context * ctx);
 211        void (*master_stop) (struct spu_context * ctx);
 212        int (*set_mfc_query)(struct spu_context * ctx, u32 mask, u32 mode);
 213        u32 (*read_mfc_tagstatus)(struct spu_context * ctx);
 214        u32 (*get_mfc_free_elements)(struct spu_context *ctx);
 215        int (*send_mfc_command)(struct spu_context * ctx,
 216                                struct mfc_dma_command * cmd);
 217        void (*dma_info_read) (struct spu_context * ctx,
 218                               struct spu_dma_info * info);
 219        void (*proxydma_info_read) (struct spu_context * ctx,
 220                                    struct spu_proxydma_info * info);
 221        void (*restart_dma)(struct spu_context *ctx);
 222};
 223
 224extern struct spu_context_ops spu_hw_ops;
 225extern struct spu_context_ops spu_backing_ops;
 226
 227struct spufs_inode_info {
 228        struct spu_context *i_ctx;
 229        struct spu_gang *i_gang;
 230        struct inode vfs_inode;
 231        int i_openers;
 232};
 233#define SPUFS_I(inode) \
 234        container_of(inode, struct spufs_inode_info, vfs_inode)
 235
 236struct spufs_tree_descr {
 237        const char *name;
 238        const struct file_operations *ops;
 239        umode_t mode;
 240        size_t size;
 241};
 242
 243extern const struct spufs_tree_descr spufs_dir_contents[];
 244extern const struct spufs_tree_descr spufs_dir_nosched_contents[];
 245extern const struct spufs_tree_descr spufs_dir_debug_contents[];
 246
 247/* system call implementation */
 248extern struct spufs_calls spufs_calls;
 249struct coredump_params;
 250long spufs_run_spu(struct spu_context *ctx, u32 *npc, u32 *status);
 251long spufs_create(struct path *nd, struct dentry *dentry, unsigned int flags,
 252                        umode_t mode, struct file *filp);
 253/* ELF coredump callbacks for writing SPU ELF notes */
 254extern int spufs_coredump_extra_notes_size(void);
 255extern int spufs_coredump_extra_notes_write(struct coredump_params *cprm);
 256
 257extern const struct file_operations spufs_context_fops;
 258
 259/* gang management */
 260struct spu_gang *alloc_spu_gang(void);
 261struct spu_gang *get_spu_gang(struct spu_gang *gang);
 262int put_spu_gang(struct spu_gang *gang);
 263void spu_gang_remove_ctx(struct spu_gang *gang, struct spu_context *ctx);
 264void spu_gang_add_ctx(struct spu_gang *gang, struct spu_context *ctx);
 265
 266/* fault handling */
 267int spufs_handle_class1(struct spu_context *ctx);
 268int spufs_handle_class0(struct spu_context *ctx);
 269
 270/* affinity */
 271struct spu *affinity_check(struct spu_context *ctx);
 272
 273/* context management */
 274extern atomic_t nr_spu_contexts;
 275static inline int __must_check spu_acquire(struct spu_context *ctx)
 276{
 277        return mutex_lock_interruptible(&ctx->state_mutex);
 278}
 279
 280static inline void spu_release(struct spu_context *ctx)
 281{
 282        mutex_unlock(&ctx->state_mutex);
 283}
 284
 285struct spu_context * alloc_spu_context(struct spu_gang *gang);
 286void destroy_spu_context(struct kref *kref);
 287struct spu_context * get_spu_context(struct spu_context *ctx);
 288int put_spu_context(struct spu_context *ctx);
 289void spu_unmap_mappings(struct spu_context *ctx);
 290
 291void spu_forget(struct spu_context *ctx);
 292int __must_check spu_acquire_saved(struct spu_context *ctx);
 293void spu_release_saved(struct spu_context *ctx);
 294
 295int spu_stopped(struct spu_context *ctx, u32 * stat);
 296void spu_del_from_rq(struct spu_context *ctx);
 297int spu_activate(struct spu_context *ctx, unsigned long flags);
 298void spu_deactivate(struct spu_context *ctx);
 299void spu_yield(struct spu_context *ctx);
 300void spu_switch_notify(struct spu *spu, struct spu_context *ctx);
 301void spu_switch_log_notify(struct spu *spu, struct spu_context *ctx,
 302                u32 type, u32 val);
 303void spu_set_timeslice(struct spu_context *ctx);
 304void spu_update_sched_info(struct spu_context *ctx);
 305void __spu_update_sched_info(struct spu_context *ctx);
 306int __init spu_sched_init(void);
 307void spu_sched_exit(void);
 308
 309extern char *isolated_loader;
 310
 311/*
 312 * spufs_wait
 313 *      Same as wait_event_interruptible(), except that here
 314 *      we need to call spu_release(ctx) before sleeping, and
 315 *      then spu_acquire(ctx) when awoken.
 316 *
 317 *      Returns with state_mutex re-acquired when successful or
 318 *      with -ERESTARTSYS and the state_mutex dropped when interrupted.
 319 */
 320
 321#define spufs_wait(wq, condition)                                       \
 322({                                                                      \
 323        int __ret = 0;                                                  \
 324        DEFINE_WAIT(__wait);                                            \
 325        for (;;) {                                                      \
 326                prepare_to_wait(&(wq), &__wait, TASK_INTERRUPTIBLE);    \
 327                if (condition)                                          \
 328                        break;                                          \
 329                spu_release(ctx);                                       \
 330                if (signal_pending(current)) {                          \
 331                        __ret = -ERESTARTSYS;                           \
 332                        break;                                          \
 333                }                                                       \
 334                schedule();                                             \
 335                __ret = spu_acquire(ctx);                               \
 336                if (__ret)                                              \
 337                        break;                                          \
 338        }                                                               \
 339        finish_wait(&(wq), &__wait);                                    \
 340        __ret;                                                          \
 341})
 342
 343size_t spu_wbox_write(struct spu_context *ctx, u32 data);
 344size_t spu_ibox_read(struct spu_context *ctx, u32 *data);
 345
 346/* irq callback funcs. */
 347void spufs_ibox_callback(struct spu *spu);
 348void spufs_wbox_callback(struct spu *spu);
 349void spufs_stop_callback(struct spu *spu, int irq);
 350void spufs_mfc_callback(struct spu *spu);
 351void spufs_dma_callback(struct spu *spu, int type);
 352
 353extern struct spu_coredump_calls spufs_coredump_calls;
 354struct spufs_coredump_reader {
 355        char *name;
 356        ssize_t (*read)(struct spu_context *ctx,
 357                        char __user *buffer, size_t size, loff_t *pos);
 358        u64 (*get)(struct spu_context *ctx);
 359        size_t size;
 360};
 361extern const struct spufs_coredump_reader spufs_coredump_read[];
 362extern int spufs_coredump_num_notes;
 363
 364extern int spu_init_csa(struct spu_state *csa);
 365extern void spu_fini_csa(struct spu_state *csa);
 366extern int spu_save(struct spu_state *prev, struct spu *spu);
 367extern int spu_restore(struct spu_state *new, struct spu *spu);
 368extern int spu_switch(struct spu_state *prev, struct spu_state *new,
 369                      struct spu *spu);
 370extern int spu_alloc_lscsa(struct spu_state *csa);
 371extern void spu_free_lscsa(struct spu_state *csa);
 372
 373extern void spuctx_switch_state(struct spu_context *ctx,
 374                enum spu_utilization_state new_state);
 375
 376#endif
 377