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 /* The magic number for our file system */
  36 enum {
  37         SPUFS_MAGIC = 0x23c9b64e,
  38 };
  39
  40 struct spu_context_ops;
  41 struct spu_gang;
  42
  43 enum {
  44         SPU_SCHED_WAS_ACTIVE,   /* was active upon spu_acquire_saved()  */
  45 };
  46
  47 /* ctx->sched_flags */
  48 enum {
  49         SPU_SCHED_NOTIFY_ACTIVE,
  50 };
  51
  52 struct spu_context {
  53         struct spu *spu;                  /* pointer to a physical SPU */
  54         struct spu_state csa;             /* SPU context save area. */
  55         spinlock_t mmio_lock;             /* protects mmio access */
  56         struct address_space *local_store; /* local store mapping.  */
  57         struct address_space *mfc;         /* 'mfc' area mappings. */
  58         struct address_space *cntl;        /* 'control' area mappings. */
  59         struct address_space *signal1;     /* 'signal1' area mappings. */
  60         struct address_space *signal2;     /* 'signal2' area mappings. */
  61         struct address_space *mss;         /* 'mss' area mappings. */
  62         struct address_space *psmap;       /* 'psmap' area mappings. */
  63         struct mutex mapping_lock;
  64         u64 object_id;             /* user space pointer for oprofile */
  65
  66         enum { SPU_STATE_RUNNABLE, SPU_STATE_SAVED } state;
  67         struct mutex state_mutex;
  68         struct mutex run_mutex;
  69
  70         struct mm_struct *owner;
  71
  72         struct kref kref;
  73         wait_queue_head_t ibox_wq;
  74         wait_queue_head_t wbox_wq;
  75         wait_queue_head_t stop_wq;
  76         wait_queue_head_t mfc_wq;
  77         struct fasync_struct *ibox_fasync;
  78         struct fasync_struct *wbox_fasync;
  79         struct fasync_struct *mfc_fasync;
  80         u32 tagwait;
  81         struct spu_context_ops *ops;
  82         struct work_struct reap_work;
  83         unsigned long flags;
  84         unsigned long event_return;
  85
  86         struct list_head gang_list;
  87         struct spu_gang *gang;
  88         struct kref *prof_priv_kref;
  89         void ( * prof_priv_release) (struct kref *kref);
  90
  91         /* owner thread */
  92         pid_t tid;
  93
  94         /* scheduler fields */
  95         struct list_head rq;
  96         unsigned int time_slice;
  97         unsigned long sched_flags;
  98         cpumask_t cpus_allowed;
  99         int policy;
 100         int prio;
 101
 102         /* statistics */
 103         struct {
 104                 /* updates protected by ctx->state_mutex */
 105                 enum spu_utilization_state util_state;
 106                 unsigned long long tstamp;      /* time of last state switch */
 107                 unsigned long long times[SPU_UTIL_MAX];
 108                 unsigned long long vol_ctx_switch;
 109                 unsigned long long invol_ctx_switch;
 110                 unsigned long long min_flt;
 111                 unsigned long long maj_flt;
 112                 unsigned long long hash_flt;
 113                 unsigned long long slb_flt;
 114                 unsigned long long slb_flt_base; /* # at last ctx switch */
 115                 unsigned long long class2_intr;
 116                 unsigned long long class2_intr_base; /* # at last ctx switch */
 117                 unsigned long long libassist;
 118         } stats;
 119
 120         struct list_head aff_list;
 121         int aff_head;
 122         int aff_offset;
 123 };
 124
 125 struct spu_gang {
 126         struct list_head list;
 127         struct mutex mutex;
 128         struct kref kref;
 129         int contexts;
 130
 131         struct spu_context *aff_ref_ctx;
 132         struct list_head aff_list_head;
 133         struct mutex aff_mutex;
 134         int aff_flags;
 135         struct spu *aff_ref_spu;
 136         atomic_t aff_sched_count;
 137 };
 138
 139 /* Flag bits for spu_gang aff_flags */
 140 #define AFF_OFFSETS_SET         1
 141 #define AFF_MERGED              2
 142
 143 struct mfc_dma_command {
 144         int32_t pad;    /* reserved */
 145         uint32_t lsa;   /* local storage address */
 146         uint64_t ea;    /* effective address */
 147         uint16_t size;  /* transfer size */
 148         uint16_t tag;   /* command tag */
 149         uint16_t class; /* class ID */
 150         uint16_t cmd;   /* command opcode */
 151 };
 152
 153
 154 /* SPU context query/set operations. */
 155 struct spu_context_ops {
 156         int (*mbox_read) (struct spu_context * ctx, u32 * data);
 157          u32(*mbox_stat_read) (struct spu_context * ctx);
 158         unsigned int (*mbox_stat_poll)(struct spu_context *ctx,
 159                                         unsigned int events);
 160         int (*ibox_read) (struct spu_context * ctx, u32 * data);
 161         int (*wbox_write) (struct spu_context * ctx, u32 data);
 162          u32(*signal1_read) (struct spu_context * ctx);
 163         void (*signal1_write) (struct spu_context * ctx, u32 data);
 164          u32(*signal2_read) (struct spu_context * ctx);
 165         void (*signal2_write) (struct spu_context * ctx, u32 data);
 166         void (*signal1_type_set) (struct spu_context * ctx, u64 val);
 167          u64(*signal1_type_get) (struct spu_context * ctx);
 168         void (*signal2_type_set) (struct spu_context * ctx, u64 val);
 169          u64(*signal2_type_get) (struct spu_context * ctx);
 170          u32(*npc_read) (struct spu_context * ctx);
 171         void (*npc_write) (struct spu_context * ctx, u32 data);
 172          u32(*status_read) (struct spu_context * ctx);
 173         char*(*get_ls) (struct spu_context * ctx);
 174          u32 (*runcntl_read) (struct spu_context * ctx);
 175         void (*runcntl_write) (struct spu_context * ctx, u32 data);
 176         void (*master_start) (struct spu_context * ctx);
 177         void (*master_stop) (struct spu_context * ctx);
 178         int (*set_mfc_query)(struct spu_context * ctx, u32 mask, u32 mode);
 179         u32 (*read_mfc_tagstatus)(struct spu_context * ctx);
 180         u32 (*get_mfc_free_elements)(struct spu_context *ctx);
 181         int (*send_mfc_command)(struct spu_context * ctx,
 182                                 struct mfc_dma_command * cmd);
 183         void (*dma_info_read) (struct spu_context * ctx,
 184                                struct spu_dma_info * info);
 185         void (*proxydma_info_read) (struct spu_context * ctx,
 186                                     struct spu_proxydma_info * info);
 187         void (*restart_dma)(struct spu_context *ctx);
 188 };
 189
 190 extern struct spu_context_ops spu_hw_ops;
 191 extern struct spu_context_ops spu_backing_ops;
 192
 193 struct spufs_inode_info {
 194         struct spu_context *i_ctx;
 195         struct spu_gang *i_gang;
 196         struct inode vfs_inode;
 197         int i_openers;
 198 };
 199 #define SPUFS_I(inode) \
 200         container_of(inode, struct spufs_inode_info, vfs_inode)
 201
 202 extern struct tree_descr spufs_dir_contents[];
 203 extern struct tree_descr spufs_dir_nosched_contents[];
 204
 205 /* system call implementation */
 206 long spufs_run_spu(struct spu_context *ctx, u32 *npc, u32 *status);
 207 long spufs_create(struct nameidata *nd, unsigned int flags,
 208                         mode_t mode, struct file *filp);
 209 extern const struct file_operations spufs_context_fops;
 210
 211 /* gang management */
 212 struct spu_gang *alloc_spu_gang(void);
 213 struct spu_gang *get_spu_gang(struct spu_gang *gang);
 214 int put_spu_gang(struct spu_gang *gang);
 215 void spu_gang_remove_ctx(struct spu_gang *gang, struct spu_context *ctx);
 216 void spu_gang_add_ctx(struct spu_gang *gang, struct spu_context *ctx);
 217
 218 /* fault handling */
 219 int spufs_handle_class1(struct spu_context *ctx);
 220
 221 /* affinity */
 222 struct spu *affinity_check(struct spu_context *ctx);
 223
 224 /* context management */
 225 extern atomic_t nr_spu_contexts;
 226 static inline void spu_acquire(struct spu_context *ctx)
 227 {
 228         mutex_lock(&ctx->state_mutex);
 229 }
 230
 231 static inline void spu_release(struct spu_context *ctx)
 232 {
 233         mutex_unlock(&ctx->state_mutex);
 234 }
 235
 236 struct spu_context * alloc_spu_context(struct spu_gang *gang);
 237 void destroy_spu_context(struct kref *kref);
 238 struct spu_context * get_spu_context(struct spu_context *ctx);
 239 int put_spu_context(struct spu_context *ctx);
 240 void spu_unmap_mappings(struct spu_context *ctx);
 241
 242 void spu_forget(struct spu_context *ctx);
 243 int spu_acquire_runnable(struct spu_context *ctx, unsigned long flags);
 244 void spu_acquire_saved(struct spu_context *ctx);
 245 void spu_release_saved(struct spu_context *ctx);
 246
 247 int spu_activate(struct spu_context *ctx, unsigned long flags);
 248 void spu_deactivate(struct spu_context *ctx);
 249 void spu_yield(struct spu_context *ctx);
 250 void spu_switch_notify(struct spu *spu, struct spu_context *ctx);
 251 void spu_set_timeslice(struct spu_context *ctx);
 252 void spu_update_sched_info(struct spu_context *ctx);
 253 void __spu_update_sched_info(struct spu_context *ctx);
 254 int __init spu_sched_init(void);
 255 void spu_sched_exit(void);
 256
 257 extern char *isolated_loader;
 258
 259 /*
 260  * spufs_wait
 261  *      Same as wait_event_interruptible(), except that here
 262  *      we need to call spu_release(ctx) before sleeping, and
 263  *      then spu_acquire(ctx) when awoken.
 264  */
 265
 266 #define spufs_wait(wq, condition)                                       \
 267 ({                                                                      \
 268         int __ret = 0;                                                  \
 269         DEFINE_WAIT(__wait);                                            \
 270         for (;;) {                                                      \
 271                 prepare_to_wait(&(wq), &__wait, TASK_INTERRUPTIBLE);    \
 272                 if (condition)                                          \
 273                         break;                                          \
 274                 if (signal_pending(current)) {                          \
 275                         __ret = -ERESTARTSYS;                           \
 276                         break;                                          \
 277                 }                                                       \
 278                 spu_release(ctx);                                       \
 279                 schedule();                                             \
 280                 spu_acquire(ctx);                                       \
 281         }                                                               \
 282         finish_wait(&(wq), &__wait);                                    \
 283         __ret;                                                          \
 284 })
 285
 286 size_t spu_wbox_write(struct spu_context *ctx, u32 data);
 287 size_t spu_ibox_read(struct spu_context *ctx, u32 *data);
 288
 289 /* irq callback funcs. */
 290 void spufs_ibox_callback(struct spu *spu);
 291 void spufs_wbox_callback(struct spu *spu);
 292 void spufs_stop_callback(struct spu *spu);
 293 void spufs_mfc_callback(struct spu *spu);
 294 void spufs_dma_callback(struct spu *spu, int type);
 295
 296 extern struct spu_coredump_calls spufs_coredump_calls;
 297 struct spufs_coredump_reader {
 298         char *name;
 299         ssize_t (*read)(struct spu_context *ctx,
 300                         char __user *buffer, size_t size, loff_t *pos);
 301         u64 (*get)(void *data);
 302         size_t size;
 303 };
 304 extern struct spufs_coredump_reader spufs_coredump_read[];
 305 extern int spufs_coredump_num_notes;
 306
 307 /*
 308  * This function is a little bit too large for an inline, but
 309  * as fault.c is built into the kernel we can't move it out of
 310  * line.
 311  */
 312 static inline void spuctx_switch_state(struct spu_context *ctx,
 313                 enum spu_utilization_state new_state)
 314 {
 315         unsigned long long curtime;
 316         signed long long delta;
 317         struct timespec ts;
 318         struct spu *spu;
 319         enum spu_utilization_state old_state;
 320
 321         ktime_get_ts(&ts);
 322         curtime = timespec_to_ns(&ts);
 323         delta = curtime - ctx->stats.tstamp;
 324
 325         WARN_ON(!mutex_is_locked(&ctx->state_mutex));
 326         WARN_ON(delta < 0);
 327
 328         spu = ctx->spu;
 329         old_state = ctx->stats.util_state;
 330         ctx->stats.util_state = new_state;
 331         ctx->stats.tstamp = curtime;
 332
 333         /*
 334          * Update the physical SPU utilization statistics.
 335          */
 336         if (spu) {
 337                 ctx->stats.times[old_state] += delta;
 338                 spu->stats.times[old_state] += delta;
 339                 spu->stats.util_state = new_state;
 340                 spu->stats.tstamp = curtime;
 341         }
 342 }
 343
 344 #endif