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