Error message improvements.

* Add C file/line to THError and THArgCheck. Add tensor sizeStr() method. * Add THAssert THAssertMsg functions. * Add sizeDesc() and desc() functions, which return tensor descriptor strings for use in error messages. To avoid memory leaks, we have to pass these strings on the stack within structs, so it's a bit unwieldly. * Improved a bunch of error messages. e.g. ``` th> torch.mm(torch.Tensor(4,4), torch.Tensor(5,5)) size mismatch, m1: [4 x 4], m2: [5 x 5] at /home/alerer/git/torch7-2/lib/TH/generic/THTensorMath.c:511 stack traceback: ... th> torch.Tensor(1):size(4) [...]:1: bad argument pytorch#1 to 'size' (dimension 4 out of range of 1D tensor at /home/alerer/git/torch7-2/generic/Tensor.c:16) stack traceback: ... ```

Author: adamlerer

THGeneral.c

@@ -13,20 +13,33 @@ static void defaultTorchErrorHandlerFunction(const char *msg, void *data)
 static __thread void (*torchErrorHandlerFunction)(const char *msg, void *data) = defaultTorchErrorHandlerFunction;
 static __thread void *torchErrorHandlerData;
 
-void THError(const char *fmt, ...)
+void _THError(const char *file, const int line, const char *fmt, ...)
 {
- char msg[1024];
+ char msg[2048];
  va_list args;
 
  /* vasprintf not standard */
  /* vsnprintf: how to handle if does not exists? */
  va_start(args, fmt);
- vsnprintf(msg, 1024, fmt, args);
+ int n = vsnprintf(msg, 2048, fmt, args);
  va_end(args);
 
+ if(n < 2048) {
+ snprintf(msg + n, 2048 - n, " at %s:%d", file, line);
+ }
+
  (*torchErrorHandlerFunction)(msg, torchErrorHandlerData);
 }
 
+void _THAssertionFailed(const char *file, const int line, const char *exp, const char *fmt, ...) {
+ char msg[1024];
+ va_list args;
+ va_start(args, fmt);
+ vsnprintf(msg, 1024, fmt, args);
+ va_end(args);
+ _THError(file, line, "Assertion `%s' failed. %s", exp, msg);
+}
+
 void THSetErrorHandler( void (*torchErrorHandlerFunction_)(const char *msg, void *data), void *data )
 {
  if(torchErrorHandlerFunction_)
@@ -49,10 +62,24 @@ static void defaultTorchArgErrorHandlerFunction(int argNumber, const char *msg,
 static __thread void (*torchArgErrorHandlerFunction)(int argNumber, const char *msg, void *data) = defaultTorchArgErrorHandlerFunction;
 static __thread void *torchArgErrorHandlerData;
 
-void THArgCheck(int condition, int argNumber, const char *msg)
+void _THArgCheck(const char *file, int line, int condition, int argNumber, const char *fmt, ...)
 {
- if(!condition)
+ if(!condition) {
+ char msg[2048];
+ va_list args;
+
+ /* vasprintf not standard */
+ /* vsnprintf: how to handle if does not exists? */
+ va_start(args, fmt);
+ int n = vsnprintf(msg, 2048, fmt, args);
+ va_end(args);
+
+ if(n < 2048) {
+ snprintf(msg + n, 2048 - n, " at %s:%d", file, line);
+ }
+
  (*torchArgErrorHandlerFunction)(argNumber, msg, torchArgErrorHandlerData);
+ }
 }
 
 void THSetArgErrorHandler( void (*torchArgErrorHandlerFunction_)(int argNumber, const char *msg, void *data), void *data )

THGeneral.h.in

@@ -44,14 +44,30 @@
 #endif
 
 TH_API double THLog1p(const double x);
-TH_API void THError(const char *fmt, ...);
+TH_API void _THError(const char *file, const int line, const char *fmt, ...);
+TH_API void _THAssertionFailed(const char *file, const int line, const char *exp, const char *fmt, ...);
 TH_API void THSetErrorHandler( void (*torchErrorHandlerFunction)(const char *msg, void *data), void *data );
-TH_API void THArgCheck(int condition, int argNumber, const char *msg);
+TH_API void _THArgCheck(const char *file, int line, int condition, int argNumber, const char *fmt, ...);
 TH_API void THSetArgErrorHandler( void (*torchArgErrorHandlerFunction)(int argNumber, const char *msg, void *data), void *data );
 TH_API void* THAlloc(long size);
 TH_API void* THRealloc(void *ptr, long size);
 TH_API void THFree(void *ptr);
 
+#define THError(...) _THError(__FILE__, __LINE__, __VA_ARGS__)
+#define THArgCheck(...) _THArgCheck(__FILE__, __LINE__, __VA_ARGS__)
+#define THAssert(exp) \
+do { \
+ if (!(exp)) { \
+ _THAssertionFailed(__FILE__, __LINE__, #exp, ""); \
+ } \
+} while(0)
+#define THAssertMsg(exp, ...) \
+do { \
+ if (!(exp)) { \
+ _THAssertionFailed(__FILE__, __LINE__, #exp, __VA_ARGS__); \
+ } \
+} while(0)
+
 #define TH_CONCAT_STRING_2(x,y) TH_CONCAT_STRING_2_EXPAND(x,y)
 #define TH_CONCAT_STRING_2_EXPAND(x,y) #x #y
 

THTensor.h

@@ -7,6 +7,11 @@
 #define THTensor TH_CONCAT_3(TH,Real,Tensor)
 #define THTensor_(NAME) TH_CONCAT_4(TH,Real,Tensor_,NAME)
 
+#define TH_DESC_BUFF_LEN 64
+typedef struct {
+ char str[TH_DESC_BUFF_LEN];
+} THDescBuff;
+
 /* basics */
 #include "generic/THTensor.h"
 #include "THGenerateAllTypes.h"

generic/THTensor.c

@@ -20,13 +20,15 @@ int THTensor_(nDimension)(const THTensor *self)
 
 long THTensor_(size)(const THTensor *self, int dim)
 {
- THArgCheck((dim >= 0) && (dim < self->nDimension), 2, "out of range");
+ THArgCheck((dim >= 0) && (dim < self->nDimension), 2, "dimension %d out of range of %dD tensor",
+ dim+1, THTensor_(nDimension)(self));
  return self->size[dim];
 }
 
 long THTensor_(stride)(const THTensor *self, int dim)
 {
- THArgCheck((dim >= 0) && (dim < self->nDimension), 2, "out of range");
+ THArgCheck((dim >= 0) && (dim < self->nDimension), 2, "dimension %d out of range of %dD tensor", dim+1,
+ THTensor_(nDimension)(self));
  return self->stride[dim];
 }
 
@@ -751,4 +753,48 @@ real THTensor_(get4d)(const THTensor *tensor, long x0, long x1, long x2, long x3
  return THStorage_(get)(tensor->storage, tensor->storageOffset+x0*tensor->stride[0]+x1*tensor->stride[1]+x2*tensor->stride[2]+x3*tensor->stride[3]);
 }
 
+THDescBuff THTensor_(desc)(const THTensor *tensor) {
+ const int L = TH_DESC_BUFF_LEN;
+ THDescBuff buf;
+ char *str = buf.str;
+ int n = 0;
+#define _stringify(x) #x
+ n += snprintf(str, L-n, "torch." _stringify(x) "Tensor of size ");
+#undef _stringify
+ int i;
+ for(i = 0; i < tensor->nDimension; i++) {
+ if(n >= L) break;
+ n += snprintf(str+n, L-n, "%ld", tensor->size[i]);
+ if(i < tensor->nDimension-1) {
+ n += snprintf(str+n, L-n, "x");
+ }
+ }
+ if(n >= L) {
+ snprintf(str+L-4+n, 4, "...");
+ }
+ return buf;
+}
+
+THDescBuff THTensor_(sizeDesc)(const THTensor *tensor) {
+ const int L = TH_DESC_BUFF_LEN;
+ THDescBuff buf;
+ char *str = buf.str;
+ int n = 0;
+ n += snprintf(str, L-n, "[");
+ int i;
+ for(i = 0; i < tensor->nDimension; i++) {
+ if(n >= L) break;
+ n += snprintf(str+n, L-n, "%ld", tensor->size[i]);
+ if(i < tensor->nDimension-1) {
+ n += snprintf(str+n, L-n, " x ");
+ }
+ }
+ if(n < L - 2) {
+ snprintf(str+n, L-n, "]");
+ } else {
+ snprintf(str+L-5, 5, "...]");
+ }
+ return buf;
+}
+
 #endif

generic/THTensor.h

@@ -122,4 +122,8 @@ TH_API real THTensor_(get2d)(const THTensor *tensor, long x0, long x1);
 TH_API real THTensor_(get3d)(const THTensor *tensor, long x0, long x1, long x2);
 TH_API real THTensor_(get4d)(const THTensor *tensor, long x0, long x1, long x2, long x3);
 
+/* Debug methods */
+TH_API THDescBuff THTensor_(desc)(const THTensor *tensor);
+TH_API THDescBuff THTensor_(sizeDesc)(const THTensor *tensor);
+
 #endif